Android KTX   Android Jetpack 的一部分。

Android KTX 是一组 Kotlin 扩展，包含在 Android Jetpack 和其他 Android 库中。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 文件中：

AndroidX 模块

Android KTX 分为多个模块，每个模块包含一个或多个软件包。

您必须在应用的 build.gradle 文件中包含每个模块工件的依赖项。请记住在工件后附加版本号。您可以在本主题中每个工件的相应部分找到最新的版本号。

Android KTX 包含一个核心模块，它为常见框架 API 和多个特定领域扩展提供了 Kotlin 扩展。

除核心模块外，所有 KTX 模块工件都会替换您 build.gradle 文件中底层的 Java 依赖项。例如，您可以将 androidx.fragment:fragment 依赖项替换为 androidx.fragment:fragment-ktx。此语法有助于更好地管理版本控制，并且不会增加额外的依赖项声明要求。

核心 KTX

Core KTX 模块为属于 Android 框架一部分的常见库提供了扩展。这些库没有您需要添加到 build.gradle 的基于 Java 的依赖项。

要包含此模块，请将以下内容添加到您应用的 build.gradle 文件中：

以下是 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 文件中：

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 文件中：

借助 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 文件中：

以下示例演示了如何使用 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 文件中：

在以下示例中，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

导航库的每个组件都有其自己的 KTX 版本，用于调整 API，使其更简洁、更符合 Kotlin 习惯用法。

要包含这些模块，请将以下内容添加到您应用的 build.gradle 文件中：

使用扩展函数和属性委托来访问目标参数并导航到目标，如以下示例所示：

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 文件中：

例如，在使用 Palette 实例时，您可以使用 get 运算符 ([ ]) 检索给定 target 的 selected 色样：

val palette = Palette.from(bitmap).generate()
val swatch = palette[target]

Reactive Streams KTX

Reactive Streams KTX 模块允许您从 ReactiveStreams 发布者创建可观察的 LiveData 流。

要包含此模块，请将以下内容添加到您应用的 build.gradle 文件中：

例如，假设一个数据库中有一个小型用户列表。在您的应用中，您将数据库加载到内存中，然后在界面中显示用户数据。为此，您可以使用 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 文件中：

以下是 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 文件中：

以下是使用 transaction 扩展执行数据库事务的示例：

db.transaction {
    // insert data
}

ViewModel KTX

ViewModel KTX 库提供了一个 viewModelScope() 函数，使从 ViewModel 启动协程变得更容易。CoroutineScope 绑定到 Dispatchers.Main，并在 ViewModel 清除时自动取消。您可以改用 viewModelScope()，而无需为每个 ViewModel 创建新作用域。

要包含此模块，请将以下内容添加到您应用的 build.gradle 文件中：

例如，以下 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 文件中：

现在，您可以扩展 CoroutineWorker，而不是扩展 Worker，它具有略微不同的 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

某些 Firebase Android SDK 具有 Kotlin 扩展库，可让您在应用中使用 Firebase 时编写惯用的 Kotlin 代码。有关更多信息，请参阅以下主题：

• Firebase Android SDK
• Firebase Common Kotlin 扩展

Google Maps Platform KTX

Google Maps Platform Android SDK 提供了 KTX 扩展，可让您利用 Kotlin 的多项语言特性，例如扩展函数、具名参数和默认参数、解构声明和协程。有关更多信息，请参阅以下主题：

• Maps Android KTX
• Places Android KTX

Play Core KTX

Play Core KTX 通过在 Play Core 库中为 SplitInstallManager 和 AppUpdateManager 添加扩展函数，支持 Kotlin 协程进行一次性请求和 Flow 进行状态更新监控。

要包含此模块，请将以下内容添加到您应用的 build.gradle 文件中：

以下是状态监控 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()
    }
}

更多信息

要了解有关 Android KTX 的更多信息，请参阅 DevBytes 视频。

要报告问题或建议功能，请使用 Android KTX 问题跟踪器。