往期文章
《Kotlin Jetpack 实战:开篇》
《00. 写给 Java 开发者的 Kotlin 入坑指南》
《01. 从一个膜拜大神的 Demo 开始》
《02. 用 Kotlin 写 Gradle 脚本是一种什么体验?》
简介
本文假设各位已经有了 Kotlin 基础,对 Kotlin 还不熟悉的小伙伴可以去看我之前发的文章。
本文将带领各位用 Kotlin 一步步重构我们的 Demo 工程,顺便一窥Kotlin 编程的三重境界
。
说明:本系列文章都只探讨 Kotlin JVM,Kotlin JS/Native 都不在探讨范围内。
主要内容
前期准备
第一重境界:用 Java 视角写 Kotlin
第二重境界:用 Kotlin 视角写 Kotlin
第三重境界:用 Bytecode 视角写 Kotlin
结尾
前期准备
- 将 Android Studio 版本升级到最新
- 将我们的 Demo 工程 clone 到本地,用 Android Studio 打开:
github.com/chaxiu/Kotl… - 切换到分支:
chapter_03_kotlin_refactor_training
- 强烈建议各位小伙伴小伙伴跟着本文一起实战,实战才是本文的精髓
为工程添加 Kotlin 支持
上一章我们已经将 Groovy 改成了 Kotlin DSL,但工程本身还不支持我们用 Kotlin 写 Android App。所以我们还需要做一些配置:
Libs.kt
增加以下依赖常量:
1 | kotlin复制代码const val kotlinStdLib = "org.jetbrains.kotlin:kotlin-stdlib-jdk8:${Versions.kotlinVersion}" |
根目录下的 build.gradle.kt
新增:
1 | kotlin复制代码dependencies { |
app/build.gradle.kt
新增:
1 | kotlin复制代码plugins { |
注意事项:
纯 Kotlin 开发的话做以上配置就够,但如果有 Java 混合开发的话,最好加上以下编译器参数配置,防止出现兼容性问题:app/build.gradle.kt
新增:
1 | kotlin复制代码android { |
以上配置的作用,分别是:
- 配置 Java 编译器兼容 Java 1.8
- 配置 Kotlin 编译器以 Java 1.8 的规范生成字节码
以上修改的具体细节可以看我这个 GitHub Commit。
接下来我们进入正题,用 Kotlin 重构 Java 代码。
正文
我一直认为 Kotlin 是一门易学难精的语言:入门易,精通难。如果要为 Kotlin 程序员划分境界,我觉得可以划分三重境界。
1. 第一重境界:用 Java 视角写 Kotlin
这几乎是每个 Kotlin 程序员都会经历的境界(包括曾经的我)。我曾以为学会 Kotlin 的语法就能写好 Kotlin 代码,然而我只是把脑子里的 Java/C 代码用 Kotlin 语法翻译一遍写出来了而已。
接下来我就以第一重境界的”功力”,来重构我们的 Demo 工程。大家看看热闹就行,千万别学进脑子里啊。[狗头]
我现在假装自己是个新手,刚学会 Kotlin 语法。正所谓,柿子要挑软的捏,咱们重构代码当然也从最简单的开始。于是我找到 Demo 工程里的 User.java
,一咬牙,就你了:
1 | java复制代码public class User { |
一顿操作,我把这个 Java Bean 用 Kotlin 语法翻译成了这样:
1 | kotlin复制代码class User { |
我看着自己一行一行写出来的 Kotlin 代码,心里成就感满满。So easy![狗头]
为了让工程能够模拟 Kotlin/Java 混编,我们让 ImagePreviewActivity 继续维持 Java 状态,所以接下来就剩下 MainActivity.java 的重构了。我们先看 MainActivity 的 Java 代码。
1 | java复制代码public class MainActivity extends AppCompatActivity { |
一通操作,我把 MainActivity 重构成了这样:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
由于 MainActivity 重构成了 Kotlin,ImagePreviewActivity.java 需要对应做一些调整。原因是 Java 还不能很好的识别伴生对象。
修改前:
1 | java复制代码public class ImagePreviewActivity extends AppCompatActivity { |
修改后:
1 | java复制代码public class ImagePreviewActivity extends AppCompatActivity { |
小结
这个境界的特点是:一行 Kotlin 对应一行 Java,还不会运用 Kotlin 独有的特性。
以上修改的具体细节可以看我这个 GitHub Commit。
各位小伙伴千万别看到这里就走了啊,请看我下一个境界是怎么写(演)的。
2. 第二重境界:用 Kotlin 视角写 Kotlin
到第二重境界,我就是个成熟的 Kotlin 程序员了。我会用一些 Kotlin 独有特性去改善 Java 代码里的逻辑。
2-1 Data Class
我们还是从最简单的 User.kt 开始,看过《写给 Java 开发者的 Kotlin 入坑指南》的小伙伴一定知道 Data Class,我们来将 User.kt 重构成 Data Class,真的会省不少代码:
1 | kotlin复制代码data class User( |
小结
Data Class 可以节省我们编写 Java Bean 的时间。
2-2 lateinit
接下来看 MainActivity.kt,我们从最上面的变量开始。之前我们定义的变量都是可为空的
(Nullable),导致这些变量在使用的时候都需要判空,或者使用非空断言!!
。这很不Kotlin
。解决这个问题的办法很多,这里我先用 lateinit
来解决网络请求的两个变量。
修改前:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
修改后:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
小结
一般来说,我们定义不为空的变量需要在构造函数或者 init 代码块里赋值,这样编译器才不会报错。但很多时候我们的变量赋值并不能在以上情况下完成赋值,比如:findViewById。
lateinit
的作用是告诉编译器,我定义的这个不为空的变量,虽然目前没有对它赋值,但我在使用它之前,一定会对它赋值,肯定不为空,你不必报错。
2-3 Kotlin-Android-Extensions
KTX
是 Android 官方提供的一个 Gradle 插件,能够为开发者提供便利,它最著名的功能就是能够省掉 findViewById
。之前我们在工程里已经添加了这个插件,接下来直接使用就可以了。
直接将控件的申明和赋值都删掉,然后在调用的地方我们按 option + return
选择 import
:
修改前:
1 | kotlin复制代码private var image: ImageView? = null |
修改后:
1 | kotlin复制代码// 注意这里 |
小结
- KTX 提供的便利当然不止是替代 findViewById,后面我们慢慢讲
- KTX 提供便利的同时其实有一定
隐患
,我们后面再讲
2-4 Lambda
以下代码 Android Studio 会提示 Convert to lambda
我们只需要按 option + return
,Android Studio 就会帮我们重构。
修改前:
1 | kotlin复制代码... |
修改后:
1 | kotlin复制代码... |
小结
- Kotlin Lambda 要讲清楚能专门写一本书,本文暂时只管怎么用
- 在这里使用 Lambda 作为接口实现,最大的好处其实是提高了代码的
可读性
2-5 扩展函数
使用 Kotlin 的扩展函数能消灭一切 xxUtils.java。Kotlin 标准函数就已经为我们提供了相关扩展函数,帮助我们消灭 TextUtils
。
修改前:
1 | kotlin复制代码... |
修改后:
1 | kotlin复制代码... |
上面修改后的代码看起来像是 response
有一个成员方法: isNullOrBlank()
,这样做有很多好处:
- 写代码更流畅,一个类有哪些可以调用的方法,IDE 会自动提示,而不用去找 xxUtils
- 代码可读性更好
2-6 标准函数 apply
Kotlin 提供了一系列标准函数,比如: let, also, with, apply 帮助开发者简化逻辑。这里我们使用 apply,它的作用解释起来很麻烦,看代码更明了:
修改前:
1 | kotlin复制代码if (user != null) { |
修改后:
1 | kotlin复制代码user?.apply { |
小结
这个境界的特点是:
- 一行 Kotlin 代码能对应多行 Java 代码
- 代码可读性增强
- 代码健壮性更好
具体细节可以看这个 Github Commit。
第三重境界:用 Bytecode 视角写 Kotlin
Kotlin 号称 Java 100% 兼容,就是因为 Kotlin 最终会被编译成字节码
(Bytecode)。通过查看 Kotlin 编译后的字节码,我们既能了解 Kotlin 的原理,也能探索出一些 Kotlin 编程的 Tips。
受限于本文的篇幅,我们暂且不谈 Kotlin 的实现原理,也不去详细探讨 Kotlin 编程的 Tips。我们继续专注于实战。现阶段的项目中,我们已经尝试加入了一些 Kotlin 的特性,我们只研究现阶段用到的这些 Kotlin 特性。
3-1 如何查看 Kotlin 对应的 字节码?
Tools -> Kotlin -> Show Kotlin Bytecode
一般我们情况下我们只需要查看 Kotlin 等价的 Java 代码即可,因此我们可以在字节码弹窗的左上角找到 Decompile
按钮,这样就能看到 Kotlin 等价的 Java 代码了。
3-2 尽可能消灭可变性(Mutability)
Java 中被 final
修饰的变量一旦赋值后就无法被修改。这在 Java 中也是很好的习惯,我们在 Kotlin 中也应该沿用。Kotlin 没有 final
,但是有 val
。
我们还是先从 User.kt 开始。
1 | kotlin复制代码data class User( |
User.kt 反编译成 Java 后:
1 | java复制代码... |
我们将 User.kt 里面的 var
都替换成 val
:
1 | kotlin复制代码data class User( |
它反编译成 Java 代码变成了这样:
1 | java复制代码public final class User { |
小结:
- Kotlin 基于 JVM,所以从前 Java 的编程经验也是有用的
- 将 Data Class 的 var 改成 val 后,它的成员变量就有 final 修饰了,同时set 方法也没了,一个 Data Class 在被实例化后,就无法再被修改了
- 如果要修改 Data Class 的成员变量怎么办?用 copy 方法
3-3 尽可能缩小变量的作用域(Scope)
这一点在 Java 和 Kotlin 中同样有用。MainActivity.kt 中有两个成员变量,其中的 stringRequest
其实是可以改为局部变量的。
修改前:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
修改后:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
3-4 巧用 by lazy
MainActivity 只剩下一个成员变量 requestQueue
,它还是用的 var 修饰的,我们能不能把它改为 val 呢?当然可以,但我们需要借助 by lazy,委托。
修改后:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
让我们看看它等价的 Java 代码,它的初始化交给了 LazyKt.lazy
:
1 | java复制代码private final Lazy requestQueue$delegate = LazyKt.lazy((Function0)(new Function0() { |
再看看 LazyKt.lazy 的实现,实际上是 SynchronizedLazyImpl
:
1 | ktolin复制代码public actual fun <T> lazy(initializer: () -> T): Lazy<T> = SynchronizedLazyImpl(initializer) |
再看看 SynchronizedLazyImpl
:
1 | kotlin复制代码private class SynchronizedLazyImpl<out T>(initializer: () -> T, lock: Any? = null) : Lazy<T>, Serializable { |
果然,和我们之前文章提到的一样,by lazy 默认情况下会使用同步的方式进行初始化。但我们当前项目并不需要,毕竟多线程同步也是有开销的。
修改后:
1 | kotlin复制代码private val requestQueue: RequestQueue by lazy(LazyThreadSafetyMode.NONE) { |
3-5 不要用错伴生对象
由于 Java 无法识别 Kotlin 里面的伴生对象,所以我们在 Java 里访问的时候比较别扭。
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
在 Java 中访问:
1 | java复制代码public class ImagePreviewActivity extends AppCompatActivity { |
反编译后:
1 | java复制代码... |
我们可以看到,默认情况下,Kotlin 为伴生对象里的变量生成了 get 方法,Java 代码里要访问这个变量必须这样: MainActivity.Companion.getEXTRA_PHOTO()
,这很不友好。
为了让 Java 能够更好的识别伴生对象里的变量和方法,我们可以这么做:
使用 const:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
或者使用 @JvmField 注解:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
在 Java 中访问:
1 | java复制代码public class ImagePreviewActivity extends AppCompatActivity { |
以上两种情况反编译成 Java 的代码如下:
1 | java复制代码... |
不少博客讲伴生对象
到这里就结束了。@JvmField
,const
,@JvmStatic
,这些确实是使用伴生对象需要注意的。
可是,咱们的代码到这里是不是就完美了?并不。
我们可以看到,即使我们加上了 @JvmField
或者 const
,伴生对象仍然为常量生成了 get 方法,同时也定义了一个 Companion 的类,还有一个 instance。然而我们最初的需求只是要定义一个 public static final String
的常量而已。
这个小结的标题是不要用错伴生对象
。它的前提是什么?它的前提是:该不该用
。在这里我不禁要问一句:这种情况下,真的需要伴生对象吗?答案是:不需要。
MainActivity 中的 TAG
不需要在类以外被访问,因此可以直接定义为成员变量:
1 | kotlin复制代码class MainActivity : AppCompatActivity() { |
现在只剩下 EXTRA_PHOTO
,我们应该怎么处理?在 Java 中,我们经常会定义一个类来专门存放常量,Kotlin 中我们同样可以借鉴:
让我们创建一个 Constant.kt:
1 | kotlin复制代码//注意这里,它要放到 package 的前面 |
在 Kotlin 中可以直接这样使用:
1 | kotlin复制代码// Kotlin 中甚至可以省略掉 Constant,因为 CACHE_RESPONSE 是顶层常量。 |
在 Java 中要这样使用:
1 | java复制代码// 由于 @file:JvmName("Constant") 的存在,Java 中也能很好的访问 Constant.EXTRA_PHOTO |
Constant.kt
反编译成 Java 后是这样的:
1 | java复制代码public final class Constant { |
所以说,如果只是需要定义静态常量,哪用得上 Kotlin 的伴生对象?
以上修改的具体细节可以看我这个 Github Commit。
总结:
- Java 的编程经验在 Kotlin 中也是有用的,但我们又不能被 Java 里的经验禁锢
- Kotlin 中引入了 Java 所没有的特性和概念,我们在使用前最好能用清楚底层实现
- 网上博客写的
最佳实践
不一定对(包括本文),要独立思考
4. 结尾
本文只是借助我们的 Demo 一窥 Kotlin 编程的三重境界,让大家对 Kotlin 编程整体有个了解。后面我也许会写专题文章来讲《Kotlin 编译器漫游指南》,《Kotlin 最佳实践指北》,也许吧。
文章写到这已经接近尾声了,那我们的 Demo 工程改到这个程度是不是已经完美了呢?当然没有。但我不想写了,欢迎各位小伙伴留言一起讨论还有哪些地方能改进。
我们下一篇文章再见。
回目录–>《Kotlin Jetpack 实战》
本文转载自: 掘金