使用Kotlin替代Java重構(gòu)AOSP應(yīng)用

兩年前，Android 開(kāi)源項(xiàng)目 （AOSP） 應(yīng)用團(tuán)隊(duì)開(kāi)始使用 Kotlin 替代 Java 重構(gòu) AOSP 應(yīng)用。之所以重構(gòu)主要有兩個(gè)原因： 一是確保 AOSP 應(yīng)用能夠遵循 Android 最佳實(shí)踐，另外則是提供優(yōu)先使用 Kotlin 進(jìn)行應(yīng)用開(kāi)發(fā)的良好范例。Kotlin 之所以具有強(qiáng)大的吸引力，原因之一是其簡(jiǎn)潔的語(yǔ)法，很多情況下用 Kotlin 編寫的代碼塊的代碼數(shù)量相比于功能相同的 Java 代碼塊要更少一些。此外，Kotlin 這種具有豐富表現(xiàn)力的編程語(yǔ)言還具有其他各種優(yōu)點(diǎn)，例如：

空安全： 這一概念可以說(shuō)是根植于 Kotlin 之中，從而幫助避免破壞性的空指針異常；

并發(fā)： 正如 Google I/O 2019 中關(guān)于 Android 的描述，結(jié)構(gòu)化并發(fā) （structured concurrency） 能夠允許使用協(xié)程簡(jiǎn)化后臺(tái)的任務(wù)管理；

兼容 Java： 尤其是在這次的重構(gòu)項(xiàng)目中，Kotlin 與 Java 語(yǔ)言的兼容性能夠讓我們一個(gè)文件一個(gè)文件地進(jìn)行 Kotlin 轉(zhuǎn)換。

Android 開(kāi)源項(xiàng)目 （AOSP） 應(yīng)用

https://android.googlesource.com/platform/packages/apps/

Kotlin

https://kotlinlang.org/

Google I/O 2019

https://developer.android.google.cn/kotlin/first

AOSP 團(tuán)隊(duì)在去年夏天發(fā)表了一篇文章，詳細(xì)介紹了 AOSP 桌面時(shí)鐘應(yīng)用的轉(zhuǎn)換過(guò)程。而今年，我們將 AOSP 日歷應(yīng)用從 Java 轉(zhuǎn)換成了 Kotlin。在這次轉(zhuǎn)換之前，應(yīng)用的代碼行數(shù)超過(guò) 18，000 行，在轉(zhuǎn)換后代碼庫(kù)減少了約 300 行。在這次的轉(zhuǎn)換中，我們沿襲了同 AOSP 桌面時(shí)鐘轉(zhuǎn)換過(guò)程中類似的技術(shù)，充分利用了 Kotlin 與 Java 語(yǔ)言的互操作性，對(duì)代碼文件一一進(jìn)行了轉(zhuǎn)換，并在過(guò)程中使用獨(dú)立的構(gòu)建目標(biāo)將 Java 代碼文件替換為對(duì)應(yīng)的 Kotlin 代碼文件。因?yàn)閳F(tuán)隊(duì)中有兩個(gè)人在進(jìn)行此項(xiàng)工作，所以我們?cè)?Android.bp 文件中為每個(gè)人創(chuàng)建了一個(gè) exclude_srcs 屬性，這樣兩個(gè)人就可以在減少代碼合并沖突的前提下，都能夠同時(shí)進(jìn)行重構(gòu)并推送代碼。此外，這樣還能允許我們進(jìn)行增量測(cè)試，快速定位錯(cuò)誤出現(xiàn)在哪些文件。

AOSP 桌面時(shí)鐘應(yīng)用的轉(zhuǎn)換過(guò)程

https://medium.com/androiddevelopers/re-writing-the-aosp-deskclock-app-in-kotlin-76c836370cb

在轉(zhuǎn)換任意給定的文件時(shí)，我們一開(kāi)始先使用 Android Studio Kotlin 插件中提供的從 Java 到 Kotlin 的自動(dòng)轉(zhuǎn)換工具。雖然該插件成功幫助我們轉(zhuǎn)換了大部份的代碼，但是還是會(huì)遇到一些問(wèn)題，需要開(kāi)發(fā)者手動(dòng)解決。需要手動(dòng)更改的部分，我們將會(huì)在本文接下來(lái)的章節(jié)中列出。

在將每個(gè)文件轉(zhuǎn)換為 Kotlin 之后，我們手動(dòng)測(cè)試了日歷應(yīng)用的 UI 界面，運(yùn)行了單元測(cè)試，并運(yùn)行了 Compatibility Test Suite （CTS） 的子集來(lái)進(jìn)行功能驗(yàn)證，以確保不需要再進(jìn)行任何的回歸測(cè)試。

Android Studio

https://developer.android.google.cn/studio

從 Java 到 Kotlin 的自動(dòng)轉(zhuǎn)換工具

https://developer.android.google.cn/kotlin/add-kotlin#convert

Compatibility Test Suite （CTS）

https://source.android.google.cn/compatibility/cts

自動(dòng)轉(zhuǎn)換之后的步驟

上面提到，在使用自動(dòng)轉(zhuǎn)換工具之后，有一些反復(fù)出現(xiàn)的問(wèn)題需要手動(dòng)定位解決。在 AOSP 桌面時(shí)鐘文章中，詳細(xì)介紹了其中遇到的一些問(wèn)題以及解決方法。如下列出了一些在進(jìn)行 AOSP 日歷轉(zhuǎn)換過(guò)程中遇到的問(wèn)題。

用 open 關(guān)鍵詞標(biāo)記父類

我們遇到的問(wèn)題之一是 Kotlin 父類和子類之間的相互調(diào)用。在 Kotlin 中，要將一個(gè)類標(biāo)記為可繼承，必須得在類的聲明中添加 open 關(guān)鍵字，對(duì)于父類中被子類覆蓋的方法也要這樣做。但是在 Java 中的繼承是不需要使用到 open 關(guān)鍵字的。由于 Kotlin 和 Java 能夠相互調(diào)用，這個(gè)問(wèn)題直到大部分代碼文件轉(zhuǎn)換到了 Kotlin 才出現(xiàn)。

例如，在下面的代碼片段中，聲明了一個(gè)繼承于 SimpleWeeksAdapter 的類：

class MonthByWeekAdapter（context： Context？， params： HashMap《String？， Int？》） ： SimpleWeeksAdapter（context as Context， params） {//方法體}

由于代碼文件的轉(zhuǎn)換過(guò)程是一次一個(gè)文件進(jìn)行的，即使是完全將 SimpleWeeksAdapter.kt 文件轉(zhuǎn)換成 Kotlin，也不會(huì)在其類的聲明中出現(xiàn) open 關(guān)鍵詞，這樣就會(huì)導(dǎo)致一個(gè)錯(cuò)誤。所以之后需要手動(dòng)進(jìn)行 open 關(guān)鍵詞的添加，以便讓 SimpleWeeksAdapter 類可以被繼承。這個(gè)特殊的類聲明如下所示：

open class SimpleWeeksAdapter（context： Context， params： HashMap《String？， Int？》？） {//方法體}

override 修飾符

同樣地，子類中覆蓋父類的方法也必須使用 override 修飾符來(lái)進(jìn)行標(biāo)記。在 Java 中，這是通過(guò) @Override 注解來(lái)實(shí)現(xiàn)的。然而，雖然在 Java 中有相應(yīng)的注解實(shí)現(xiàn)版本，但是自動(dòng)轉(zhuǎn)換過(guò)程中并沒(méi)有為 Kotlin 方法聲明中添加 override 修飾符。解決的辦法是在所有適當(dāng)?shù)牡胤绞謩?dòng)添加 override 修飾符。

覆寫父類中的屬性

在重構(gòu)過(guò)程中，我們還遇到了一個(gè)屬性覆寫的異常問(wèn)題，當(dāng)一個(gè)子類聲明了一個(gè)變量，而在父類中存在一個(gè)非私有的同名變量時(shí)，我們需要添加一個(gè) override 修飾符。然而，即使子類的變量同父類變量的類型不同，也仍然要添加 override 修飾符。在某些情況下，添加 override 仍不能解決問(wèn)題，尤其是當(dāng)子類的類型完全不同的時(shí)候。事實(shí)上，如果類型不匹配，在子類的變量前添加 override 修飾符，并在父類的變量前添加 open 關(guān)鍵字，會(huì)導(dǎo)致一個(gè)錯(cuò)誤：

type of *property name* doesn’t match the type of the overridden var-property

這個(gè)報(bào)錯(cuò)很讓人疑惑，因?yàn)樵?Java 中，以下代碼可以正常編譯：

public class Parent { int num = 0;}

class Child extends Parent { String num = “num”;}

而在 Kotlin 中相應(yīng)的代碼就會(huì)報(bào)上面提到的錯(cuò)誤：

class Parent { var num： Int = 0}

class Child ： Parent（） { var num： String = “num”}

這個(gè)問(wèn)題很有意思，目前我們通過(guò)在子類中對(duì)變量重命名來(lái)規(guī)避了這個(gè)沖突。上面的 Java 代碼會(huì)被 Android Studio 目前提供的代碼轉(zhuǎn)換器轉(zhuǎn)換為有問(wèn)題的 Kotlin 代碼，這甚至被報(bào)告為是一個(gè) bug 了。

被報(bào)告為是一個(gè) bug

https://youtrack.jetbrains.com/issue/KTIJ-8621

import 語(yǔ)句

在我們轉(zhuǎn)換的所有文件中，自動(dòng)轉(zhuǎn)換工具都傾向于將 Java 代碼中的所有 import 語(yǔ)句截?cái)酁?Kotlin 文件中的第一行。最開(kāi)始這導(dǎo)致了一些很讓人抓狂的錯(cuò)誤，編譯器會(huì)在整個(gè)代碼中報(bào) “unknown references” 的錯(cuò)誤。在意識(shí)到這個(gè)問(wèn)題后，我們開(kāi)始手動(dòng)地將 Java 中的 import 語(yǔ)句粘貼到 Kotlin 代碼文件中，并單獨(dú)對(duì)其進(jìn)行轉(zhuǎn)換。

暴露成員變量

默認(rèn)情況下，Kotlin 會(huì)自動(dòng)地為類中的實(shí)例變量生成 getter 和 setter 方法。然而，有些時(shí)候我們希望一個(gè)變量?jī)H僅只是一個(gè)簡(jiǎn)單的 Java 成員變量，這可以通過(guò)使用 @JvmField 注解來(lái)實(shí)現(xiàn)。

@JvmField 注解的作用是 “指示 Kotlin 編譯器不要為這個(gè)屬性生成 getter 和 setter 方法，并將其作為一個(gè)成員變量允許其被公開(kāi)訪問(wèn)”。這個(gè)注解在 CalendarData 類中特別有用，它包含了兩個(gè) static final 變量。通過(guò)對(duì)使用 val 聲明的只讀變量使用 @JvmField 注解，我們確保了這些變量可以作為成員變量被其他類訪問(wèn)，從而實(shí)現(xiàn)了 Java 和 Kotlin 之間的兼容性。

@JvmField 注解

https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-field/

CalendarData 類

https://android.googlesource.com/platform/packages/apps/Calendar/+/42e4b43133c4f866e0729438fb38bebc6d03b0a4/src/com/android/calendar/CalendarData.kt

val

https://kotlinlang.org/docs/basic-syntax.html#variables

對(duì)象中的靜態(tài)方法

在 Kotlin 對(duì)象中定義的函數(shù)必須使用 @JvmStatic 進(jìn)行標(biāo)記，以允許在 Java 代碼中通過(guò)方法名，而非實(shí)例化來(lái)對(duì)它們進(jìn)行調(diào)用。也就是說(shuō)，這個(gè)注解使其具有了類似 Java 的方法行為，即能夠通過(guò)類名調(diào)用方法。根據(jù) Kotlin 的文檔，“編譯器會(huì)為對(duì)象的外部類生成一個(gè)靜態(tài)方法，而對(duì)于對(duì)象本身會(huì)生成一個(gè)實(shí)例方法?！蔽覀?cè)?Utils 文件中遇到了這個(gè)問(wèn)題，當(dāng)完成轉(zhuǎn)換后，Java 類就變成了 Kotlin 對(duì)象。隨后，所有在對(duì)象中定義的方法都必須使用 @JvmStatic 標(biāo)記，這樣就允許在其他文件中使用 Utils.method（） 這樣的語(yǔ)法來(lái)進(jìn)行調(diào)用。值得一提的是，在類名和方法名之間使用 .INSTANCE （即 Utils.INSTANCE.method（）） 也是一種選擇，但是這不太符合常見(jiàn)的 Java 語(yǔ)法，需要改變所有對(duì) Java 靜態(tài)方法的調(diào)用。

Kotlin 的文檔

https://kotlinlang.org/docs/java-to-kotlin-interop.html#static-methods

Utils 文件

https://android.googlesource.com/platform/packages/apps/Calendar/+/42e4b43133c4f866e0729438fb38bebc6d03b0a4/src/com/android/calendar/Utils.kt

性能評(píng)估分析

所有的基準(zhǔn)測(cè)試都是在一臺(tái) 96 核、176 GiB 內(nèi)存的機(jī)器上進(jìn)行的。本項(xiàng)目中分析用到的主要指標(biāo)有所減少的代碼行數(shù)、目標(biāo) APK 的文件大小、構(gòu)建時(shí)間和首屏從啟動(dòng)到顯示的時(shí)間。在對(duì)上述每個(gè)因素進(jìn)行分析的同時(shí)，我們還收集了每個(gè)參數(shù)的數(shù)據(jù)并以表格的方式進(jìn)行了展示。

減少的代碼行數(shù)

從 Java 完全轉(zhuǎn)換到 Kotlin 后，代碼行數(shù)從 18，004 減少到了 17，729。這比原來(lái)的 Java 代碼量減少了大約 1.5%。雖然減少的代碼量并不可觀，但對(duì)于一些大型應(yīng)用來(lái)說(shuō)，這種轉(zhuǎn)換對(duì)于減少代碼行數(shù)的效果可能更為顯著，可參閱 AOSP 桌面時(shí)鐘文中所舉的例子。

AOSP 桌面時(shí)鐘https://medium.com/androiddevelopers/re-writing-the-aosp-deskclock-app-in-kotlin-76c836370cb

目標(biāo) APK 大小

使用 Kotlin 編寫的應(yīng)用 APK 大小是 2.7 MB，而使用 Java 編寫的應(yīng)用 APK 大小是 2.6 MB?？梢哉f(shuō)這個(gè)差異基本可以忽略不計(jì)了，由于包含了一些額外的 Kotlin 庫(kù)，所以 APK 體積上的增加，實(shí)際上是可以預(yù)期的。這種大小的增加可以通過(guò)使用 Proguard 或 R8 來(lái)進(jìn)行優(yōu)化。

Proguardhttps://developer.android.google.cn/studio/build/shrink-code

R8https://r8.googlesource.com/r8

編譯時(shí)間

Kotlin 和 Java 應(yīng)用的構(gòu)建時(shí)間是通過(guò)取 10 次從零進(jìn)行完整構(gòu)建的時(shí)間的平均值來(lái)計(jì)算的 （不包含異常值），Kotlin 應(yīng)用的平均構(gòu)建時(shí)間為 13 分 27 秒，而 Java 應(yīng)用的平均構(gòu)建時(shí)間為 12 分 6 秒。據(jù)一些資料 （如 “Java 和 Kotlin 的區(qū)別” 以及 “Kotlin 和 Java 在編譯時(shí)間上的對(duì)比”） 顯示，Kotlin 的編譯時(shí)間事實(shí)上比 Java 要更耗時(shí)，特別是對(duì)于從零開(kāi)始的構(gòu)建。一些分析斷言，Java 的編譯速度會(huì)快 10-15%，又有一些分析稱這一數(shù)據(jù)為 15-20%。拿我們的例子進(jìn)行從零開(kāi)始完整構(gòu)建所花費(fèi)的時(shí)間來(lái)說(shuō)，Java 的編譯速度比 Kotlin 快 11.2%，盡管這個(gè)微小的差異并不在上述范圍內(nèi)，但這有可能是因?yàn)?AOSP 日歷是一個(gè)相對(duì)較小的應(yīng)用，僅有 43 個(gè)類。盡管從零開(kāi)始的完整構(gòu)建比較慢，但是 Kotlin 仍然在其他方面占有優(yōu)勢(shì)，這些優(yōu)勢(shì)更應(yīng)該被考慮到。例如，Kotlin 相對(duì)于 Java，更簡(jiǎn)潔的語(yǔ)法通?？梢员ＷC較少的代碼量，這使得 Kotlin 代碼庫(kù)更易維護(hù)。此外，由于 Kotlin 是一種更為安全有效的編程語(yǔ)言，我們可以認(rèn)為完整構(gòu)建時(shí)間較慢的問(wèn)題可以忽略不計(jì)。

Java 和 Kotlin 的區(qū)別

https://www.educba.com/java-vs-kotlin/

Kotlin 和 Java 在編譯時(shí)間上的對(duì)比https://medium.com/keepsafe-engineering/kotlin-vs-java-compilation-speed-e6c174b39b5d

首屏顯示的時(shí)間

我們使用了這種方法來(lái)測(cè)試應(yīng)用從啟動(dòng)到完全顯示首屏所需要的時(shí)間，經(jīng)過(guò) 10 次試驗(yàn)后我們發(fā)現(xiàn)，使用 Kotlin 應(yīng)用的平均時(shí)間約為 197.7 毫秒，而 Java 的則為 194.9 毫秒。這些測(cè)試都是在 Pixel 3a XL 設(shè)備上進(jìn)行的。從這個(gè)測(cè)試結(jié)果可以得出結(jié)論，與 Kotlin 應(yīng)用相比，Java 應(yīng)用可能具有微小的優(yōu)勢(shì)；然而，由于平均時(shí)間非常接近，這個(gè)差異幾乎可以忽略不計(jì)。因此，可以說(shuō) AOSP 日歷應(yīng)用轉(zhuǎn)換到 Kotlin，并沒(méi)有對(duì)應(yīng)用的初始啟動(dòng)時(shí)間產(chǎn)生負(fù)面影響。

方法https://developer.android.google.cn/topic/performance/vitals/launch-time#time-initial

結(jié)論

將 AOSP 日歷應(yīng)用轉(zhuǎn)換為 Kotlin 大約花了 1.5 個(gè)月 （6 周） 的時(shí)間，由 2 名實(shí)習(xí)生負(fù)責(zé)該項(xiàng)目的實(shí)施。一旦我們對(duì)代碼庫(kù)更加熟悉并更加善于解決反復(fù)出現(xiàn)的編譯時(shí)、運(yùn)行時(shí)和語(yǔ)法問(wèn)題時(shí)，效率肯定會(huì)變得更高。總的來(lái)說(shuō)，這個(gè)特殊的項(xiàng)目成功地展示了 Kotlin 如何影響現(xiàn)有的 Android 應(yīng)用，并在對(duì) AOSP 應(yīng)用進(jìn)行轉(zhuǎn)換的路途中邁出了堅(jiān)實(shí)的一步。

歡迎您通過(guò)下方二維碼向我們提交反饋，或分享您喜歡的內(nèi)容、發(fā)現(xiàn)的問(wèn)題。您的反饋對(duì)我們非常重要，感謝您的支持！

責(zé)任編輯：haq