kotlin协程学习
协程(coroutine)
- 什么是协程
协程是一种并发设计模式，您可以在 Android 平台上使用它来简化异步执行的代码。协程是在版本 1.3 中添加到 Kotlin 的，它基于来自其他语言的既定概念。【第一次听说协程是2013年，周围有人在搞Unity开发游戏，他们沟通的过程中常常提到协程，Unity引擎至今还很火，当时他们用的是c#语言，不过这个引擎还支持java script和Boo语言，跨平台比较厉害，自己做了mono来解释运行c#代码。扯远了】 - 为什么要用协程
在 Android 上，协程有助于管理长时间运行的任务，如果管理不当，这些任务可能会阻塞主线程并导致应用无响应。使用协程的专业开发者中有超过 50% 的人反映使用协程提高了工作效率。本主题介绍如何使用 Kotlin 协程解决以下问题，从而让您能够编写出更清晰、更简洁的应用代码。 - 如何用协程
内容在下面。【在学习线程的时候，系统中有主线程(ui线程)和异步线程之分，本来以为这两种线程有本质的区别，后来才知道其实没有区别，只不过是人为规定的，创建了ui的那个线程就被称为是主线程，一般是app进程运行后的第一个线程就是主线程。协程和线程还是有区别的。这是一篇使用协程进行网络请求的一个示例代码，讲解了基本的协程用法。】
特点
协程是我们在 Android 上进行异步编程的推荐解决方案。值得关注的特点包括：
- 轻量：您可以在单个线程上运行多个协程，因为协程支持挂起，不会使正在运行协程的线程阻塞。挂起比阻塞节省内存，且支持多个并行操作。
- 内存泄漏更少：使用结构化并发机制在一个作用域内执行多项操作。
- 内置取消支持：取消操作会自动在运行中的整个协程层次结构内传播。
- Jetpack 集成：许多 Jetpack 库都包含提供全面协程支持的扩展。某些库还提供自己的协程作用域，可供您用于结构化并发。
示例概览
根据应用架构指南，本主题中的示例会发出网络请求并将结果返回到主线程，然后应用可以在主线程上向用户显示结果。
具体而言，ViewModel 架构组件会在主线程上调用代码库层，以触发网络请求。本指南介绍了多种使用协程确保主线程畅通的解决方案。
ViewModel 包含一组可直接与协程配合使用的 KTX 扩展。这些扩展是 lifecycle-viewmodel-ktx 库，在本指南中有用到。
依赖项信息
如需在 Android 项目中使用协程，请将以下依赖项添加到应用的 build.gradle 文件中：
dependencies {
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
}
在后台线程中执行
如果在主线程上发出网络请求，则主线程会处于等待或阻塞状态，直到收到响应。由于线程处于阻塞状态，因此操作系统无法调用 onDraw()，这会导致应用冻结，并有可能导致弹出“应用无响应”(ANR) 对话框。为了提供更好的用户体验，我们在后台线程上执行此操作。
首先，我们来了解一下 Repository 类，看看它是如何发出网络请求的：
sealed class Result<out R> {
data class Success<out T>(val data: T) : Result<T>()
data class Error(val exception: Exception) : Result<Nothing>()
}
class LoginRepository(private val responseParser: LoginResponseParser) {
private const val loginUrl = "https://example.com/login"
// Function that makes the network request, blocking the current thread
fun makeLoginRequest(
jsonBody: String
): Result<LoginResponse> {
val url = URL(loginUrl)
(url.openConnection() as? HttpURLConnection)?.run {
requestMethod = "POST"
setRequestProperty("Content-Type", "application/json; utf-8")
setRequestProperty("Accept", "application/json")
doOutput = true
outputStream.write(jsonBody.toByteArray())
return Result.Success(responseParser.parse(inputStream))
}
return Result.Error(Exception("Cannot open HttpURLConnection"))
}
}
makeLoginRequest是同步的，并且会阻塞发起调用的线程。为了对网络请求的响应建模，我们创建了自己的Result类。
ViewModel会在用户点击（例如，点击按钮）时触发网络请求：
class LoginViewModel(
private val loginRepository: LoginRepository
): ViewModel() {
fun login(username: String, token: String) {
//json数据根据自己的实际情况适当修改
val jsonBody = "{ username: \"$username\", token: \"$token\"}"
loginRepository.makeLoginRequest(jsonBody)
}
}
使用上述代码，LoginViewModel 会在网络请求发出时阻塞界面线程。如需将执行操作移出主线程，最简单的方法是创建一个新的协程，然后在 I/O 线程上执行网络请求：
class LoginViewModel(
private val loginRepository: LoginRepository
): ViewModel() {
fun login(username: String, token: String) {
// Create a new coroutine to move the execution off the UI thread
viewModelScope.launch(Dispatchers.IO) {
val jsonBody = "{ username: \"$username\", token: \"$token\"}"
loginRepository.makeLoginRequest(jsonBody)
}
}
}
下面我们仔细分析一下 login 函数中的协程代码：
viewModelScope是预定义的CoroutineScope，包含在ViewModelKTX 扩展中。请注意，所有协程都必须在一个作用域内运行。一个CoroutineScope管理一个或多个相关的协程。launch是一个函数，用于创建协程并将其函数主体的执行分派给相应的调度程序。Dispatchers.IO指示此协程应在为 I/O 操作预留的线程上执行。
login 函数按以下方式执行：
- 应用从主线程上的 View 层调用 login 函数。
launch会创建一个新的协程，并且网络请求在为 I/O 操作预留的线程上独立发出。- 在该协程运行时，
login函数会继续执行，并可能在网络请求完成前返回。请注意，为简单起见，我们暂时忽略掉网络响应。
由于此协程通过 viewModelScope 启动，因此在 ViewModel 的作用域内执行。如果 ViewModel 因用户离开屏幕而被销毁，则 viewModelScope 会自动取消，且所有运行的协程也会被取消。
前面的示例存在的一个问题是，调用 makeLoginRequest 的任何项都需要记得将执行操作显式移出主线程。下面我们来看看如何修改 Repository 以解决这一问题。
使用协程确保主线程安全
如果函数不会在主线程上阻止界面更新，我们即将其视为是主线程安全的。makeLoginRequest 函数不是主线程安全的，因为从主线程调用 makeLoginRequest 确实会阻塞界面。可以使用协程库中的 withContext() 函数将协程的执行操作移至其他线程：
class LoginRepository(...) {
...
suspend fun makeLoginRequest(
jsonBody: String
): Result<LoginResponse> {
// Move the execution of the coroutine to the I/O dispatcher
return withContext(Dispatchers.IO) {
// Blocking network request code
// 网络请求代码略加修改，需要if else判断成功失败进行相应的返回
}
}
}
withContext(Dispatchers.IO) 将协程的执行操作移至一个 I/O 线程，这样一来，我们的调用函数便是主线程安全的，并且支持根据需要更新界面。
makeLoginRequest 还会用 suspend 关键字进行标记。Kotlin 利用此关键字强制从协程内调用函数。
注意：为更轻松地进行测试，我们建议将 Dispatchers 注入 Repository 层。如需了解详情，请参阅在 Android 上测试协程（这里有个视频链接，可以查看原文）
在以下示例中，协程是在 LoginViewModel 中创建的。由于 makeLoginRequest 将执行操作移出主线程，login 函数中的协程现在可以在主线程中执行：
class LoginViewModel(
private val loginRepository: LoginRepository
): ViewModel() {
fun login(username: String, token: String) {
// Create a new coroutine on the UI thread
viewModelScope.launch {
val jsonBody = "{ username: \"$username\", token: \"$token\"}"
// Make the network call and suspend execution until it finishes
val result = loginRepository.makeLoginRequest(jsonBody)
// Display result of the network request to the user
when (result) {
is Result.Success<LoginResponse> -> // Happy path
else -> // Show error in UI
}
}
}
}
请注意，此处仍需要协程，因为 makeLoginRequest是一个 suspend函数，而所有 suspend函数都必须在协程中执行。
此代码与前面的 login 示例的不同之处体现在以下几个方面：
launch不接受Dispatchers.IO参数。如果您未将Dispatcher传递至launch，则从viewModelScope启动的所有协程都会在主线程中运行。- 系统现在会处理网络请求的结果，以显示成功或失败界面。
login 函数现在按以下方式执行：
- 应用从主线程上的
View层调用login()函数。 launch在主线程上创建新协程，然后协程开始执行。- 在协程内，调用
loginRepository.makeLoginRequest()现在会挂起协程的进一步执行操作，直至makeLoginRequest()中的withContext块结束运行。 withContext块结束运行后，login()中的协程在主线程上恢复执行操作，并返回网络请求的结果。
注意：如需与 ViewModel 层中的 View 通信，请按照应用架构指南中的建议，使用 LiveData。遵循此模式时，ViewModel 中的代码会在主线程上执行，因此您可以直接调用 MutableLiveData 的 setValue() 函数。
处理异常
为了处理 Repository 层可能抛出的异常，请使用 Kotlin 对异常的内置支持。在以下示例中，我们使用的是 try-catch 块：
class LoginViewModel(
private val loginRepository: LoginRepository
): ViewModel() {
fun makeLoginRequest(username: String, token: String) {
viewModelScope.launch {
val jsonBody = "{ username: \"$username\", token: \"$token\"}"
val result = try {
loginRepository.makeLoginRequest(jsonBody)
} catch(e: Exception) {
Result.Error(Exception("Network request failed"))
}
when (result) {
is Result.Success<LoginResponse> -> // Happy path
else -> // Show error in UI
}
}
}
}
在此示例中，makeLoginRequest() 调用抛出的任何意外异常都会处理为界面错误。
内容来源：
https://developer.android.google.cn/kotlin/coroutines?hl=zh-cn
sealed class Result<out R> {
data class Success<out T>(val data: T) : Result<T>()
data class Error(val e: Exception) : Result<Nothing>()
}
在java中将inputstream读取转换为一个字符串，经常定义一个固定长度的byte[] buf=new byte[1024]数组，然后while((int len = inputStream.read(buf))!=-1)。伪代码。然而在kotlin中是不允许这样赋值再判断的，这时候怎么办呢？需要使用kotlin提供的作用域函数also或 apply都是可以的，为此纠结了半天。
class LoginResponseParser {
fun parse(inputStream: InputStream?): LoginResponse {
var sb = StringBuilder()
var buf = ByteArray(1024)
var len = 0
while (inputStream?.read(buf).also { len = it!! } != -1) {
// while (inputStream?.read(buf).apply { len = this!! } != -1) {
// println("len:$len")
sb.append(String(buf, 0, len))
}
val loginResponse = LoginResponse()
val toString = sb.toString()
loginResponse.result = toString
return loginResponse
}
}
import java.lang.Exception
import java.net.HttpURLConnection
import java.net.URL
private const val loginUrl = "https://example.com/login"
class LoginRepository(private val responseParser: LoginResponseParser) {
fun makeLoginRequest(jsonBody: String): Result<LoginResponse> {
val url = URL(loginUrl)
(url.openConnection() as? HttpURLConnection)?.run {
requestMethod = "POST"
setRequestProperty("Content-Type", "application/json; utf-8")
setRequestProperty("Accept", "application/json")
doOutput = true
outputStream.write(jsonBody.toByteArray())
return Result.Success(responseParser.parse(inputStream))
}
return Result.Error(Exception("Cannot open HttpURLConnection"))
}
}
class LoginResponse {
var result: String? = null
}