Kotlin标准库中的高阶函数

Kotlin标准库中的高阶函数

Kotlin中的5个通用扩展函数
这些函数都存在Standard.kt文件中，run,with,let,also,apply区别和使用场景：

1.run扩展函数的源码为:

/**
 * Calls the specified function [block] with `this` value as its receiver and returns its result.
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.run(block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

它会调用指定的代码块，然后返回结果
查看到会调用contract函数，看一下它在做什么

@ContractsDsl
@InlineOnly
@SinceKotlin("1.2")
internal inline fun contract(builder: ContractBuilder.() -> Unit) { }

DSL(domain specific language)：专门为解决某一特定问题的计算机语言，在Kotlin中特点为：链式调用，大括号嵌套，类似英语句子。主要用到的技术为：扩展函数，lambda，中缀调用，invoke约定。

@ContractsDsl：专用DSL的一部分的指定声明，用于构建函数的契约。
它是由@Retention(AnnotationRetention.BINARY)来进行注解的，注解声明保留有三种分别为：

• SOURCE：以源码为保留，不存在于二进制文件中
• BINARY：保存在二进制的文件输出中，但是对于反射不可见
• RUNTIME：保存在二进制的文件中，是对反射可见的。

@InlineOnly：指定此函数只有在内联中才可以调用。
此函数的接受类型为：ConstractBuilder，查看此类的方法callsInPlace，此函数是告诉编译器所传递的lamaba函数只会在此调用一次。
所有的此高阶函数中的contract一系列方法都是提供信息，帮助编译器分析函数的实际运行情况的。

想要加深对于ContractsDsl的理解，看下面的函数就知道了：

/**
 * Returns `true` if this nullable char sequence is either `null` or empty.
 */
@kotlin.internal.InlineOnly
public inline fun CharSequence?.isNullOrEmpty(): Boolean {
    contract {
        returns(false) implies (this@isNullOrEmpty != null)
    }

    return this == null || this.length == 0
}

如果此函数的返回值为false,那么当前对象就不为null。

这样如果我们接下来再次调用String相关的方法了，就不用添加?了，这就是帮助编译器分析一些判断不出来是否为空的状态。

那么再看回来此函数的具体实现，就是将此lamaba函数包装了一层作用域，然后返回此函数的返回值。

实际使用：由于Kotlin中没有break，continue，都是用return来进行处理的，那么如果我们要处理break的情况，就需要用到此run函数了

run break@ {
    ...
    ...
    //在需要break的地方调用
    return@break
}

2.with函数源码分析为：

/**
 * Calls the specified function [block] with the given [receiver] as its receiver and returns its result.
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> with(receiver: T, block: T.() -> R): R {
    //此函数上面分析过了，同上一样。
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return receiver.block()
}

此函数实际干的事情就是，接受了一个参数，然后此对象调用lamaba函数，统一进行处理。
实际使用：一个对象连续调用一系列的方法，使用此函数即可

with(context) {
    //当前的对象为context，直接调用Context所包含的函数即可，不需要使用context.xxx()进行函数调用等
    ...
    ...
}

3.let函数的源码为：

/**
 * Calls the specified function [block] with `this` value as its argument and returns its result.
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R {
    //同上
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block(this)
}

此函数同run基本一致，就是run指定了接受类型可以用this来进行处理，而此函数使用it来指代的，遮掩的一个好处就是可以先对此对象进行判断（例如是否为空），然后再调用一系列的函数。
实际情况：

xxx?.let {
    ....
    ....
    ....
}

这样我们可以将一个可空对象进行统一处理，而不必每次都调用?来判断了，增加代码的整洁性和可读性

4.also函数的源码为：

/**
 * Calls the specified function [block] with `this` value as its argument and returns `this` value.
 */
@kotlin.internal.InlineOnly
@SinceKotlin("1.1")
public inline fun <T> T.also(block: (T) -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block(this)
    return this
}

可以看到同let函数一致，就是返回值是当前对象
实际使用：

...also {
    
}.also {
    
}.also {
    
}

可以用作区分代码块

5.apply函数源码为：

/**
 * Calls the specified function [block] with `this` value as its receiver and returns `this` value.
 */
@kotlin.internal.InlineOnly
public inline fun <T> T.apply(block: T.() -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block()
    return this
}

指定接受对象为T类型，返回值为当前对象，可以用作一些对象属性的操作等
实际使用：

val info = Info().apply {
    //对于属性的一些相关操作等
}

6.总结：
在网上找到的一个总结图，可以辅助如何选择。函数使用相差不大，最好在代码中使用相同的方法为主吧。

kotlin1.jpg

7.备注参考文档

https://juejin.im/entry/5a9b2320f265da238f12014d

https://juejin.im/post/5b0048ed518825428a2619ed#comment

https://aisia.moe/2018/03/25/kotlin-contracts-dsl/

https://github.com/JetBrains/kotlin/blob/master/libraries/stdlib/src/kotlin/util/Standard.kt