惯用语

一组随机且常用的 Kotlin 惯用语集合。如果你有喜欢的惯用语，欢迎发送 pull request 贡献。

创建 DTO (POJO/POCO)

data class Customer(val name: String, val email: String)

为 Customer 类提供以下功能：

• 所有属性的 getter 方法（对于 var 变量还会生成 setter 方法）
• equals()
• hashCode()
• toString()
• copy()
• component1()、component2() 等，用于所有属性（参见 数据类）

函数参数的默认值

fun foo(a: Int = 0, b: String = "") { ... }

过滤列表

val positives = list.filter { x -> x > 0 }

或者更简洁地：

val positives = list.filter { it > 0 }

了解 Java 和 Kotlin 过滤 的区别。

检查集合中元素的存在性

if ("[email protected]" in emailsList) { ... }

if ("[email protected]" !in emailsList) { ... }

字符串插值

println("Name $name")

了解 Java 和 Kotlin 字符串拼接 的区别。

安全地读取标准输入

// 读取一个字符串，如果输入无法转换为整数则返回 null。例如：Hi there!
val wrongInt = readln().toIntOrNull()
println(wrongInt)
// null

// 读取一个可以转换为整数的字符串并返回一个整数。例如：13
val correctInt = readln().toIntOrNull()
println(correctInt)
// 13

更多信息请参见 读取标准输入。

实例检查

when (x) {
    is Foo -> ...
    is Bar -> ...
    else   -> ...
}

只读列表

val list = listOf("a", "b", "c")

只读映射

val map = mapOf("a" to 1, "b" to 2, "c" to 3)

访问 Map 条目

println(map["key"])
map["key"] = value

遍历 Map 或对列表

for ((k, v) in map) {
    println("$k -> $v")
}

k 和 v 可以是任何方便的名称，例如 name 和 age。

遍历区间

for (i in 1..100) { ... }  // 闭区间：包含 100
for (i in 1..<100) { ... } // 开区间：不包含 100
for (x in 2..10 step 2) { ... }
for (x in 10 downTo 1) { ... }
(1..10).forEach { ... }

惰性属性

val p: String by lazy { // 该值仅在首次访问时计算
    // 计算字符串
}

扩展函数

fun String.spaceToCamelCase() { ... }

"Convert this to camelcase".spaceToCamelCase()

创建单例

object Resource {
    val name = "Name"
}

使用内联值类实现类型安全的值

@JvmInline
value class EmployeeId(private val id: String)

@JvmInline
value class CustomerId(private val id: String)

如果你不小心混淆了 EmployeeId 和 CustomerId，将会触发编译错误。

NOTE

@JvmInline 注解仅在 JVM 后端中需要。

实例化抽象类

abstract class MyAbstractClass {
    abstract fun doSomething()
    abstract fun sleep()
}

fun main() {
    val myObject = object : MyAbstractClass() {
        override fun doSomething() {
            // ...
        }

        override fun sleep() { // ...
        }
    }
    myObject.doSomething()
}

非空判断简写

val files = File("Test").listFiles()

println(files?.size) // 如果 files 不为 null，则打印 size

非空判断和默认值简写

val files = File("Test").listFiles()

// 对于简单的回退值：
println(files?.size ?: "empty") // 如果 files 为 null，则打印 "empty"

// 若要在代码块中计算更复杂的回退值，请使用 `run`
val filesSize = files?.size ?: run { 
    val someSize = getSomeSize()
    someSize * 2
}
println(filesSize)

如果为空则执行语句

val values = ...
val email = values["email"] ?: throw IllegalStateException("Email is missing!")

获取可能为空的集合的第一个元素

val emails = ... // 可能为空
val mainEmail = emails.firstOrNull() ?: ""

了解 Java 和 Kotlin 获取第一个元素 的区别。

如果非空则执行

val value = ...

value?.let {
    ... // 如果不为 null 则执行此代码块
}

如果非空则映射可空值

val value = ...

val mapped = value?.let { transformValue(it) } ?: defaultValue 
// 如果 value 或转换结果为 null，则返回 defaultValue。

when 语句的返回值

fun transform(color: String): Int {
    return when (color) {
        "Red" -> 0
        "Green" -> 1
        "Blue" -> 2
        else -> throw IllegalArgumentException("Invalid color param value")
    }
}

try-catch 表达式

fun test() {
    val result = try {
        count()
    } catch (e: ArithmeticException) {
        throw IllegalStateException(e)
    }

    // 处理 result
}

if 表达式

val y = if (x == 1) {
    "one"
} else if (x == 2) {
    "two"
} else {
    "other"
}

返回 Unit 的方法的 Builder 风格用法

fun arrayOfMinusOnes(size: Int): IntArray {
    return IntArray(size).apply { fill(-1) }
}

单表达式函数

fun theAnswer() = 42

这等价于

fun theAnswer(): Int {
    return 42
}

这可以与其他惯用语有效结合，从而使代码更简洁。例如，结合 when 表达式：

fun transform(color: String): Int = when (color) {
    "Red" -> 0
    "Green" -> 1
    "Blue" -> 2
    else -> throw IllegalArgumentException("Invalid color param value")
}

在对象实例上调用多个方法（使用 with）

class Turtle {
    fun penDown()
    fun penUp()
    fun turn(degrees: Double)
    fun forward(pixels: Double)
}

val myTurtle = Turtle()
with(myTurtle) { // 绘制一个 100 像素的正方形
    penDown()
    for (i in 1..4) {
        forward(100.0)
        turn(90.0)
    }
    penUp()
}

配置对象的属性（使用 apply）

val myRectangle = Rectangle().apply {
    length = 4
    breadth = 5
    color = 0xFAFAFA
}

这对于配置对象构造函数中不存在的属性非常有用。

Java 7 的 try-with-resources

val stream = Files.newInputStream(Paths.get("/some/file.txt"))
stream.buffered().reader().use { reader ->
    println(reader.readText())
}

需要泛型类型信息的泛型函数

//  public final class Gson {
//     ...
//     public <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {
//     ...

inline fun <reified T: Any> Gson.fromJson(json: JsonElement): T = this.fromJson(json, T::class.java)

交换两个变量

var a = 1
var b = 2
a = b.also { b = a }

将代码标记为不完整 (TODO)

Kotlin 的标准库有一个 TODO() 函数，它总是会抛出 NotImplementedError。 它的返回类型是 Nothing，因此无论预期类型是什么，都可以使用它。 还有一个接受 reason 参数的重载：

fun calcTaxes(): BigDecimal = TODO("Waiting for feedback from accounting")

IntelliJ IDEA 的 Kotlin 插件理解 TODO() 的语义，并会在 TODO 工具窗口中自动添加一个代码指针。

接下来？

• 使用惯用的 Kotlin 风格解决 Advent of Code 谜题。
• 学习如何在 Java 和 Kotlin 中执行典型的字符串操作。
• 学习如何在 Java 和 Kotlin 中执行典型的集合操作。
• 学习如何在 Java 和 Kotlin 中处理可空性。