深入浅出Kotlin作用域函数

原文链接 Understanding Kotlin Scope Functions

Kotlin是基于JVM衍生出来的新一代通用编程言语，它的方针是简练，可读和高效，这儿的高效并不是代码的运转效率高，而是说项目的开发效率高。Kotlin有太多的小巧的新特性（在Java眼中便是语法糖），比方在Kotlin中有几个效果和用法都十分挨近的函数apply/with/run/let/also，它们的正统姓名是效果域函数(Scope functions)，今天就来学习一下这些函数的运用办法和详细差异。

Java是面向目标的主力言语，它的特色是谨慎和教条，Java写出来的代码学过Java的人大多都看得懂，所以规模以上的项目现在基本上都用Java，这对保护是有优点的。但Kotlin不相同，它有十分多的特性，交融了许多编程言语的特色，相同一件工作，或许有无数种写法，尽管号称是用标准Kotlin言语完成的，但是即便学过Kotin的人也看不懂。比方尽管你学会了Function，Object和lambda，以及像inline function和extension，但是假如用apply和with写几段办法，你就看不懂了，这就导致了Kotlin尽管易于上手，但是要想学透和进步曲线 就会陡峭许多。

究竟是个啥

先来看一下Scope function究竟是什么，它们的效果是在一个目标上履行一段代码，咱们来看一个简单的比如：有一个类是Person，它有一些特点和办法，咱们想对它的一个目标进行操作，通常会这样做：

val alice = Person(name="Alice", age=20,addr="Amsterdam")
println(alice)
alice.moveTo("London")
alice.incrementAge(2)
println("Two years later ${alice.name} is at ${alice.addr}")

但运用scope function，咱们能够这样做：

val alice = Person("Alice", 20, "Amsterdam").apply {
	println(this)
	moveTo("London")
	incrementAge(2)
}
println("Two years later ${alice.name} is at ${alice.addr}")
//Person(name='Alice', age=20, addr='Amsterdam')
//Two years later Alice is at London

这两段代码的输出是彻底相同的，但是第二段显着要简练许多这便是scope function的效果，仔细看apply后面的lambda块，它是一个scope，犹如在目标的类界说之中，在这个代码块中能够直接引证目标的办法，而不是像常规的那样运用目标的引证。

留意：假如不是很尾部lambda的同学能够先行参阅别的一篇文章，以加强了解。

了解Scope

效果域也能够了解为一个代码块的上下文，也便是说在一个代码中，能够直接运用的东西，环境变量之于进程，系统结构为运用预备的基础目标，都能够视为一种scope。最为显着的便是类的界说，在类中，咱们能够引证this指针来代表当时目标super指针来代表基类，这也是一种scope。lambda捕获的闭包也是一种scope。

Kotlin的scope functions便是把某一个目标当作代码块的scope，代码块中的代码能够方便的运用这个目标。

Scope funtions的效果

如同开头评论的，能用scope function写出来的东西，用常规方式也相同能够做到，那究竟图个啥呢？用scope function的方式代码变得愈加的简练和紧凑，咱们把针对某一目标的密布操作会集在一起放入一个代码块中，会愈加的内聚和紧凑，易于扩展和保护。但也要留意不能乱用，代码块中只应该写与目标相关的操作，与scope目标不相干的工作是肯定不应该放入其中的。

Scope functions

主要有6个，它们的运用主体都是一个目标，也便是要在一个目标上面调用这些函数，然后提供一个代码块（lambda）：

它们的差异

with不是一个extension函数

其他几个都是extension函数，所以with必定要把scope object作为参数传入。

scope目标的引证方式

对于scope function来说scope目标都会作为一个context object，能够在lambda块中运用，有些是作为this指针，有些是作为lambda的默许参数姓名也即it指针，但它们都指向context object，本质上是没有差异的仅仅指针的姓名一个是this一个是it。但是，跟类的界说scope是相同的，this指针是能够省掉的，但假如it作为参数，则是不能省掉的，详细来说，比方说，用apply时，代码块中是this指针，那么能够直接这样写：

val alice = Person("Alice", 20, "Amsterdam").apply {
	println(this)
	moveTo("London")
	incrementAge(2)
}

当然 你也能够显式的把this写出来，this.moveTo(“London”)，但这就麻烦多了，何必呢。所以apply最适宜的场景是对目标自身的操作，如赋值和修正特点。

但假如是用also，就有必要用it了，这个不能省，由于它是对scope目标的引证：

alice.also {
	println("Two years later ${it.name} is at ${it.addr}")
}

所以，also最适合的不是对目标自身的操作，而是一些与目标相关的副效果，如打印日志等。

回来值不同

这坨Scope functions是一个函数，它是有回来值的，这个回来是不相同的，apply/also回来的是context object，其他几个则是回来lambda中的回来值也便是lambda的最终一个表达 式或许lambda中显式的return语句。

所以，假如是想持续运用scope object，那么就要用apply/also，假如想得到某个其他值就要用let/run/with，即便说不在乎函数的回来值时，这时也推荐运用also，由于假如后续想持续添加其他操作时，能够直接在后面链接上其他的scope function。其他回来值的let/run/with一般用在一组操作的确定性的终点上面，比方统计均值，那最终的均值核算能够用run，比方文件操作，读写都能够用with。

如何挑选适宜的scope函数

结合它们各自的特色，能够得到如下运用主张：

假如是更改scope目标自身，用apply()

比方说要设置某个目标的一坨特点状况，这时就把方针目标作为scope，然后在其上调用apply()，在函数块内把操作都做完：

val alice = Person("Alice", 20, "Amsterdam").apply {
	println(this)
	moveTo("London")
	incrementAge(2)
}

假如是目标弱相关的副效果操作，就用also()

最为典型的比如便是比方说打印一些日志，这时最好的便是用also。

判断nullity，不是null时履行一些强相关操作时用let

基于当时目标，履行一些强相关的操作，这时能够用let，而且能够趁便做nullable检查。

目标作为一个参数，履行一些转化时用run/with

把当时目标作为一个参数，或许一个输入，做一些操作，履行一些转化，最终输出为其他目标时，这种时候最好用run/with，比方在不同的架构层级之间转化类型目标时，就能够用run/with。或许在网络回来和本地数据库实体之间转化时，也能够用run/with，差异不大，但用with可读性略强一些，适当所以把目标视为一个上下文，比方：

val res = nowWeather.getWeather(city)
with (res) {
   WeatherEnity(weather, city)
}

with函数体内的参数是this，能够直接引证目标的成员，能够使代码十分的简练，目标成了上下文，又不失可读性。这就让scope函数发挥了最大的价值。

留意事项

任何技术和工具要深刻了解它们的运用范围和运用场景以防止乱用，要用到恰到优点才能发挥最大的价值。对于一些非有必要的东西，更是如此。

Scope functions是运用于目标上面的，所以前提是当你需要对一个目标进行一些操作时，才能够运用scope functions，详细挑选哪一个参阅 上面一节的评论。别的，便是放入代码块中的操作有必要全部是scope目标相关的才能够。一个scope function中只能是一组相关的操作，不同组的操作要启用不同的scope functions。比方说网络恳求response的处理，能够分为服务器状况码和回来实体的检测，转成详细数据，打印日志这么三个scope functions，而不是全放进一个里边。

总而言之，要视详细的需求和场景，并基于场景挑选适宜的scope function，切忌过度运用。

参阅资料

• Scope functions
• Using Scoped Functions in Kotlin – let, run, with, also, apply
• Kotlin let, run, also, apply, with
• 秒懂Kotlin之彻底把握Scope Functions (apply, also,let,run,with)
• Kotlin之let,apply,run,with等函数差异
• Kotlin学习：run、with、apply、also、let的差异

原创不易，打赏，点赞，在看，保藏，分享 总要有一个吧