gitbook/朱涛 · Kotlin编程第一课/docs/475058.md
2022-09-03 22:05:03 +08:00

556 lines
26 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 05 | object关键字你到底有多少种用法
你好我是朱涛。这节课我们来学习Kotlin当中object关键字的三种语义以及它的具体使用场景。
在前面课程中我们学习了Kotlin语言的基础语法和面向对象相关的语法其中涵盖了很多不同类型的关键字。比如说fun关键字代表了定义函数class关键字代表了定义类这些都是一成不变的。但是今天我们要学习的object关键字却有三种迥然不同的语义分别可以定义
* 匿名内部类;
* 单例模式;
* 伴生对象。
之所以会出现这样的情况是因为Kotlin的设计者认为这三种语义本质上都是**在定义一个类的同时还创建了对象**。在这样的情况下与其分别定义三种不同的关键字还不如将它们统一成object关键字。
那么理解object关键字背后的统一语义对我们学习这个语法是极其关键的因为它才是这三种不同语义背后的共同点。通过这个统一语义我们可以在这三种语义之间建立联系形成知识体系。这样我们在后面的学习中才不会那么容易迷失也不会那么容易遗忘。
接下来,我们就一起来逐一探讨这三种情况吧。
## object匿名内部类
首先是object定义的匿名内部类。
Java当中其实也有匿名内部类的概念这里我们可以通过跟Java的对比来具体理解下Kotlin中对匿名内部类的定义。
在Java开发当中我们经常需要写类似这样的代码
```java
public interface OnClickListener {
void onClick(View v);
}
image.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
gotoPreview();
}
});
```
这就是典型的匿名内部类的写法View.OnClickListener是一个接口因此我们在创建它的时候必须**实现它内部没有实现的方法**。
类似地在Kotlin当中我们会使用object关键字来创建匿名内部类。同样在它的内部我们也必须要实现它内部未实现的方法。这种方式不仅可以用于创建接口的匿名内部类也可以创建抽象类的匿名内部类。
```plain
image.setOnClickListener(object: View.OnClickListener {
override fun onClick(v: View?) {
gotoPreview()
}
})
```
需要特殊说明的是当Kotlin的匿名内部类只有一个需要实现的方法时我们可以使用SAM转换最终使用Lambda表达式来简化它的写法。这个话题我们会留到第7讲再详细分析。
所以也就是说Java和Kotlin相同的地方就在于它们的接口与抽象类都不能直接创建实例。想要创建接口和抽象类的实例我们必须通过匿名内部类的方式。
不过在Kotlin中匿名内部类还有一个特殊之处就是我们在使用object定义匿名内部类的时候其实还可以**在继承一个抽象类的同时,来实现多个接口**。
我们看个具体的例子:
```plain
interface A {
fun funA()
}
interface B {
fun funB()
}
abstract class Man {
abstract fun findMan()
}
fun main() {
// 这个匿名内部类在继承了Man类的同时还实现了A、B两个接口
val item = object : Man(), A, B{
override fun funA() {
// do something
}
override fun funB() {
// do something
}
override fun findMan() {
// do something
}
}
}
```
让我们分析一下这段代码。接口A它内部有一个funA()方法接口B它内部有一个funB()方法抽象类Man它内部有一个抽象方法findMan()。
接着在main()函数当中我们使用object定义了一个匿名内部类。这个匿名内部类不仅继承了抽象类Man还同时实现了接口A、接口B。而这种写法在Java当中其实是不被支持的。
在日常的开发工作当中,我们有时会遇到这种情况:我们需要继承某个类,同时还要实现某些接口,为了达到这个目的,我们不得不定义一个内部类,然后给它取个名字。但这样的类,往往只会被用一次就再也没有其他作用了。
所以针对这种情况使用object的这种语法就正好合适。我们既不用再定义内部类也不用想着该怎么给这个类取名字因为用过一次后就不用再管了。
## object单例模式
接着我们再来了解下object定义的第二种语义也就是单例模式。
在Kotlin当中要实现[单例模式](https://zh.wikipedia.org/wiki/%E5%8D%95%E4%BE%8B%E6%A8%A1%E5%BC%8F)其实非常简单我们直接用object修饰类即可
```plain
object UserManager {
fun login() {}
}
```
从以上代码中我们可以发现当使用object以后就不必再写class关键字了。**我们只需要关注业务逻辑**至于这个单例模式到底是如何实现的我们交给Kotlin编译器就行了。这种便捷性在Java当中是不可想象的。要知道单例模式的实现在Java当中是会被当做面试题来考的而在Kotlin当中它已变得无比简单。
在[第3讲](https://time.geekbang.org/column/article/473529)里我带你学习过如何研究Kotlin的原理那么如果你想看看Kotlin编译器到底是如何实现单例模式的你也可以反编译看看对应的Java代码
```java
public final class UserManager {
public static final UserManager INSTANCE;
static {
UserManager var0 = new UserManager();
INSTANCE = var0;
}
private UserManager() {}
public final void login() {}
}
```
可以看到当我们使用object关键字定义单例类的时候Kotlin编译器会将其**转换成静态代码块的单例模式**。因为`static{}`代码块当中的代码由虚拟机保证它只会被执行一次因此它在保证了线程安全的前提下同时也保证我们的INSTANCE只会被初始化一次。
不过到这里,你或许就会发现,这种方式定义的单例模式,虽然具有简洁的优点,但同时也存在两个缺点。
* **不支持懒加载。**这个问题很容易解决,我们在后面会提到。
* **不支持传参构造单例。**举个例子在Android开发当中很多情况下我们都需要用到Context作为上下文。另外有的时候在单例创建时可能也需要Context才可以创建那么如果这时候单纯只有object创建的单例就无法满足需求了。
那么Kotlin当中有没有其他方式来实现单例模式呢答案当然是有的不过我们要先掌握object的第三种用法伴生对象。
## object伴生对象
我们都知道Kotlin当中没有static关键字所以我们没有办法直接定义静态方法和静态变量。不过Kotlin还是为我们提供了伴生对象来帮助实现静态方法和变量。
在正式讲解伴生对象之前我们先来看看object定义单例的一种特殊情况看看它是如何演变成“伴生对象”的
```plain
class Person {
object InnerSingleton {
fun foo() {}
}
}
```
可以看到,我们可以将单例定义到一个类的内部。这样,单例就跟外部类形成了一种嵌套的关系,而我们要使用它的话,可以直接这样写:
```plain
Person.InnerSingleton.foo()
```
以上的代码看起来foo()就像是静态方法一样。不过为了一探究竟我们可以看看Person类反编译成Java后是怎样的。
```plain
public final class Person {
public static final class InnerSingleton {
public static final Person.InnerSingleton INSTANCE;
public final void foo() {}
private InnerSingleton() {}
static {
Person.InnerSingleton var0 = new Person.InnerSingleton();
INSTANCE = var0;
}
}
}
```
可以看到foo()并不是静态方法它实际上是通过调用单例InnerSingleton的实例上的方法实现的
```plain
// Kotlin当中这样调用
Person.InnerSingleton.foo()
// 等价
// ↓ java 当中这样调用
Person.InnerSingleton.INSTANCE.foo()
```
这时候,你可能就会想:**要如何才能实现类似Java静态方法的代码呢**
其实很简单,我们可以使用“@JvmStatic”这个注解如以下代码所示
```plain
class Person {
object InnerSingleton {
@JvmStatic
fun foo() {}
}
}
```
所以这个时候如果你再反编译Person类你会发现foo()这个方法就变成了InnerSingleton类当中的一个静态方法了。
```plain
public final class Person {
public static final class InnerSingleton {
// 省略其他相同代码
public static final void foo() {}
}
}
```
这样一来对于foo()方法的调用不管是Kotlin还是Java它们的调用方式都会变成一样的
```plain
Person.InnerSingleton.foo()
```
看到这里如果你足够细心你一定会产生一个疑问上面的静态内部类“InnerSingleton”看起来有点多余我们平时在Java当中写的静态方法不应该是只有一个层级吗比如
```java
public class Person {
public static void foo() {}
}
// 调用的时候,只有一个层级
Person.foo()
```
那么在Kotlin当中有办法实现这样的静态方法吗
答案当然是有的我们只需要在前面例子当中的object关键字前面加一个**companion关键字**即可。
```plain
class Person {
// 改动在这里
// ↓
companion object InnerSingleton {
@JvmStatic
fun foo() {}
}
}
```
companion object在Kotlin当中就被称作伴生对象它其实是我们嵌套单例的一种特殊情况。也就是**在伴生对象的内部,如果存在“@JvmStatic”修饰的方法或属性它会被挪到伴生对象外部的类当中变成静态成员。**
```java
public final class Person {
public static final Person.InnerSingleton InnerSingleton = new Person.InnerSingleton((DefaultConstructorMarker)null);
// 注意这里
public static final void foo() {
InnerSingleton.foo();
}
public static final class InnerSingleton {
public final void foo() {}
private InnerSingleton() {}
public InnerSingleton(DefaultConstructorMarker $constructor_marker) {
this();
}
}
}
```
根据上面反编译后的代码我们可以看出来被挪到外部的静态方法foo()它最终还是调用了单例InnerSingleton的成员方法foo(),所以它只是做了一层转接而已。
到这里也许你已经明白object单例、伴生对象中间的演变关系了普通的object单例演变出了嵌套的单例嵌套的单例演变出了伴生对象。
你也可以换个说法:**嵌套单例是object单例的一种特殊情况伴生对象是嵌套单例的一种特殊情况。**
## 伴生对象的实战应用
前面我们已经使用object关键字实现了最简单的单例模式这种方式的缺点是不支持懒加载、不支持“getInstance()传递参数”。而借助Kotlin的伴生对象我们可以实现功能更加全面的单例模式。
不过,在使用伴生对象实现单例模式之前,我们需要先热热身,用它来实现工厂模式。下面,我就给你详细介绍一下。
### 工厂模式
所谓的[工厂模式](https://zh.wikipedia.org/wiki/%E5%B7%A5%E5%8E%82%E6%96%B9%E6%B3%95)就是指当我们想要统一管理一个类的创建时我们可以将这个类的构造函数声明成private然后用工厂模式来暴露一个统一的方法以供外部使用。Kotlin的伴生对象非常符合这样的使用场景
```plain
// 私有的构造函数,外部无法调用
// ↓
class User private constructor(name: String) {
companion object {
@JvmStatic
fun create(name: String): User? {
// 统一检查,比如敏感词过滤
return User(name)
}
}
}
```
在这个例子当中我们将User的构造函数声明成了private的这样外部的类就无法直接使用它的构造函数来创建实例了。与此同时我们通过伴生对象暴露出了一个create()方法。在这个create()方法当中,我们可以做一些统一的判断,比如敏感词过滤、判断用户的名称是否合法。
另外由于“伴生对象”本质上还是属于User的嵌套类伴生对象仍然还算是在User类的内部所以我们是可以在create()方法内部调用User的构造函数的。
这样,我们就通过“伴生对象”巧妙地实现了工厂模式。接下来,我们继续看看如何使用“伴生对象”来实现更加复杂的单例设计模式。
### 另外4种单例模式的写法
在前面我们已经学习了Kotlin当中最简单的单例模式也就是object关键字。同时我们也提到了这种方式虽然简洁但它也存在两大问题第一无法懒加载第二不支持传参。
那么Kotlin当中有没有既支持懒加载又支持传参的单例模式呢
答案当然是有的。接下来我们就来了解下Kotlin里功能更加全面的4种单例模式分别是懒加载委托单例模式、Double Check单例模式、抽象类模板单例以及接口单例模板。
**第一种写法:借助懒加载委托**
其实针对懒加载的问题我们在原有的代码基础上做一个非常小的改动就能优化也就是借助Kotlin提供的“委托”语法。
比如针对前面的单例代码我们在它内部的属性上使用by lazy将其包裹起来这样我们的单例就能得到一部分的懒加载效果。
```plain
object UserManager {
// 对外暴露的 user
val user by lazy { loadUser() }
private fun loadUser(): User {
// 从网络或者数据库加载数据
return User.create("tom")
}
fun login() {}
}
```
可以看到UserManager内部的user变量变成了懒加载只要user变量没有被使用过它就不会触发loadUser()的逻辑。
这其实是一种**简洁与性能的折中方案**。一个对象所占用的内存资源毕竟不大,绝大多数情况我们都可以接受。而从服务器去请求用户信息所消耗的资源更大,我们能够保证这个部分是懒加载的,就算是不错的结果了。
> **注意:**这里我们用到了by lazy它是Kotlin当中的“懒加载委托”语法。我们会在第9讲里详细介绍它。目前你只需要知道它可以保证懒加载的同时还能保证线程安全即可。
**第二种写法伴生对象Double Check**
我们直接看代码吧:
```plain
class UserManager private constructor(name: String) {
companion object {
@Volatile private var INSTANCE: UserManager? = null
fun getInstance(name: String): UserManager =
// 第一次判空
INSTANCE?: synchronized(this) {
// 第二次判空
INSTANCE?:UserManager(name).also { INSTANCE = it }
}
}
}
// 使用
UserManager.getInstance("Tom")
```
这种写法其实是借鉴于GitHub上的[Google官方Demo](https://github.com/android/architecture-components-samples/blob/master/BasicRxJavaSampleKotlin/app/src/main/java/com/example/android/observability/persistence/UsersDatabase.kt)它本质上就是Java的**Double Check**。
首先我们定义了一个伴生对象然后在它的内部定义了一个INSTANCE它是private的这样就保证了它无法直接被外部访问。同时它还被注解“@Volatile”修饰了这可以保证INSTANCE的可见性而getInstance()方法当中的synchronized保证了INSTANCE的原子性。因此这种方案还是线程安全的。
同时我们也能注意到初始化情况下INSTANCE是等于null的。这也就意味着只有在getInstance()方法被使用的情况下我们才会真正去加载用户数据。这样我们就实现了整个UserManager的懒加载而不是它内部的某个参数的懒加载。
另外由于我们可以在调用getInstance(name)方法的时候传入初始化参数,因此,这种方案也是支持传参的。
不过以上的实现方式仍然存在一个问题在实现了UserManager以后假设我们又有一个新的需求要实现PersonManager的单例这时候我们就需要重新写一次Double Check的逻辑。
```plain
class UserManager private constructor(name: String) {
companion object {
// 省略代码
}
}
class PersonManager private constructor(name: String) {
companion object {
@Volatile private var INSTANCE: PersonManager? = null
fun getInstance(name: String): PersonManager =
INSTANCE?: synchronized(this) {
INSTANCE?:PersonManager(name).also { INSTANCE = it }
}
}
}
```
可以看到不同的单例当中我们必须反复写Double Check的逻辑这是典型的坏代码。这种方式不仅很容易出错同时也不符合编程规则Dont Repeat Yourself
那么,有没有一种办法可以让我们复用这部分逻辑呢?答案当然是肯定的。
**第三种写法:抽象类模板**
我们来仔细分析下第二种写法的单例。其实很快就能发现它主要由两个部分组成第一部分是INSTANCE实例第二部分是getInstance()函数。
现在,我们要尝试对这种模式进行抽象。在面向对象的编程当中,我们主要有两种抽象手段,第一种是**类抽象模板**,第二种是**接口抽象模板**。
这两种思路都是可以实现的,我们先来试试**抽象类**的方式将单例当中通用的“INSTANCE实例”和“getInstance()函数”抽象到BaseSingleton当中来。
```plain
// ① ②
// ↓ ↓
abstract class BaseSingleton<in P, out T> {
@Volatile
private var instance: T? = null
// ③
// ↓
protected abstract fun creator(param: P): T
fun getInstance(param: P): T =
instance ?: synchronized(this) {
// ④
// ↓
instance ?: creator(param).also { instance = it }
}
}
```
在仔细分析每一处注释之前我们先来整体看一下上面的代码我们定义了一个抽象类BaseSingleton在这个抽象类当中我们把单例当中通用的“INSTANCE实例”和“getInstance()函数”放了进去。也就是说,我们把单例类当中的核心逻辑放到了抽象类当中去了。
现在我们再来看看上面的4处注释。
* 注释①abstract关键字代表了我们定义的BaseSingleton是一个抽象类。我们以后要实现单例类就只需要继承这个BaseSingleton即可。
* 注释②in P, out T是Kotlin当中的泛型P和T分别代表了getInstance()的参数类型和返回值类型。注意这里的P和T是在具体的单例子类当中才需要去实现的。如果你完全不知道泛型是什么东西可以先看看[泛型的介绍](https://zh.wikipedia.org/zh/%E6%B3%9B%E5%9E%8B%E7%BC%96%E7%A8%8B)我们在第10讲会详细介绍Kotlin泛型。
* 注释③creator(param: P): T是instance构造器它是一个抽象方法需要我们在具体的单例子类当中实现此方法。
* 注释④creator(param)是对instance构造器的调用。
这里我们就以前面的UserManager、PersonManager为例用抽象类模板的方式来实现单例看看代码会发生什么样的变化。
```plain
class PersonManager private constructor(name: String) {
// ① ②
// ↓ ↓
companion object : BaseSingleton<String, PersonManager>() {
// ③
// ↓
override fun creator(param: String): PersonManager = PersonManager(param)
}
}
class UserManager private constructor(name: String) {
companion object : BaseSingleton<String, UserManager>() {
override fun creator(param: String): UserManager = UserManager(param)
}
}
```
在仔细分析注释之前我们可以看到UserManager、PersonManager的代码已经很简洁了我们不必重复去写“INSTANCE实例”和“Double Check”这样的模板代码只需要简单继承BaseSingleton这个抽象类按照要求传入泛型参数、实现creator这个抽象方法即可。
下面我们来分析上面的3处注释。
* 注释①companion object : BaseSingleton由于伴生对象本质上还是嵌套类也就是说它仍然是一个类那么它就具备类的特性“继承其他的类”。因此我们让伴生对象继承BaseSingleton这个抽象类。
* 注释②String, PersonManager这是我们传入泛型的参数P、T对应的实际类型分别代表了creator()的“参数类型”和“返回值类型”。
* 注释③override fun creator我们在子类当中实现了creator()这个抽象方法。
至此我们就完成了单例的“抽象类模板”。通过这样的方式我们不仅将重复的代码都统一封装到了抽象类“BaseSingleton”当中还大大简化了单例的实现难度。
接下来,让我们对比着看看单例的“接口模板”。
**第四种写法:接口模板**
首先我需要重点强调,**这种方式是不被推荐的**这里提出这种写法是为了让你熟悉Kotlin接口的特性并且明白Kotlin接口虽然能做到这件事但它做得并不够好。
如果你理解了上面的“抽象类模板”,那么,接口的这种方式你应该也很容易就能想到:
```plain
interface ISingleton<P, T> {
// ①
var instance: T?
fun creator(param: P): T
fun getInstance(p: P): T =
instance ?: synchronized(this) {
instance ?: creator(p).also { instance = it }
}
}
```
可以看到接口模板的代码结构和抽象类的方式如出一辙。而我们之所以可以这么做也是因为Kotlin接口的两个特性**接口属性、接口方法默认实现**。在[第1讲](https://time.geekbang.org/column/article/472154)的时候我们提到过Kotlin当中的接口被增强了让它与抽象类越来越接近这个例子正好就可以说明这一点。抽象类能实现单例模板我们的接口也可以。
说实话,上面的接口单例模板看起来还是比较干净的,好像也挑不出什么大的毛病。但实际上,如果你看注释①的地方,你会发现:
* **instance无法使用private修饰**。这是接口特性规定的而这并不符合单例的规范。正常情况下的单例模式我们内部的instance必须是private的这是为了防止它被外部直接修改。
* **instance无法使用@Volatile修饰**。这也是受限于接口的特性,这会引发多线程同步的问题。
除了ISingleton接口有这样的问题我们在实现ISingleton接口的类当中也会有类似的问题。
```plain
class Singleton private constructor(name: String) {
companion object: ISingleton<String, Singleton> {
// ① ②
// ↓ ↓
@Volatile override var instance: Singleton? = null
override fun creator(param: String): Singleton = Singleton(param)
}
}
```
* 注释①:@Volatile这个注解虽然可以在实现的时候添加但**实现方**可能会忘记,这会导致隐患。
* 注释②我们在实现instance的时候仍然无法使用private来修饰。
因此综合来看,单例“接口模板”并不是一种合格的实现方式。
不过在研究这个接口模板的过程中我们又重温了Kotlin接口属性、接口方法默认实现这两个特性并且对这两个特性进行一次应用。与此同时我们也理解了接口模板存在的缺陷以及不被推荐的原因。
实际上从一个知识锚点着手我们用类似的方式也可以帮助自己理解Kotlin其他的新特性。而在这个时候我们会发现Kotlin语法之间并不是一些孤立的知识点而是存在一些关联的通过这种学习方式能帮助我们快速建立起知识体系这其实也是保持学习与思考连贯性的好办法。
## 小结
这节课我们学习了object的三种语义分别是匿名内部类、单例、伴生对象。
![图片](https://static001.geekbang.org/resource/image/cc/67/cc75cc62f08d1b4f2e604630499f8b67.jpg?wh=1920x1260)
Kotlin的匿名内部类和Java的类似只不过它多了一个功能匿名内部类可以在继承一个抽象类的同时还实现多个接口。
另外object的单例和伴生对象这两种语义从表面上看是没有任何联系的。但通过这节课的学习我们发现了单例与伴生对象之间是存在某种演变关系的。**“单例”演变出了“嵌套单例”,而“嵌套单例”演变出了“伴生对象”。**
然后我们也借助Kotlin伴生对象这个语法研究了伴生对象的实战应用比如可以实现工厂模式、懒加载+带参数的单例模式。
尤其是单例模式这节课中我们一共提出了Kotlin当中5种单例模式的写法。除了最后一种“接口模板”的方式是为了学习研究不被推荐使用以外其他4种单例模式都是有一定使用场景的。这4种单例之间各有优劣我们可以在工作中根据实际需求来选择对应的实现方式
* 如果我们的单例占用内存很小并且对内存不敏感不需要传参直接使用object定义的单例即可。
* 如果我们的单例占用内存很小不需要传参但它内部的属性会触发消耗资源的网络请求和数据库查询我们可以使用object搭配by lazy懒加载。
* 如果我们的工程很简单只有一两个单例场景同时我们有懒加载需求并且getInstance()需要传参我们可以直接手写Double Check。
* 如果我们的工程规模大对内存敏感单例场景比较多那我们就很有必要使用抽象类模板BaseSingleton了。
## 思考题
这节课当中我们提到的BaseSingleton是否还有改进的空间这个问题会在第7讲“高阶函数”里做出解答。
欢迎你在评论区分享你的思路,我们下节课再见。