Skip to content

习惯用法 ​

Kotlin 中各种常用习惯用法的集合。如果您有喜欢的习惯用法,欢迎通过发送拉取请求来贡献。

创建 DTO(POJO/POCO) ​

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

提供了具有以下功能的 Customer 类:

  • 所有属性的 getter(对于 var 则还有 setter)
  • equals()
  • hashCode()
  • toString()
  • copy()
  • 所有属性对应的 component1()、component2()……(参见数据类)

函数形参的默认值 ​

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

过滤列表 ​

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

或者更简短的形式:

kotlin
val positives = list.filter { it > 0 }

了解 Java 与 Kotlin 过滤的区别。

检查集合中是否存在某元素 ​

kotlin
if ("john@example.com" in emailsList) { ... }

if ("jane@example.com" !in emailsList) { ... }

字符串插值 ​

kotlin
println("Name $name")

了解 Java 与 Kotlin 字符串串联的区别。

安全读取标准输入 ​

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

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

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

实例检查 ​

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

只读列表 ​

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

只读 Map ​

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

访问 Map 条目 ​

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

遍历 Map 或键值对列表 ​

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

k 和 v 可以使用任何方便的名称,例如 name 和 age。

在区间上迭代 ​

kotlin
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 { ... }

延迟加载属性 ​

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

扩展函数 ​

kotlin
fun String.spaceToCamelCase() { ... }

"Convert this to camelcase".spaceToCamelCase()

创建单例 ​

kotlin
object Resource {
    val name = "Name"
}

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

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

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

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

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

实例化抽象类 ​

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

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

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

If-not-null 简写 ​

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

println(files?.size) // 如果 files 不为 null,则输出 size

If-not-null-else 简写 ​

kotlin
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)

如果为 null 则执行表达式 ​

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

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

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

了解 Java 与 Kotlin 获取首个元素的区别。

如果不为 null 则执行 ​

kotlin
val value = ...

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

如果不为 null 则映射可空值 ​

kotlin
val value = ...

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

在 when 语句中返回 ​

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

try-catch 表达式 ​

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

    // 处理 result
}

if 表达式 ​

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

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

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

单表达式函数 ​

kotlin
fun theAnswer() = 42

这等价于

kotlin
fun theAnswer(): Int {
    return 42
}

这可以与其他习惯用法有效结合,从而写出更简短的代码。例如,结合 when 表达式:

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

对一个对象实例调用多个方法(with) ​

kotlin
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) ​

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

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

Java 7 的 try-with-resources ​

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

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

kotlin
//  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)

交换两个变量 ​

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

将代码标记为未完成(TODO) ​

Kotlin 标准库提供了一个 TODO() 函数,该函数始终会抛出 NotImplementedError。 它的返回值类型为 Nothing,因此无论期望类型是什么都可以使用。 它还有一个接受 reason 形参的重载:

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

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

下一步 ​