习惯用法

一些在 Kotlin 中广泛使用的语法习惯,如果你有更喜欢的语法习惯或者风格,建一个 pull request 贡献给我们吧!

创建 DTOs(POJOs/POCOs)

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

会为 Customer 类提供以下功能:

  • 所有属性的 getters (对于 var 定义的还有 setters)
  • equals()
  • hashCode()
  • toString()
  • copy()
  • 所有属性的 component1()component2()……等等(参见数据类

函数的默认参数

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

过滤 list

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

或者可以更短:

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

检测元素是否存在于集合中

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

字符串内插

  1. println("Name $name")

类型判断

  1. when (x) {
  2. is Foo //-> ……
  3. is Bar //-> ……
  4. else //-> ……
  5. }

遍历 map/pair型list

  1. for ((k, v) in map) {
  2. println("$k -> $v")
  3. }

kv 可以改成任意名字。

使用区间

  1. for (i in 1..100) { …… } // 闭区间:包含 100
  2. for (i in 1 until 100) { …… } // 半开区间:不包含 100
  3. for (x in 2..10 step 2) { …… }
  4. for (x in 10 downTo 1) { …… }
  5. if (x in 1..10) { …… }

只读 list

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

只读 map

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

访问 map

  1. println(map["key"])
  2. map["key"] = value

延迟属性

  1. val p: String by lazy {
  2. // 计算该字符串
  3. }

扩展函数

  1. fun String.spaceToCamelCase() { …… }
  2. "Convert this to camelcase".spaceToCamelCase()

创建单例

  1. object Resource {
  2. val name = "Name"
  3. }

If not null 缩写

  1. val files = File("Test").listFiles()
  2. println(files?.size)

If not null and else 缩写

  1. val files = File("Test").listFiles()
  2. println(files?.size ?: "empty")

if null 执行一个语句

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

在可能会空的集合中取第一元素

  1. val emails = …… // 可能会是空集合
  2. val mainEmail = emails.firstOrNull() ?: ""

if not null 执行代码

  1. val value = ……
  2. value?.let {
  3. …… // 代码会执行到此处, 假如data不为null
  4. }

映射可空值(如果非空的话)

  1. val value = ……
  2. val mapped = value?.let { transformValue(it) } ?: defaultValue
  3. // 如果该值或其转换结果为空,那么返回 defaultValue。

返回 when 表达式

  1. fun transform(color: String): Int {
  2. return when (color) {
  3. "Red" -> 0
  4. "Green" -> 1
  5. "Blue" -> 2
  6. else -> throw IllegalArgumentException("Invalid color param value")
  7. }
  8. }

“try/catch”表达式

  1. fun test() {
  2. val result = try {
  3. count()
  4. } catch (e: ArithmeticException) {
  5. throw IllegalStateException(e)
  6. }
  7. // 使用 result
  8. }

“if”表达式

  1. fun foo(param: Int) {
  2. val result = if (param == 1) {
  3. "one"
  4. } else if (param == 2) {
  5. "two"
  6. } else {
  7. "three"
  8. }
  9. }

返回类型为 Unit 的方法的 Builder 风格用法

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

单表达式函数

  1. fun theAnswer() = 42

等价于

  1. fun theAnswer(): Int {
  2. return 42
  3. }

单表达式函数与其它惯用法一起使用能简化代码,例如和 when 表达式一起使用:

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

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

  1. class Turtle {
  2. fun penDown()
  3. fun penUp()
  4. fun turn(degrees: Double)
  5. fun forward(pixels: Double)
  6. }
  7. val myTurtle = Turtle()
  8. with(myTurtle) { // 画一个 100 像素的正方形
  9. penDown()
  10. for (i in 1..4) {
  11. forward(100.0)
  12. turn(90.0)
  13. }
  14. penUp()
  15. }

配置对象的属性(apply

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

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

Java 7 的 try with resources

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

对于需要泛型信息的泛型函数的适宜形式

  1. // public final class Gson {
  2. // ……
  3. // public <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {
  4. // ……
  5. inline fun <reified T: Any> Gson.fromJson(json: JsonElement): T = this.fromJson(json, T::class.java)

使用可空布尔

  1. val b: Boolean? = ……
  2. if (b == true) {
  3. ……
  4. } else {
  5. // `b` 是 false 或者 null
  6. }

交换两个变量

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

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

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

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

IntelliJ IDEA 的 kotlin 插件理解 TODO() 的语言,并且会自动在 TODO 工具窗口中添加代码指示。