Kotlin

如果一个用 val 声明的 top-level 变量在编译时就已经知道它的值，那么我们可以为它增加修饰符 constant，这样编译器会把它进行内联以提高性能。

const val CONSTANT_A: String = "This is constant A"           // 这是正确用法

fun main() {
    println(CONSTANT_A)

    // const val CONSTANT_B: String = "This is constant B"    // 这行会报错，因为它是函数内的局部变量，不是 top-level 变量
    // println(CONSTANT_B)
}

关于 constant 的其它约束可以参考：https://kotlinlang.org/docs/properties.html#compile-time-constants

Kotlin 中的整数类型如表 1 所示。

如果没有明确指定类型，编译器会根据 Literal 的形式自动推导为 Int/UInt 或者 Long/ULong 类型。

val one = 1                     // Int
val threeBillion = 3000000000   // Long，由于 Int 类型不足以保存这么大的数字，所以会自动推导为 Long
val oneLong = 1L                // Long

val one = 1u                     // UInt
val threeBillion = 3000000000uL  // ULong
val oneLong = 1uL                // ULong

Kotlin 中的整数类型如表 2 所示。

Kotlin 中的 Boolean 类型有两个字面量 true 和 false ，它们支持逻辑或 || 、逻辑与 && 和逻辑取反 ! 运算。比如：

val myTrue: Boolean = true
val myFalse: Boolean = false

println(myTrue || myFalse)    // true
println(myTrue && myFalse)    // false
println(!myTrue)              // false

Kotlin 中的 Char 类型的字面量使用单引号表示。单引号中的反斜线有特殊含义，会进行转义。比如：

val a = 'h'         // a 类型为 Char
val b = '我'        // b 类型为 Char，表示一个汉字
var c = '\n'        // c 类型为 Char，表示换行符

println(a)
println(b)
println(c)          // Prints an extra newline character

Kotlin 中的 String 类型的字面量使用双引号表示。比如：

val s = "Hello, world!\n"

多行字符串使用 3 个双引号表示。比如：

val text = """
    for (c in "foo")
        print(c)
"""

如果多行字符串有 margin prefix，则可以使用 trimMargin() 删除它们。

数组（Array）中的元素必须是相同的类型，而且元素个数不能动态改变（即：当我们增加或删除数组中元素时，会创建新的数组然后进行复制）。在 Kotlin 中，更常使用的是标准库中的 Collections，仅当一些特别需求（比如 low-level 操作）情况下才会使用 Array。

通过下面方式可以创建数组：

1. arrayOf(), arrayOfNulls()
   
2. emptyArray()
   
3. Array 构造函数
   

下面是创建 Array 的例子：

// Creates an array with values [1, 2, 3]
val simpleArray = arrayOf(1, 2, 3)                                    // 创建数组的方式：使用 arrayOf
println(simpleArray.joinToString())

// Creates an array with values [null, null, null]
val nullArray: Array<Int?> = arrayOfNulls(3)                          // 创建数组的方式：使用 arrayOfNulls
println(nullArray.joinToString())

// Create an empty array with the emptyArray() function:
var exampleArray1 = emptyArray<String>()                              // 创建数组的方式：使用 emptyArray
var exampleArray2: Array<String> = emptyArray()  // same as above     // 创建数组的方式：使用 emptyArray

// Creates an Array<String> with values ["10", "10", "10", "10", "10"]
val initArray = Array<Int>(5) { 10 }                                  // 创建数组的方式：使用 Array 构造函数
println(initArray.joinToString())  // 10, 10, 10, 10, 10

// Creates an Array<String> with values ["0", "1", "4", "9", "16"]
val asc = Array(5) { i -> (i * i).toString() } // i starts from 0     // 创建数组的方式：使用 Array 构造函数
asc.forEach { print(it) }   // it 是隐式参数 https://kotlinlang.org/docs/lambdas.html#it-implicit-name-of-a-single-parameter

List 实例：

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    println("Number of elements: ${numbers.size}")
    println("Third element: ${numbers.get(2)}")
    println("Fourth element: ${numbers[3]}")
    println("Index of element \"two\" ${numbers.indexOf("two")}")
}

Set 实例：

fun main() {
    val numbers = setOf(1, 2, 3, 4)
    println("Number of elements: ${numbers.size}")
    if (numbers.contains(1)) println("1 is in the set")

    val numbersBackwards = setOf(4, 3, 2, 1)
    println("The sets are equal: ${numbers == numbersBackwards}")
}

Map（Dictionary）实例：

fun main() {
    val numbersMap = mapOf(
        "key1" to 1,
        "key2" to 2,
        "key3" to 3,
        "key4" to 4,
    )

    println("All keys: ${numbersMap.keys}")
    println("All values: ${numbersMap.values}")
    if ("key2" in numbersMap) println("Value by key \"key2\": ${numbersMap["key2"]}")
    if (1 in numbersMap.values) println("The value 1 is in the map")
    if (numbersMap.containsValue(1)) println("The value 1 is in the map") // same as previous
}

参考：https://kotlinlang.org/docs/collections-overview.html

Kotlin 中 if 是表示式，它返回一个值。这样，我们不再需要三元操作符了。

下面是 if 的使用例子：

fun main() {
    val a = 2
    val b = 3

    var max = a
    if (a < b) max = b                            // if 可省略大括号，可以没有 else

    // With else
    if (a > b) {
        max = a
    } else {
        max = b
    }

    // As expression
    max = if (a > b) a else b                     // 把 if 表示式的值赋值给 max，相当于三元操作符

    // You can also use `else if` in expressions:
    val maxLimit = 1
    val maxOrLimit = if (maxLimit > a) maxLimit else if (a > b) a else b


    println("max is $max")
    println("maxOrLimit is $maxOrLimit")
}

Kotlin 中 when 相当于其它语言中的 switch 语句。

下面是 when 的使用例子：

fun main() {
    val x = 4

    when (x) {
        0, 1 -> print("x == 0 or x == 1")
        2 -> print("x == 2")
        in 3..10 -> print("x is in the range [3, 10]")
        else -> print("otherwise")
    }
}

下面是 for 的使用例子：

fun main() {
    for (i in 1..4) {         // 会输入 1,2,3,4
        println(i)
    }

    val a = arrayOf(1, 3, 9)
    for (i in a) {
        println(i)
    }
}

Kotlin 中支持 while 和 do...while ，它们的区别在于 do...while 中的语句至少会执行一次。

下面是 while 的使用例子：

fun main() {
    var i = 1

    while (i <= 5) {
        println("i = $i")
        ++i
    }
}

下面是 do...while 的使用例子：

fun main() {
    var sum: Int = 0
    var input: String

    do {
        print("Enter an integer (enter 0 to end): ")
        input = readLine()!!
        sum += input.toInt()

    } while (input != "0")

    println("sum = $sum")
}

break 可以跳出最内层的循环，如：

fun main() {
    for (i in 1..5) {                   // 输出 1,2
        if (i == 3) {
            break
        }
        println(i)
    }
}

continue 可以中止最内层循环的当前迭代，继续下一次迭代，如：

fun main() {
    for (i in 1..5) {                   // 输出 1,2,4,5
        if (i == 3) {
            break
        }
        println(i)
    }
}

Kotlin 中， try...catch...finally 是表达式，也就是说它会返回某个值。比如：

val a: Int? = try { input.toInt() } catch (e: NumberFormatException) { null }

throw 表达式的类型是 Nothing 。这个类型没有值，它一般用于标记一个不会到达的代码位置。你可以声明一个函数的返回类型为 Nothing ，表示它不会返回。比如：

fun fail(message: String): Nothing {              // 也可以不明确指定它的返回类型，因为编译器有类型推导系统
    throw IllegalArgumentException(message)
}

你也可能在其它地方看到过 Nothing 类型。比如：

val x = null                                      // 'x' has type `Nothing?`
val l = listOf(null)                              // 'l' has type `List<Nothing?>

Kotlin 中使用关键字 class 来定义类。它支持两种构造函数：

1. Primary Constructor，一个类只能有一个 Primary Constructor；
   
2. Secondary Constructors，一个类可以没有，也可以有多个 Secondary Constructors。
   

Primary Constructor 是在类声明头中的构造函数，下面是 Primary Constructor 的例子：

class Person constructor(val name: String, var age: Int) {  // 这是 Primary Constructor。可省掉 constructor 关键字，即写为 class Person (val name: String, var age: Int) {

    fun getInfo(): String {
        return "Name: $name\nAge: $age"
    }

    init {                                                  // Primary Constructor 中不能有复杂逻辑，可以把初始化逻辑代码放入 init 块中
        println("First initializer block that prints $name")
    }
}

fun main() {
    val person1 = Person("Alice", 25)                       // Kotlin 不使用 new 创建对象

    println(person1.name)
    println(person1.age)

    person1.age += 1

    println(person1.getInfo())
}

Secondary Constructors 是名为 constructor 的成员函数，可以有多个，比如：

class Person(val name: String, var age: Int) {                              // 这是 primary constructor
    val children: MutableList<Person> = mutableListOf()

    constructor(name: String, age: Int, parent: Person) : this(name, age) { // 第一个 secondary constructor
        parent.children.add(this)
    }

    constructor(name: String, parent: Person) : this(name, 0) {             // 第二个 secondary constructor
        parent.children.add(this)
    }

    fun getInfo(): String {
        return "Name: $name\nAge: $age\nChildren number: ${children.size}"
    }
}

fun main() {
    val parent = Person("Alice", 32)                        // Kotlin 不使用 new 创建对象
    val child1 = Person("Joe", 3, parent)                   // Kotlin 不使用 new 创建对象
    val child2 = Person("Winny", parent)                    // Kotlin 不使用 new 创建对象

    println(parent.getInfo())
    println(child1.getInfo())
    println(child2.getInfo())
}

类的属性的语法为：

var <propertyName>[: <PropertyType>] [= <property_initializer>]
    [<getter>]
    [<setter>]

下面是类属性的例子：

class Rectangle(val width: Int, val height: Int) {    // 这个类有三个属性 width,height,area

    val area: Int
        get() = this.width * this.height
}

fun main() {
    val r = Rectangle(10, 20)
    println("width = ${r.width}")       // width = 10
    println("height = ${r.height}")     // height = 20
    println("area = ${r.area}")         // area = 200
}

Kotlin 中所有类都有一个共同的父类： Any ， Any 有三个方法 equals(), hashCode(), toString() 。也就是说，Kotlin 所有类都有这三个方法。

默认，Kotlin 中的类都是 final 的，不能被继承。要让一个类可以被其它类继承，则需要使用 open 关键字，比如：

open class Base(p: Int)                     // 使用了 open 关键字，这样其它类可以继承 Base 了
class Derived(p: Int) : Base(p)             // 类 Derived 继承于类 Base

Classes, objects, interfaces, and functions 等都可以控制其可见性。Kotlin 有表 4 所示机制来控制可见性。

下面是使用 private 修饰函数，internal 修饰全局变量的例子：

// file name: example.kt
package foo

private fun foo() { ... }     // visible inside example.kt

internal val baz = 6          // visible inside the same module

下面是修饰类成员的例子：

open class Outer {
    private val a = 1
    protected open val b = 2
    internal open val c = 3
    val d = 4             // public by default

    protected class Nested {
        public val e: Int = 5
    }
}

class Subclass : Outer() {
    // a is not visible
    // b, c and d are visible
    // Nested and e are visible

    override val b = 5   // 'b' is protected
    override val c = 7   // 'c' is internal
}

一个类可以被声明为 abstract ，这就是抽象类。不能直接实例化抽象类。

下面是抽象类的例子：

abstract class Person(name: String) {             // Person 是抽象类，不能直接实例化

    init {
        println("My name is $name.")
    }

    fun displaySSN(ssn: Int) {
        println("My SSN is $ssn.")
    }

    abstract fun displayJob(description: String)  // 这个方法是 abstract 的，它没有实现。Person 子类中必须实现这个方法
}

class Teacher(name: String): Person(name) {

    override fun displayJob(description: String) {
        println("I'm a $description teacher.")
    }
}

fun main() {
    val teacher = Teacher("Alice")
    teacher.displayJob("mathematics")
    teacher.displaySSN(12345)
}

使用 interface 关键字可以声明接口。和抽象类类似，我们不能直接实例化接口。

下面是接口的例子：

interface Person {                                    // Person 是接口，不能直接实例化
    val name: String                                  // abstract property

    fun displaySSN(ssn: Int) {                        // 这个方法有默认实现
        println("My SSN is $ssn.")
    }

    fun displayJob(description: String)               // abstract method
}

class Teacher(override val name: String) : Person {   // override 了接口的抽象属性 name

    override fun displayJob(description: String) {    // override 了接口的抽象方法 displayJob
        println("I'm a $description teacher.")
    }
}

fun main() {
    val teacher = Teacher("Alice")
    teacher.displayJob("mathematics")
    teacher.displaySSN(12345)
}

抽象类和接口的主要区别在于： 抽象类可以有状态，而接口不保存状态。类只能继承一个抽象类，但可以实现多个接口。

Kotlin 提供了一种在不修改类的情况下，可以增强类功能的机制，即 Extension。它包含 Extension functions 和 Extension properties 两种机制。

下面是 Extension functions 的例子：

fun String.removeFirstLastChar(): String = this.substring(1, this.length - 1)

fun main() {
    val myString= "abcde"
    val result = myString.removeFirstLastChar()
    println("Result is: $result")                 // bcd
}

如果 Extension functions 是类中已经存在的函数，那么类中的函数总是有更高优先级。比如：

class Example {
    fun printFunctionType() { println("Class method") }
}

fun Example.printFunctionType() { println("Extension function") }

fun main() {
    Example().printFunctionType()                 // Class method
}

如果类仅仅是用于保存数据，则可以使用 Data classes，编译器会自动为它生成一些函数。

比如有 Data class：

data class User(val name: String, val age: Int)

则编译器自动生成：

1. equals()/hashCode() pair.
   
2. toString() of the form "User(name=John, age=42)".
   
3. componentN() functions corresponding to the properties in their order of declaration.
   
4. copy() function
   

其中生成的 copy() 是很有用的，比如：

data class User(val name: String, val age: Int)

fun main() {
    val jack = User(name = "Jack", age = 1)
    println(jack)             // User(name=Jack, age=1)

    val olderJack = jack.copy(age = 2)
    println(olderJack)        // User(name=Jack, age=2)
}

在类前使用 enum 可以声明为枚举，比如：

enum class RGB { RED, GREEN, BLUE }

fun main() {
    for (color in RGB.entries) println(color.toString())  // prints RED, GREEN, BLUE

    val color = RGB.valueOf("RED")
    println("The first color is: $color")                 // prints "The first color is: RED"
}

在讨论 Sealed classes 前，先看看 Sealed classes 能解决什么问题。

考虑下面程序：

open class Expr
class Const(val value: Int) : Expr()
class Sum(val left: Expr, val right: Expr) : Expr()

fun eval(e: Expr): Int =
    when (e) {
        is Const -> e.value
        is Sum -> eval(e.right) + eval(e.left)
        else ->
            throw IllegalArgumentException("Unknown expression")
    }

fun main() {
    val expr = Const(1)
    println(eval(expr))
}

上面程序运行良好。Expr 有两个子类 Const 和 Sum， 但如果哪一天我们给它增加了另外一个子类，那么 eval 函数中的 when 表达式也需要增加相应的分支，但这很容易忘记。由于 when 表达式有 else 语句，当我们忘记为新子类增加 when 分支时编译器并不能帮我们发现问题。

Sealed classes 就是为了解决这个问题的：

sealed class Expr                                 // 把 class 设置为 sealed 可以解决上面提到的问题
class Const(val value: Int) : Expr()
class Sum(val left: Expr, val right: Expr) : Expr()

fun eval(e: Expr): Int =
    when (e) {
        is Const -> e.value
        is Sum -> eval(e.right) + eval(e.left)
    }

fun main() {
    val expr = Const(1)
    println(eval(expr))
}

eval 函数中的 when 表达式中不再需要 else 语句了，这样一旦我们给 Expr 增加了新子类，编译会强制要求我们在 when 表达式中增加相应的分支，否则编译器报错。

下面是类泛型的例子：

class ParameterizedClass<T>(private val value: T) {

    fun getValue(): T {
        return value
    }
}

fun main() {
    val parameterizedClass1 = ParameterizedClass<String>("string-value")
    val res1 = parameterizedClass1.getValue()
    println(res1 is String)            // true

    val parameterizedClass2 = ParameterizedClass<Int>(100)
    val res2 = parameterizedClass2.getValue()
    println(res2 is Int)               // true
}

下面是函数泛型的例子：

fun <T> middle(list: List<T>): T {
    return list[list.size / 2]
}

fun main() {
    val middleString: String = middle(listOf("ab", "cd", "ef"))
    println(middleString)

    val middleInteger: Int = middle(listOf(1, 2, 3, 4, 5))
    println(middleInteger)
}

当我们不关心泛型类型时，可以使用 * ，比如：

fun printArray(array: Array<*>) {
    array.forEach { println(it) }
}

fun main() {
    val a = arrayOf(1,2,3)
    printArray(a)

    val b = arrayOf("ab", "cd", "ef")
    printArray(b)
}

单例模式是指一个类只有一个实例（对象）。在 Kotlin 中使用 Object declarations 来表达单例模式。

下面是 Object declaration 的例子：

object MySingleton {
    fun doSomething() {
        // ...
    }
}

fun main() {
    MySingleton.doSomething()
}

有时我们想对类进行小修改，但懒得声明子类。这时可以使用 Object expressions。

下面是 Object expression 的例子：

window.addMouseListener(object : MouseAdapter() {   // object 是关键字，这里表示 Object expression
    override fun mouseClicked(e: MouseEvent) {
        // ...
    }

    override fun mouseEntered(e: MouseEvent) {
        // ...
    }
})

上面例子相当于创建了 MouseAdapter 的子类，而且重载了方法 mouseClicked/mouseEntered ，再把这个子类的对象传递给 addMouseListener 函数。也可以写为：

val obj = object : MouseAdapter() {
    override fun mouseClicked(e: MouseEvent) {
        // ...
    }

    override fun mouseEntered(e: MouseEvent) {
        // ...
    }
}

window.addMouseListener(obj)

下面是 Object expression 的完整例子：

// From https://www.programiz.com/kotlin-programming/object-singleton

open class Person(name: String, age: Int) {
    init {
        println("name: $name, age: $age")
    }

    fun eat() = println("Eating food.")
    fun talk() = println("Talking with people.")
    open fun pray() = println("Praying god.")
}

fun main() {
    val atheist = object : Person("Jack", 29) {
        override fun pray() = println("I don't pray. I am an atheist.")
    }

    atheist.eat()
    atheist.talk()
    atheist.pray()
}

使用 typealias 可以给类型创建别名。比如：

typealias Predicate<T> = (T) -> Boolean           // Predicate<T> 是函数类型 (T) -> Boolean 的别名

fun foo(p: Predicate<Int>) = p(42)

fun main() {
    val f: (Int) -> Boolean = { it > 0 }
    println(foo(f))                   // prints "true"

    val p: Predicate<Int> = { it > 0 }
    println(listOf(1, -2).filter(p))  // prints "[1]"
}

Kotlin 函数支持默认参数，比如：

fun foo(
    bar: Int,
    baz: Int = 200,           // 这是默认参数
    qux: Int = 300,           // 这也是默认参数。这里有个多余的逗号是没有关系的
) {
    println("bar is $bar")
    println("baz is $baz")
    println("qux is $qux")
}

fun main() {
    foo(10, 20, 30)           // 指定了所有参数
    foo(10, 20)               // 省略了一个默认参数
    foo(10)                   // 省略了两个默认参数
}

默认参数后面还可以有普通的参数，比如：

fun foo(
    bar: Int = 100,
    baz: Int,                 // 默认参数 bar 后面还有普通参数 baz
) {
    println("bar is $bar")
    println("baz is $baz")
}

fun main() {
    foo(10, 20)               // 指定了所有参数
    foo(baz = 200)            // 省略了默认参数，普通参数则必须指定名称
}

变长参数使用 vararg 修饰，如：

fun <T> asList(vararg ts: T): List<T> {   // 参数 ts 是变长参数
    val result = ArrayList<T>()
    for (t in ts)  // ts is an Array
        result.add(t)
    return result
}

fun main() {
    val list1 = asList(1, 2, 3)
    println("$list1")                     // [1, 2, 3]

    val a = arrayOf(1, 2, 3)
    val list2 = asList(-1, 0, *a, 4)      // 数组前面的星号 * 是 spread operator，表示把内容展开作为变长参数的一部分
    println("$list2")                     // [-1, 0, 1, 2, 3, 4]
}

当函数不需要返回值时，可以声明返回类型是 Unit。这种类型的值，只有一个就是 Uint。如：

fun printHello(name: String?): Unit {
    if (name != null)
        println("Hello $name")
    else
        println("Hi there!")

    // `return Unit` or `return` is optional
}

当然，也可以直接不声明返回类型，上面代码等价于：

fun printHello(name: String?) {
    if (name != null)
        println("Hello $name")
    else
        println("Hi there!")
}

如果函数体只有一个表达式，则可以省略函数体的大括号，把表达式直接写在等号后面。如：

fun double(x: Int): Int = x * 2        // Single-expression 函数
fun double(x: Int) = x * 2             // 同上。由于编译器可以自动推导出类型，所以返回类型也可以省略

用 infix 关键字标记的函数也可以使用中缀表示法调用（即省略调用的点和圆括号）。Infix functions 必须满足以下要求：

1. 必须是成员函数（member functions）或扩展函数（extension functions）；
   
2. 它们必须有一个参数；
   
3. 形参不能接受可变数量的参数，也不能有默认值。
   

下面是中缀函数的例子：

infix fun Int.add(number: Int): Int {     // 使用 infix 声明中缀函数
    return this + number                  // 中缀函数总是有 receiver，关键字 this 表示 receiver
}

fun main() {
    val num = 10
    val newNum1 = num.add(5)
    println("$newNum1")

    val newNum2 = num add 5               // 使用中缀函数
    println("$newNum2")
}

如果某个函数的参数是函数，或者返回值是函数；那么这个函数就是高阶函数（Higher-order functions）。

Lambda 表达式就是“函数字面量”。比如：

fun main() {
    val square = { number: Int -> number * number }     // Lambda 表达式

    val nine = square(3)
    println("$nine")
}

编译器会进行 Automatic casts，以方便使用，下面是例子：

fun parseInt(str: String): Int? {
    return str.toIntOrNull()
}

fun printProduct(arg1: String, arg2: String) {
    val x = parseInt(arg1)
    val y = parseInt(arg2)

    if (x == null) {                    // if 中 x 为 null 会退出，编译器会把 if 外部后续代码中的 x 自动会变为 Int 类型，方便使用
        println("Wrong number format in arg1: '$arg1'")
        return
    }
    if (y == null) {                    // if 中 y 为 null 会退出，编译器会把 if 外部后续代码中的 y 自动会变为 Int 类型，方便使用
        println("Wrong number format in arg2: '$arg2'")
        return
    }

    // x and y are automatically cast to non-nullable after null check
    println(x * y)
}

fun main() {
    printProduct("6", "7")
    printProduct("a", "7")
    printProduct("99", "b")
}

上面的 printProduct 也可以为：

fun printProduct(arg1: String, arg2: String) {
    val x = parseInt(arg1)
    val y = parseInt(arg2)

    // Using `x * y` yields error because they may hold nulls.
    if (x != null && y != null) {       // 由于 if 中检查了 x,y 的值，在这个 if 分支内，x 和 y 会自动变为 Int 类型，方便使用
        // x and y are automatically cast to non-nullable after null check
        println(x * y)
    }
    else {
        println("'$arg1' or '$arg2' is not a number")
    }
}

Kotlin 中的 Coroutine 遵守了 Structured concurrency 的原则，也就是说 新的 Coroutine 只能在特定的 CoroutineScope 中启动。 前一节的例子中，runBlocking 就是建立了这样的 Scope。

在现实的应用程序中，往往会启动大量的 Coroutines，使用 Structured concurrency 可以确保 Coroutines 不会丢失、不会泄漏。