解析Kotlin中的Nothing【笔记摘要】

1.Nothing的本质

Nothing 的源码很简单：

public class Nothing private constructor()

可以看到它是个class，但它的构造函数是 private 的，这就导致我们没法创建它的实例，并且在源码里 Kotlin 也没有帮我们创建它的实例。

基于这样的前提，当我们写出这个函数声明的时候：

fun nothing(): Nothing {

}

我们不可能找到一个合适的值来返回，因为压根找不到Nothing的实例

2.作用一：作为函数「永不返回」的提示

上面的例子看起来是个悖论，但它其实就是 Nothing 存在的意义：它找不到任何可用的值，所以，以Nothing为返回值类型的函数一定是个不会返回的函数。

比如它可以总是抛异常：

fun nothing() : Nothing {
  throw RuntimeException("Nothing!")
}

这个写法并没有返回任何结果，而是抛异常了，所以是合法的。

注意：抛异常是可以忽略返回值，而且这不是 Nothing 的特性，在Java和Kotlin中都是如此：

//Java
public String getName() {
    throw new NullPointerException("不能为空！");
}

//Kotlin
fun getName() : String {
  throw NullPointerException("不能为空！")
}

上面这个getName()看起来有点奇怪，为什么在一个函数中就只是抛出异常呢，但它的写法本身是完全合法的。如果把函数的名字改一下，再加个注释：

/**
 当遇到姓名为空的时候，请调用这个函数来抛异常
*/
fun throwOnNameNull() : String {
  throw NullPointerException("姓名不能为空！")
}

这就很合理了吧？不干别的，就只是抛异常。这是一种很常用的工具函数的写法，包括 Kotlin 和 Compose 的官方源码里也有这种东西。

那么我们继续来看它的返回值类型：我都不返回了，就没必要还写 String 了吧？那写什么？可以把它改成 Unit，

fun throwOnNameNull() : Unit {
  throw NullPointerException("姓名不能为空！")
}

甚至可以把它改成不写返回值。但这里不写返回值，实际上返回类型是Unit，Kotlin会自动帮我们加上，可以看这篇文章：解析Kotlin中的Unit【笔记摘要】

fun throwOnNameNull() : Unit {
  throw NullPointerException("姓名不能为空！")
}

fun throwOnNameNull() {
  throw NullPointerException("姓名不能为空！")
}

不过，Kotlin 又进了一步，提供了一个额外的选项：你还可以把它改成 Nothing：

/**
 当任何变量为空的时候，请统一调用这个函数来抛异常
*/
fun throwOnNameNull() : Nothing {
  throw NullPointerException("姓名不能为空！")
}

虽然我找不到 Nothing 的实例，但是这个函数本来就是永远抛异常的，找不到实例也没关系。

这么写的价值就在于，Nothing 这个返回值类型能够给使用它的开发者一个明确的提示：这是个永远不会返回的函数。这种提示本身，就会给开发提供一些方便，它能很好地避免函数的调用者对函数的误解而导致的一些问题。

Kotlin 的源码、Compose 的源码里都有不少这样的实践，比如 Compose 的 noLocalProviderFor() 函数：

private fun noLocalProvidedFor(name: String): Nothing {
  error("CompositionLocal $name not present")
}

拓展：其实 Nothing 的永不返回特性，除了抛异常之外，还有一种场景，就是无限循环：

fun foreverRepeat(): Nothing {
  while (true) {
    ...
  }
}

不过一般很少有人这么去用，大部分都是用在抛异常的场景

3.作用二：作为泛型对象的临时空白填充

另外 Nothing 除了「没有可用的实例」之外，还有个特性：它是所有类型共同的子类型。

不过，这个特性又有什么作用呢？它就能让你对于任何变量的赋值，都可以在等号右边写一个 Nothing

val nothing: Nothing = ???
var apple: Apple = nothing

这儿其实有个问题：前面刚说了 Nothing 不会有任何的实例，对吧？那么这个右边就算能填 Nothing 类型的对象，可是这个对象我用谁啊？谁也没法用。

但是如果不直接用 Nothing，而是把它作为泛型类型的实例化参数。一个元素类型为Nothing 的 List，将会导致我无法找到任何的元素实例来填充进去，但是这个 emptyList 本身是可以被创建的：

val emptyList: List<Nothing> = listOf()
var apples: List<Apple> = emptyList

结合上我们刚说的「Nothing 是所有类型的子类型」这个特性，我们是不是可以把这个空的 List 赋值给任何的 List 变量？（这里实际上用到了协变的知识）

val emptyList: List<Nothing> = listOf()
var apples: List<Apple> = emptyList
var users: List<User> = emptyList
var phones: List<Phone> = emptyList
var images: List<Image> = emptyList

这样，是不是就提供了一个通用的空 List 出来，让这一个对象可以用于所有 List 的初始化。有什么好处？既省事，又省内存，这就是好处。

这种用法不只可以用在 List，Set 和 Map 也都没问题：

val emptySet: Set<Nothing> = setOf()
var apples: Set<Apple> = emptySet
var users: Set<User> = emptySet
var phones: Set<Phone> = emptySet
var images: Set<Image> = emptySet

val emptyMap: Map<String, Nothing> = emptyMap()
var apples: Map<String, Apple> = emptyMap
var users: Map<String, User> = emptyMap
var phones: Map<String, Phone> = emptyMap
var images: Map<String, Image> = emptyMap

而且也不限于集合类型，只要是泛型都可以，你自定义的也行：

val emptyProducer: Producer<Nothing> = Producer()
var appleProducer: Producer<Apple> = emptyProducer
var userProducer: Producer<User> = emptyProducer
var phoneProducer: Producer<Phone> = emptyProducer
var imageProducer: Producer<Image> = emptyProducer

它的核心在于，你利用 Nothing 可以创建出一个通用的「空白」对象，它什么实质内容也没有，什么实质工作也做不了，但可以用来作为泛型变量的一个通用的空白占位值。

4.作用三：语法的完整化

另外，Nothing 的「是所有类型的子类型」这个特点，还帮助了 Kotlin 语法的完整化。

在 Kotlin 的下层逻辑里，throw 这个关键字是有返回值的，它的返回值类型就是 Nothing。虽然说由于抛异常这件事已经跳出了程序的正常逻辑，所以 throw 返回不返回值、返回值类型是不是 Nothing 对于它本身都不重要，但它让这种写法成为了合法的：

val nothing: Nothing = throw RuntimeException("抛异常！")

并且因为 Nothing 是所有类型的子类型，所以我们这么写也行：

val nothing: String = throw RuntimeException("抛异常！")

看起来没用是吧？如果我再把它改改，就有用了：

var _name: String? = null
val name: String = _name ?: throw NullPointerException("_name 在运行时不能为空！")

throw 的返回值是 Nothing，我们就可以把它写在等号的右边，在语法层面假装成一个值来使用，但其实目的是在例外情况时抛异常。虽然 throw 不会真正地返回，但这让语法层面变得完全说得通了，这也是 Nothing 的价值所在。

除了 throw 之外，单独的 return 也是被规定为返回 Nothing 的一个关键字，所以我也可以这么写：

fun sayMyName(first: String, second: String) {
  val name = if (first == "Walter" && second == "White") {
    "Heisenberg"
  } else {
    return // 语法层面的返回值类型为 Nothing，赋值给 name
  }
  println(name)
}