Effective Java in Kotlin

Book reminder

Effective Java的第一条规则：开发者应该考虑用静态工厂方法而不是构造器。静态工厂方法指使用静态方法来生成类的实例。下面是 Java 中静态工厂方法使用示例：

Boolean trueBoolean = Boolean.valueOf(true);

String number = String.valueOf(12);

List<Integer> list = Arrays.asList(1, 2, 4);

静态工厂方法使用来改造构造器的有力方法，下面是一些使用静态工厂方法的好处：

与构造器不同，静态工厂方法是具名的。 方法名解释了实例是如何被创建的以及参数是什么。举个例子new ArrayList(3) 中 3 所代表的意思就不明确，你可以认为它是数组的第一个元素或者是数组的大小。换做是静态工厂方法 ArrayList.withSize(3), 表达的意思就非常明确。具名方法的一个好处是：它解释了参数的含义或者在某种程度上揭示了实例被创建的机制。另一个好处是解决了相同参数类型的构造方法之间的混淆。

与构造器不同，静态工厂方法并不是每次被调用都会创建新的实例。当我们使用静态工厂方法时可以使用缓存机制去优化实例的创建，从而提高实例创建的性能。同样我们可以定义类似Connectrions.createOrNull() 这样的方法，使其在 Connection 不能建立时返回 null

与构造器不同，静态工厂方法可以返回任一子类型。这一特性可以用来在不同情况下提供更合适的实例，帮助我们隐藏接口背后的真正实例。在 Kotlin 中所有的集合都隐藏在接口背后。比如listOf(1,2,3), 当运行在 Kotlin/JVM 平台时会返回 ArrayList，当运行在 Kotlin/JS 平台时会返回 JavaScript array （这两种类型都实现了 KotlinList 接口）。通常情况下我们要操作的是接口，隐藏在接口下的具体实现有时并不重要。简单地说，静态工厂方法可以返回超类型的任意子类型，甚至改变类型的某些实现。

减少了创建参数化类型实例的冗长。Kotlin 在某种程度上解决了这个问题，因为 Kotlin 有更好的类型推断。

Joshua Bloch 指出了静态工厂方法的一些缺点：

静态工厂方法不能被用于子类的构造。在子类的构造中需要使用超类的构造器，而我们并不能使用静态工厂方法去替代

静态工厂方法不容易和其他静态方法进行区分。比如valueOf, of, getInstance, newInstance, getType 和 newType， 这些都是很常见的静态工厂方法的命名。

直观的结论：当构造方法和实例本身结构具有很强的关联时应该使用构造器；反之，应该使用静态工厂方法

在 Kotlin 当中， Kotlin 改变了静态工厂方法的实现途径。

Companion factory method

Kotlin 中不允许静态方法，Java 中的静态工厂方法在 Kotlin 中通常被伴生工厂方法 (Companion factory method) 所取代。伴生工厂方法指被放入伴生对象中的工厂方法：

class MyList {

  //...

  companion object {

    funof(vararg i: Int){ /*...*/ }

  }

}

使用方法和静态工厂方法相同：

MyList.of(1,2,3,4)

实际上伴生对象是一个单例类，这就导致了伴生对象是可以继承其他类的。这样我们就可以实现多个通用的工厂方法然后给他们提供不同的类。Provider 类是一个轻量的用于依赖注入的类：

abstract class Provider<T> {

  var original: T? = null

  var mocked: T? = null

  abstract fun create(): T

  fun get(): T = mocked ?: original ?: create().apply { original = this }

  fun lazyGet(): Lazy<T> = lazy { get() }

}

对于不同的类，只需要提供特定的构造方法：

interfaceUserRepository{

fungetUser(): User

companionobject: Provider

{

overridefuncreate()= UserRepositoryImpl()

}

}

然后我们就可以使用 UserReposiroty.get() 来获取实例，或者使用 val user by UserRepository.lazyGet() 进行懒加载。另外还可以声明特定的实现用于测试或进行 Mock

UserRepository.mocked =object: UserRepository {/*...*/}

相比于 Java 来讲这是一个巨大的优势，在 Java 中静态工厂方法必须在每个类中手动实现。另外一种复用工厂方法的方式是通过接口代理 (interface delegation)，我们可以以如下的方式使用上述例子：

interface Dependency<T> {

  var mocked: T?

  fun get(): T

  fun lazyGet(): Lazy<T> = lazy { get() }

}

abstract class Provider<T>(val init: ()->T): Dependency<T> {

  var original: T? = null

  override var mocked: T? = null


  override fun get(): T = mocked ?: original ?: init()

          .apply { original = this }

}

interface UserRepository {

  fun getUser(): User

  companion object: Dependency<UserRepository> by Provider({

        UserRepositoryImpl()

  })

}

Extension factory method

将工厂方法放入伴生对象中的另一个好处是：我们可以定义伴生对象的扩展方法。因此我们可以给外部依赖来添加伴生工厂方法（前提是外部依赖定义了伴生对象）：

interfaceTool{

companionobject{ … }

}

fun Tool.Companion.createBigTool(…) : BigTool { … }

或者是具名的伴生对象

interfaceTool{

companionobjectFactory { … }

}

fun Tool.Factory.createBigTool(…) : BigTool { … }

Top-level function

在 Kotlin 中，使用顶层方法（Top-level functions）来取代伴生工厂方法也很常见，比如 listOf,setOf,mapOf。

库的设计者也经常提供顶层方法来创建实例。举个例子，Android 开发中，传统的方法是使用静态方法去创建

ActivityIntent:

// Java

classMainActivityextendsActivity{

staticIntentgetIntent(Context context){

returnnewIntent(context, MainActivity.class);

  }

}

在 kotlin Anko 库中，我们使用顶层方法 intentFor

intentFor<MainActivity>()

使用顶层方法的问题在于，公有的顶层方法是到处可以访问的，很容易就 “污染了” IDE 的智能提示。

尽管使用公有的顶层方法需要谨慎，对于一些小的经常需要创建的实例（比如 ListMap）使用顶层方法是一个很好的选择，因为 listOf(1,2,3) 要比 List.of(1,2,3) 更简单更具有可读性。

Fake constructor

构造器在 Kotlin 中的使用方式和顶层方法类似 (Kotlin 中不需要 new 关键字)：

classA()

val a = A()

构造器可以和顶层方法以一样的方式被引用：

val aReference = ::A

构造器和方法的唯一区别在于：构造器的首字母需要大写。这一事实被应用于很多地方甚至是 Kotlin 标准库。List 和 MutableList 是接口，他们并没有构造器，但是 Kotlin 的使用者们希望可以：

List(3) {"$it"} // sameaslistOf("0","1","2")

这就是为什么下面的方法出现在Collections.kt:

public inline fun<T>List(size: Int, init:(index: Int) -> T): List<T>= MutableList(size, init)

public inline fun<T>MutableList(size: Int, init:(index: Int) -> T): MutableList<T>{

vallist= ArrayList<T>(size)

repeat(size) {index->list.add(init(index)) }

returnlist

}

Fake constructors 看起来像是构造器，用法和表现也是构造器，然而很多开发者并没有意识到他们并不是构造器而是顶层方法。同时 Fake constructors 还具有静态工厂方法的优势：可以返回子类型，并不需要每次调用生成新的实例；同时没有构造器的种种限制。比如次构造器（secondary constructor）必须马上调用主构造器（primary constructor）或者超类的构造器。当我们使用 fake constructors 时还可以推迟构造器的使用：

fun ListView(config:Config) : ListView {

valitems= … // Here wereaditemsfrom config

returnListView(items) // Wecallactual constructor

}

Primary constructo

Kotlin 引入了主构造器（primary constructor）这一概念。一个 Kotlin 类中只能存在一个主构造器（Kotlin 中称类似 Java 中的构造器为次构造器）。主构造器中的参数可以在整个类的创建中使用：

classStudent(name: String, surname: String) {

valfullName ="$name$surname"

}

主构造器中的参数可以被直接定义为类的属性：

classStudent(val name:String, val surname:String) {

val fullName

get() ="$name $surname"

}

当主构造器包含默认参数时，重叠构造器（Telescoping Constructor）不再被需要。

Other ways to create an objec

Kotlin 中的工厂方法并不是 Kotlin 提升实例创建的唯一方式。下篇文章我们会讨论 Kotlin 是如何提升 builder pattern。举个例子，允许 DSL 出现在对象创建过程中：

val dialog = alertDialog {

title ="Hey, you!"

message ="You want to read more about Kotlin?"

setPositiveButton { makeMoreArticlesForReader() }

setNegativeButton { startBeingSad() }

}

Conclusion

在 Kotlin 中我们可以使用这些方式的同时，保留静态工厂方法的优点：

Companion factory method

Top-level function

Fake constructor

Extension factory method

通常在大多数情况下主构造器可以满足对象创建的需求，如果需要使用其他的方式创建对象，可以考虑上述的几种方式。

最后

一点题外话：

我们有《Android学习、面试；文档、视频资源免费获取》，可复制链接后用石墨文档 App 或小程序打开链接或者私信我资料领取。

https://shimo.im/docs/TG8PDh9D96WGTT8W

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 221,635评论 6赞 515
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 94,543评论 3赞 399
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 168,083评论 0赞 360
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 59,640评论 1赞 296
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 68,640评论 6赞 397
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 52,262评论 1赞 308
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,833评论 3赞 421
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,736评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 46,280评论 1赞 319
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,369评论 3赞 340
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,503评论 1赞 352
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 36,185评论 5赞 350
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,870评论 3赞 333
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,340评论 0赞 24
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,460评论 1赞 272
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,909评论 3赞 376
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 45,512评论 2赞 359