Kotlin中常见内联扩展函数的使用方法教程

前言

Kotlin一个强大之处就在于它的扩展函数，巧妙的运用这些扩展函数可以让你写出的代码更加优雅，阅读起来更加流畅，下面总结了在开发中经常用到的一些内联扩展函数。经常有小伙伴搞不懂with，run，apply等等这些函数该怎么用，在哪里用，我的建议是先记住每个函数的功能（无非就是它需要什么参数？返回值是什么？）记住这两点再根据实际开发中的场景慢慢的就能熟练运用了。其实这些函数极其类似，不同的函数可以完成同样的功能，通过下面的实例也能看出。而在我以往的开发经验中这些函数主要的使用场景有两个，一是非空判断，二是对象的初始化或者本身及方法的频繁调用。

内联和正常函数的区别不在于定义函数的异同点。定义的时候只需要加一个标识，就可以让正常函数变为内联函数。实际两者的区别是在实际执行时的处理机制上。内联是耗用性能低，比正常函数少了压栈和出栈的操作，是一种以空间换时间的方式。当函数体少，以及被频繁调用的函数才适合被定义为内联函数

1. with

定义：fun <T, R> with(receiver: T, block: T.() -> R): R

功能：将对象作为函数的参数，在函数内可以通过 this指代该对象。返回值为函数的最后一行或return表达式。

实例：

1.在自定义view中当我们初始化画笔时很多时候我们会写下边的代码

 var paint = Paint()
 paint.color = Color.BLACK
 paint.strokeWidth = 1.0f
 paint.textSize = 18.0f
 paint.isAntiAlias = true

如果使用with，那么就可以写成这样

var paint = Paint()
with(paint) {
  color = Color.BLACK
  strokeWidth = 1.0f
  textSize = 18.0f
  isAntiAlias = true
 }

省去了paint.后书写起来感觉会更加自然

2.在声明一些集合的场景比如：

 var list= mutableListOf<String>()
 list.add("1")
 list.add("2")
 list.add("3")

使用with可以写成

var list = with(mutableListOf<String>()) {
  add("1")
  add("2")
  add("3")
  this
 }

开发中还有很多场景可以使用with功能，理解了with的功能也就能够灵活运用了。

2. takeIf和takeUnless

takeif

定义：fun <T> T.takeIf(predicate: (T) -> Boolean): T?

功能：传递一个函数参数，如果函数结果为true，返回T对象，否则返回null。

实例：使用File文件时通常会判断file是否存在，比如

 var file = File("filePath")
 if (file.exists()) {
  //do something
 } else {
  return false
 }

使用takeif后

var file = File("filePath").takeIf { it.exists() }?:return false
//do something

takeUnless

定义：fun <T> T.takeUnless(predicate: (T) -> Boolean): T?

功能：与takeIf相反，参数函数返回false时返回T对象，否则返回null，这里不再举例。

3. run

定义：

（1）fun <R> run(block: () -> R): R

（2）fun <T, R> T.run(block: T.() -> R): R

功能：调用run函数返回值为函数体最后一行，或return表达式。

实例：

返回最后一行

kotlin.run {
 println("11")
 println("22")
}

结果：

I/System.out: 11

I/System.out: 22

返回return表达式，return后面的代码不再执行（注意写法@run）

kotlin.run {
  return@run println("11")
  println("22")
 }

结果：

I/System.out: 11

4. repeat

定义：fun repeat(times: Int, action: (Int) -> Unit)

功能：重复执行action函数times次，times从0开始

实例：与for循环功能类似，例如

repeat(5){ println("count:$it") }

等价于

for (i in 0..4) { println("count:$i") }

或者

(0..4).forEach{println("count:$it")}

5. let

定义：fun <T, R> T.let(block: (T) -> R): R

功能：调用对象（T）的let函数，则该对象为函数的参数。在函数内可以通过 it 指代该对象。返回值为函数的最后一行或指定return表达式。

实例：有点类似于run(),let在使用中可用于空安全验证，变量?.let{}

例如

val data = ……
data?.let {
…… // 假如data不为null，代码会执行到此处
}

6. apply

定义：fun <T> T.apply(block: T.() -> Unit): T

功能：调用对象的apply函数，在函数范围内，可以任意调用该对象的任意方法，并返回该对象。

实例：

var list = mutableListOf<Int>().apply {
 add(1)
 add(2)
 add(3)
}

注意：他和run函数的区别，run返回的是最后一行，apply返回的是对象本身，由apply函数的定义我们可以看出apply适用于那些对象初始化需要给其属性赋值的情况。

还是用画笔的例子

原始的

 var paint = Paint()
 paint.textSize = 14.0f
 paint.color = Color.WHITE
 paint.isAntiAlias = false

使用apply后

 var paint = Paint().apply {
  textSize = 14.0f
  color = Color.WHITE
  isAntiAlias = false
 }

此外由于apply函数返回的是其对象本身，那么可以配合？.完成多级的非空判断操作，或者用于建造者模式的Builder中

7. also

定义：fun <T> T.also(block: (T) -> Unit): T

功能：调用对象的also函数，在函数块内可以通过 it
指代该对象,返回值为该对象本身。（注意其和let函数的区别，let返回的是最后一行，also返回的是对象本身）

实例：需要返回对象本身（this）的情况下，例如建造者模式。

总结