Android KTX 是包含在 Android Jetpack 及其他 Android 库中的一组 Kotlin 扩展程序。KTX 扩展程序可以为 Jetpack、Android 平台及其他 API 提供简洁的惯用 Kotlin 代码。为此，这些扩展程序利用了多种 Kotlin 语言功能，其中包括：
- 扩展函数
- 扩展属性
- Lambda
- 命名参数
- 参数默认值
- 协程
例如，使用 SharedPreferences 时，您必须先创建一个编辑器，然后才能对偏好设置数据进行修改。在完成修改后，您还必须应用或提交这些更改，如以下示例所示：
sharedPreferences
.edit() // create an Editor
.putBoolean("key", value)
.apply() // write to disk asynchronously
Kotlin lambda 非常适合此用例。它们可让您采用一种更简洁的方法，即在创建编辑器后传递要执行的代码块，让代码执行，然后让 SharedPreferences API 自动应用更改。
下面是一个 Android KTX Core 函数 SharedPreferences.edit 的示例，在本例中向 SharedPreferences 添加了一个 edit 函数。此函数将可选的 boolean 标志作为第一个参数，指示是否要提交或应用更改。此外，它还以 lambda 的形式接收要在 SharedPreferences 编辑器上执行的操作。
// SharedPreferences.edit extension function signature from Android KTX - Core
// inline fun SharedPreferences.edit(
// commit: Boolean = false,
// action: SharedPreferences.Editor.() -> Unit)
// Commit a new value asynchronously
sharedPreferences.edit { putBoolean("key", value) }
// Commit a new value synchronously
sharedPreferences.edit(commit = true) { putBoolean("key", value) }
调用方可以选择是否提交或应用更改。action lambda 本身是 SharedPreferences.Editor 上的一个匿名扩展函数，它返回 Unit，如其签名所指示。因此，在代码块内，可以直接在 SharedPreferences.Editor 上执行工作。
最后，SharedPreferences.edit() 签名包含 inline 关键字。此关键字向 Kotlin 编译器表明，每次使用函数时，它都应该为函数复制并粘贴（或内嵌）编译的字节码。这样可避免每次调用此函数时都为每个 action 实例化一个新类所产生的开销。
使用 lambda 传递代码、应用可以替换的合理默认值并使用 inline 扩展函数将这些行为添加到现有 API 中，这种模式是 Android KTX 库提供的典型增强功能。
在项目中使用 Android KTX
若要开始使用 Android KTX，请将以下依赖项添加到项目的 build.gradle 文件中：
repositories {
google()
}
AndroidX 模块
Android KTX 分为若干模块，每个模块包含一个或多个软件包。
您必须在应用的 build.gradle 文件中为每个模块工件添加一个依赖项。请务必在工件后面附上版本号。可以在本主题中每个工件的相应部分找到最新版本号。
Android KTX 包含一个核心模块，该模块可为通用框架 API 提供 Kotlin 扩展程序，而且还能提供一些领域专用的扩展程序。
除了核心模块之外，所有 KTX 模块工件都会替换 build.gradle 文件中的底层 Java 依赖项。例如，您可以将 androidx.fragment:fragment 依赖项替换为 androidx.fragment:fragment-ktx。此语法有助于更好地管理版本控制，而不会增加额外的依赖项声明要求。
Core KTX
Core KTX 模块为属于 Android 框架的通用库提供扩展程序。这些库没有您需要添加到 build.gradle 的基于 Java 的依赖项。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.core:core-ktx:1.13.1"
}
下面列出了 Core KTX 模块中包含的软件包：
- androidx.core.animation
- androidx.core.content
- androidx.core.content.res
- androidx.core.database
- androidx.core.database.sqlite
- androidx.core.graphics
- androidx.core.graphics.drawable
- androidx.core.location
- androidx.core.net
- androidx.core.os
- androidx.core.text
- androidx.core.transition
- androidx.core.util
- androidx.core.view
- androidx.core.widget
Collection KTX
Collection 扩展程序包含在 Android 的节省内存的集合库中使用的实用函数，包括 ArrayMap、LongSparseArray、LruCache 等等。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.collection:collection-ktx:1.3.0"
}
Collection 扩展程序利用 Kotlin 的运算符重载简化集合串联等操作，如以下示例所示：
// Combine 2 ArraySets into 1.
val combinedArraySet = arraySetOf(1, 2, 3) + arraySetOf(4, 5, 6)
// Combine with numbers to create a new sets.
val newArraySet = combinedArraySet + 7 + 8
Fragment KTX
Fragment KTX 模块提供了一系列扩展程序以简化 Fragment API。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.fragment:fragment-ktx:1.6.2"
}
借助 Fragment KTX 模块，可以使用 lambda 来简化 Fragment 事务，例如：
fragmentManager().commit {
addToBackStack("...")
setCustomAnimations(
R.anim.enter_anim,
R.anim.exit_anim)
add(fragment, "...")
}
还可以使用 viewModels 和 activityViewModels 属性委托在一行中绑定到 ViewModel：
// Get a reference to the ViewModel scoped to this Fragment
val viewModel by viewModels<MyViewModel>()
// Get a reference to the ViewModel scoped to its Activity
val viewModel by activityViewModels<MyViewModel>()
Lifecycle KTX
Lifecycle KTX 为每个 Lifecycle 对象定义一个 LifecycleScope。在此范围内启动的协程会在 Lifecycle 被销毁时取消。您可以使用 lifecycle.coroutineScope 或 lifecycleOwner.lifecycleScope 属性访问 Lifecycle 的 CoroutineScope。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.6.2"
}
以下示例演示了如何使用 lifecycleOwner.lifecycleScope 异步创建预计算文本：
class MyFragment: Fragment() {
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
viewLifecycleOwner.lifecycleScope.launch {
val params = TextViewCompat.getTextMetricsParams(textView)
val precomputedText = withContext(Dispatchers.Default) {
PrecomputedTextCompat.create(longTextContent, params)
}
TextViewCompat.setPrecomputedText(textView, precomputedText)
}
}
}
LiveData KTX
使用 LiveData 时，您可能需要异步计算值。例如，您可能需要检索用户的偏好设置并将其传送给界面。在这些情况下，LiveData KTX 可提供一个 liveData 构建器函数，该函数会调用 suspend 函数，并将结果作为 LiveData 对象传送。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.6.2"
}
在以下示例中，loadUser() 是在其他地方声明的 suspend 函数。 您可以使用 liveData 构建器函数异步调用 loadUser()，然后使用 emit() 来发出结果：
val user: LiveData<User> = liveData {
val data = database.loadUser() // loadUser is a suspend function.
emit(data)
}
如需详细了解如何将协程与 LiveData 一起使用，请参阅将 Kotlin 协程与架构组件一起使用。
Navigation KTX
Navigation 库的每个组件都有自己的 KTX 版本，用于调整 API 以使其更简洁且更符合 Kotlin 的语言习惯。
要添加这些模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.navigation:navigation-runtime-ktx:2.7.5"
implementation "androidx.navigation:navigation-fragment-ktx:2.7.5"
implementation "androidx.navigation:navigation-ui-ktx:2.7.5"
}
您可以使用扩展函数和属性委托来访问目标参数并导航到目标，如以下示例所示：
class MyDestination : Fragment() {
// Type-safe arguments are accessed from the bundle.
val args by navArgs<MyDestinationArgs>()
...
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
view.findViewById<Button>(R.id.next)
.setOnClickListener {
// Fragment extension added to retrieve a NavController from
// any destination.
findNavController().navigate(R.id.action_to_next_destination)
}
}
...
}
Palette KTX
Palette KTX 模块为使用调色板提供惯用的 Kotlin 支持。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.palette:palette-ktx:1.0.0"
}
例如，使用 Palette 实例时，可以使用 get 运算符 ([ ]) 来检索给定 target 的 selected 色样：
val palette = Palette.from(bitmap).generate()
val swatch = palette[target]
Reactive Streams KTX
利用 Reactive Streams KTX 模块可根据 ReactiveStreams 发布程序来创建可监测的 LiveData 流。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.lifecycle:lifecycle-reactivestreams-ktx:2.6.2"
}
例如，假设一个数据库只有很少的用户。在您的应用中，您将该数据库加载到内存中，然后在界面中显示用户数据。为此，您可以使用 RxJava。Room Jetpack 组件能以 Flowable 的形式检索用户列表。在这种情况下，您还必须在 Fragment 或 Activity 的整个生命周期内管理 Rx 发布程序订阅。
不过，借助 LiveDataReactiveStreams，您既可以利用 RxJava 及其丰富的运算符和工作安排功能，又可以享受 LiveData 的简便性，如以下示例所示：
val fun getUsersLiveData() : LiveData<List<User>> {
val users: Flowable<List<User>> = dao.findUsers()
return LiveDataReactiveStreams.fromPublisher(users)
}
Room KTX
Room 扩展程序增加了对数据库事务的协程支持。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.room:room-ktx:2.6.1"
}
下面是 Room 现在使用协程的几个示例。第一个示例使用 suspend 函数返回 User 对象列表，而第二个示例利用 Kotlin 的 Flow 异步返回 User 列表。注意，使用 Flow 时，您还会收到有关您正在查询的表中任何更改的通知。
@Query("SELECT * FROM Users")
suspend fun getUsers(): List<User>
@Query("SELECT * FROM Users")
fun getUsers(): Flow<List<User>>
SQLite KTX
SQLite 扩展程序将与 SQL 相关的代码封装在事务中，从而避免编写大量样板代码。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.sqlite:sqlite-ktx:2.4.0"
}
下面是一个使用 transaction 扩展程序执行数据库事务的示例：
db.transaction {
// insert data
}
ViewModel KTX
ViewModel KTX 库提供了一个 viewModelScope() 函数，可让您更轻松地从 ViewModel 启动协程。CoroutineScope 绑定到 Dispatchers.Main，并且会在清除 ViewModel 时自动取消。您可以使用 viewModelScope()，而无需为每个 ViewModel 创建一个新范围。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.2"
}
例如，以下 viewModelScope() 函数会启动一个协程，用于在后台线程中发出网络请求。该库会处理所有设置和相应的范围清除：
class MainViewModel : ViewModel() {
// Make a network request without blocking the UI thread
private fun makeNetworkRequest() {
// launch a coroutine in viewModelScope
viewModelScope.launch {
remoteApi.slowFetch()
...
}
}
// No need to override onCleared()
}
WorkManager KTX
WorkManager KTX 为协程提供一流的支持。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "androidx.work:work-runtime-ktx:2.9.0"
}
现在，您无需扩展 Worker，而可以扩展 CoroutineWorker，后者使用的 API 略有不同。例如，如果要构建一个简单的 CoroutineWorker 以执行某些网络操作，则需要执行以下操作：
class CoroutineDownloadWorker(context: Context, params: WorkerParameters)
: CoroutineWorker(context, params) {
override suspend fun doWork(): Result = coroutineScope {
val jobs = (0 until 100).map {
async {
downloadSynchronously("https://www.google.com")
}
}
// awaitAll will throw an exception if a download fails, which
// CoroutineWorker will treat as a failure
jobs.awaitAll()
Result.success()
}
}
如需详细了解如何使用 CoroutineWorker，请参阅在 CoroutineWorker 中进行线程处理。
此外，WorkManager KTX 还向 Operations 和 ListenableFutures 添加扩展函数以挂起当前协程。
下面是挂起 enqueue() 返回的 Operation 的示例：
// Inside of a coroutine...
// Run async operation and suspend until completed.
WorkManager.getInstance()
.beginWith(longWorkRequest)
.enqueue().await()
// Resume after work completes...
其他 KTX 模块
您还可以添加存在于 AndroidX 之外的其他 KTX 模块。
Firebase KTX
部分适用于 Android 的 Firebase SDK 具有 Kotlin 扩展库，可让您在应用中使用 Firebase 时编写惯用 Kotlin 代码。如需了解详情，请参阅以下主题：
Google Maps Platform KTX
有一些 KTX 扩展可用于 Google Maps Platform Android SDK，借助这些 KTX 扩展，您能够利用多种 Kotlin 语言功能（例如扩展函数、命名参数和默认参数），解构声明和协程。如需了解详情，请参阅以下主题：
Play Core KTX
Play Core KTX 通过向 Play Core 库中的 SplitInstallManager 和 AppUpdateManager 添加扩展函数，针对单发请求和用于监控状态更新的 Flow 添加了对 Kotlin 协程的支持。
要使用此模块，请将以下内容添加到应用的 build.gradle 文件中：
dependencies {
implementation "com.google.android.play:core-ktx:1.8.1"
}
以下是用于监控状态的 Flow 的示例：
// Inside of a coroutine...
// Request in-app update status updates.
manager.requestUpdateFlow().collect { updateResult ->
when (updateResult) {
is AppUpdateResult.Available -> TODO()
is AppUpdateResult.InProgress -> TODO()
is AppUpdateResult.Downloaded -> TODO()
AppUpdateResult.NotAvailable -> TODO()
}
}