在2.2的代码中,GlobalScope是CoroutineScope的一个实例;launch是CoroutineScope的扩展函数,用来启动协程,扩展函数定义如下:
/**
- 启动一个新的协程,并把该协程以Job形式返回;
- 可通过Job的start()、cancle()、join()等方法控制该协程的执行;
- 接收三个参数
- @param context 协程上下文
- @param start 协程启动方式,默认值是CoroutineStart.DEFAULT
- @param block 需要被调用的挂起函数
- @return job 以Job形式返回新创建的协程
**/
public fun CoroutineScope.launch(
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> Unit
): Job {
val newContext = newCoroutineContext(context)
val coroutine = if (start.isLazy)
LazyStandaloneCoroutine(newContext, block) else
StandaloneCoroutine(newContext, active = true)
// 参数中传递的挂起函数,在这里被执行了
coroutine.start(start, coroutine, block)
return coroutine
}
下面分别分析CoroutineScope、CoroutineScope.launch()、CoroutineContext、CoroutineStart来介绍协程机制。
三、CoroutineScope
Coroutine Scope即协程作用域,是协程运行的作用范围;每个异步操作都在特定范围内运行。其定义如下:
/**
- CoroutineScope定义了协程作用范围;
- 通过CoroutineScope.launch或CoroutineScope.aync创建一个新的CoroutineScope并启动一个新的协程时,新的CoroutineScope会同时继承外部CoroutineScope的coroutineContext;
*/
public interface CoroutineScope {
public val coroutineContext: CoroutineContext
}
3.1 创建CoroutineScope
使用合适的CoroutineScope,并在合适的时机销毁,避免内存泄漏。例如在Activity销毁时取消CoroutineScope内的协程,避免内存泄漏;
创建CoroutineScope的方式:
(1)CoroutineScope();通用的CoroutineScope();
(2)MainScope();作用域为UI生命周期,默认调度器为Dispatchers.Main;如下所示:
class MyAndroidActivity {
private val scope = MainScope()
override fun onDestroy() {
super.onDestroy()
scope.cancel()
}
}
以下介绍常见的CoroutineScope及会创建CoroutineScope的场景:
3.2 GlobalScope
GlobalScope作用域中的协程在App启动后可一直执行至该协程执行结束或取消,常用来启动一些需要在application生命周期内运行且不能提前取消的顶级协程。
对于一些Activity或Fragment销毁后就不在需要执行的协程,不建议使用GlobalScope来启动。
3.3 CoroutineScope.launch
GlobalScope.launch {
Log.d(“CoroutineTag”, “GlobalScope”)
launch {
// 协程内的this即CoroutineScope
Log.d(“CoroutineTag”, “coroutineScope”)
}
}
通过CoroutineScope.launch的无参启动方式,会创建一个CoroutineScope,这个CoroutineScope继承了外面CoroutineScope的CoroutineContext。
3.4 CoroutineScope.aync
GlobalScope.launch {
Log.d(“CoroutineTag”, “GlobalScope”)
async {
// 协程内的this即CoroutineScope
Log.d(“CoroutineTag”, “coroutineScope”)
}
}
通过CoroutineScope.async的无参启动方式,会创建一个CoroutineScope,这个CoroutineScope继承了外面CoroutineScope的CoroutineContext。
CoroutineScope.async与CoroutineScope.launch的区别在于,async方式返回Deferred,可以获取协程的执行结果。
3.5 coroutineScope
在其他协程或挂起函数内,可通过coroutineScope来创建一个CoroutineScope,并且会立即执行coroutineScope{}内新建的协程,如下所示:
GlobalScope.launch {
Log.d(“CoroutineTag”, “GlobalScope”)
coroutineScope {
// 协程内的this即CoroutineScope
Log.d(“CoroutineTag”, “coroutineScope”)
}
}
coroutineScope是一个挂起挂起函数,所以只能在协程或挂起函数内调用:
public suspend fun coroutineScope(block: suspend CoroutineScope.() -> R): R {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
return suspendCoroutineUninterceptedOrReturn { uCont ->
val coroutine = ScopeCoroutine(uCont.context, uCont)
coroutine.startUndispatchedOrReturn(coroutine, block)
}
}
3.6 runBlocking
在线程、协程、挂起函数内,可通过runBlocking创建一个CoroutineScope,并且会立即执行runBlocking{}内新建的协程,如下所示:
GlobalScope.launch {
Log.d(“CoroutineTag”, “GlobalScope”)
runBlocking {
// 协程内的this即CoroutineScope
Log.d(“CoroutineTag”, “coroutineScope”)
}
}
与coroutineScope不同的是,runBlocking会阻塞当前线程;runBlocking是一个普通方法,所以runBlocking可以在线程中调用:
/**
- @param block 挂起函数,返回结果T就是协程的返回结果
*/
public fun runBlocking(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
val currentThread = Thread.currentThread()
val contextInterceptor = context[ContinuationInterceptor]
val eventLoop: EventLoop?
val newContext: CoroutineContext
if (contextInterceptor == null) {
// create or use private event loop if no dispatcher is specified
eventLoop = ThreadLocalEventLoop.eventLoop
newContext = GlobalScope.newCoroutineContext(context + eventLoop)
} else {
// See if context’s interceptor is an event loop that we shall use (to support TestContext)
// or take an existing thread-local event loop if present to avoid blocking it (but don’t create one)
eventLoop = (contextInterceptor as? EventLoop)?.takeIf { it.shouldBeProcessedFromContext() }
?: ThreadLocalEventLoop.currentOrNull()
newContext = GlobalScope.newCoroutineContext(context)
}
val coroutine = BlockingCoroutine(newContext, currentThread, eventLoop)
coroutine.start(CoroutineStart.DEFAULT, coroutine, block)
return coroutine.joinBlocking()
}
3.7 MVVM的CoroutineScope
对于MVVM架构,KTX提供了LifecycleOwner、LiveData、ViewModel对应的CoroutineScope;使用方法如下:
(1)添加依赖
dependencies {
// ViewModelScope
implementation “androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0”
// LifecycleScope
implementation “androidx.lifecycle:lifecycle-runtime-ktx:2.2.0”
// liveData
implementation “androidx.lifecycle:lifecycle-livedata-ktx:2.2.0”
}
(2)用法示例
// 1.viewModelScope
class MyViewModel: ViewModel() {
init {
viewModelScope.launch {
// Coroutine that will be canceled when the ViewModel is cleared.
}
}
}
// 2.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)
}
}
}
四、协程启动方式
coroutine builder协程的启动方式有几种:
4.1 CoroutineScope.launch
启动一个协程但不会阻塞调用线程,必须在协程作用域CoroutineScope中才能调用,返回Job表示该新建的协程。
public fun CoroutineScope.launch(
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> Unit
): Job {
val newContext = newCoroutineContext(context)
val coroutine = if (start.isLazy)
LazyStandaloneCoroutine(newContext, block) else
StandaloneCoroutine(newContext, active = true)
coroutine.start(start, coroutine, block)
return coroutine
}
4.2 CoroutineScope.async
启动一个协程但不会阻塞调用线程,必须在协程作用域CoroutineScope中才能调用。返回Deferred表示该新建的协程。Deferred是Job的子接口。
public fun CoroutineScope.async(
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> T
): Deferred {
val newContext = newCoroutineContext(context)
val coroutine = if (start.isLazy)
LazyDeferredCoroutine(newContext, block) else
DeferredCoroutine(newContext, active = true)
coroutine.start(start, coroutine, block)
return coroutine
}
CoroutineScope.async与CoroutineScope.launch的区别在于,async方式返回Deferred,可以获取协程的执行结果。
4.3 withContext
指定一个CoroutineContext,并启动一个协程,使用方式如下:
GlobalScope.launch {
withContext(Dispatchers.Default) {
}
withContext是一个挂起函数,只能在其他协程或挂起函数内调用:
public suspend fun withContext(
context: CoroutineContext,
block: suspend CoroutineScope.() -> T
): T {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
return suspendCoroutineUninterceptedOrReturn sc@ { uCont ->
// compute new context
val oldContext = uCont.context
val newContext = oldContext + context
// always check for cancellation of new context
newContext.checkCompletion()
// FAST PATH #1 – new context is the same as the old one
if (newContext === oldContext) {
val coroutine = ScopeCoroutine(newContext, uCont)
return@sc coroutine.startUndispatchedOrReturn(coroutine, block)
}
// FAST PATH #2 – the new dispatcher is the same as the old one (something else changed)
// equals
is used by design (see equals implementation is wrapper context like ExecutorCoroutineDispatcher)
if (newContext[ContinuationInterceptor] == oldContext[ContinuationInterceptor]) {
val coroutine = UndispatchedCoroutine(newContext, uCont)
// There are changes in the context, so this thread needs to be updated
withCoroutineContext(newContext, null) {
return@sc coroutine.startUndispatchedOrReturn(coroutine, block)
}
}
// SLOW PATH – use new dispatcher
val coroutine = DispatchedCoroutine(newContext, uCont)
coroutine.initParentJob()
block.startCoroutineCancellable(coroutine, coroutine)
coroutine.getResult()
}
}
4.4 coroutineScope{}
如3.2所示,coroutineScope{}会创建一个CoroutineScope{},并执行{}内新建的协程,不会阻塞当前线程。
4.5 runBlocking{}
启动一个新的协程并阻塞调用它的线程,会把挂起函数的结果作为协程的结果返回,常用来main方法和测试(所以Android开发中不常用)。
4.6 produce<> { }
启动一个新的协程,并生产一系列数据到channel中,这个协程返回ReceiveChannel,其他协程可从ReceiveChannel中接受数据。
五、CoroutineContext
5.1 定义
CoroutineContext是一系列元素的集合,主要的元素是代表协程的Job,此外还有协程的dispatcher等(Job、Dispatchers与CoroutineName都实现了Element接口)。 CoroutineScope封装了CoroutineContext:
public interface CoroutineScope {
public val coroutineContext: CoroutineContext
}
5.2 继承性
当通过CoroutineScope.launch启动一个新的协程时,新的CoroutineScope继承了外面的CoroutineContext,并且新的协程Job成为了父协程的子Job,这样当父Job取消时会递归取消子Job。
public fun CoroutineScope.launch(
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> Unit
): Job {
val newContext = newCoroutineContext(context)
val coroutine = if (start.isLazy)
LazyStandaloneCoroutine(newContext, block) else
StandaloneCoroutine(newContext, active = true)
coroutine.start(start, coroutine, block)
return coroutine
}
以下两种情况不会取消Job除外: (1)GlobalScope.launch启动的协程; (2)launch中传递了特定的父Job;
5.3 组合CoroutineContext
一些情况下,我们需要自定义CoroutineContext中的元素,可以使用+来组合CoroutineContext中的各个元素:
launch(Dispatchers.Default + CoroutineName(“test”)) {
println(“I’m working in thread ${Thread.currentThread().name}”)
}
六、CoroutineStart
6.1 CoroutineStart.DEFAULT
CoroutineScope.launch()方式创建协程的启动方式默认为CoroutineStart.DEFAULT,即立即执行。
6.2 CoroutineStart.LAZY
通过设置CoroutineStart.LAZY的协程不会立即执行,需要手动调用start()后才开始执行。可通过如下方式设置启动方式为CoroutineStart.LAZY:
val job = launch(start = CoroutineStart.LAZY) {
// …
}
// 手动调用start
job.start()
七、Job
CoroutineScope.launch 函数返回的是一个 Job 对象,代表一个异步的任务。可通过Job的start()、cancle()、join()等方法控制该协程的执行。
7.1 简单示例
val startTime = System.currentTimeMillis()
val job = launch(Dispatchers.Default) {
var nextPrintTime = startTime
var i = 0
while (isActive) { // cancellable computation loop
// print a message twice a second
if (System.currentTimeMillis() >= nextPrintTime) {
println(“job: I’m sleeping ${i++} …”)
nextPrintTime += 500L
}
}
}
delay(1300L) // delay a bit
println(“main: I’m tired of waiting!”)
job.cancelAndJoin() // cancels the job and waits for its completion
输出结果如下:
Hello
World!
Done
可见,等job执行完成后,才会继续输出"Done"。
7.2 获取Job
一个CoroutineContext中只有一个Job,可通过如下方式获取当前CoroutineContext中的Job:
println(“My job is ${coroutineContext[Job]}”)
输出结果是:
My job is “coroutine#1”:BlockingCoroutine{Active}@6d311334
7.3 Job状态
Job 具有生命周期并且可以取消。 Job 还可以有层级关系,一个Job可以包含多个子Job,当父Job被取消后,所有的子Job也会被自动取消;当子Job被取消或者出现异常后父Job也会被取消。
/**
- A background job.
-
Job实例化方法
- The most basic instances of
Job
interface are created like this: - (1)Coroutine job is created with [launch][CoroutineScope.launch] coroutine builder.
- It runs a specified block of code and completes on completion of this block.
- (2)CompletableJob is created with a
Job()
factory function. - It is completed by calling [CompletableJob.complete].
-
Job states Job状态
- A job has the following states:
- | State | [isActive] | [isCompleted] | [isCancelled] |
- | -------------------------------- | ---------- | ------------- | ------------- |
- | New (optional initial state) |
false
|false
|false
| - | Active (default initial state) |
true
|false
|false
| - | Completing (transient state) |
true
|false
|false
| - | Cancelling (transient state) |
false
|false
|true
| - | Cancelled (final state) |
false
|true
|true
| - | Completed (final state) |
false
|true
|false
|
*/
八、挂起函数
suspend修饰的函数叫挂起函数,只能在协程内部或者另一个挂起函数内调用,如下所示;
suspend fun doSomethingUsefulOne(): Int {
delay(1000L) // pretend we are doing something useful here
return 13
}
suspend fun doSomethingUsefulTwo(): Int {
delay(1000L) // pretend we are doing something useful here, too
return 29
}
8.1 顺序执行
挂起函数是顺序执行的,如下所示:
val time = measureTimeMillis {
val one = doSomethingUsefulOne()
val two = doSomethingUsefulTwo()
println(“The answer is ${one + two}”)
}
println(“Completed in $time ms”)
更多Android高级工程师进阶学习资料
进阶学习视频
附上:我们之前因为秋招收集的二十套一二线互联网公司Android面试真题(含BAT、小米、华为、美团、滴滴)和我自己整理Android复习笔记(包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。)
里面包含不同方向的自学编程路线、面试题集合/面经、及系列技术文章等,资源持续更新中…
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!
= doSomethingUsefulTwo()
println(“The answer is ${one + two}”)
}
println(“Completed in $time ms”)
更多Android高级工程师进阶学习资料
进阶学习视频
[外链图片转存中…(img-7AGsq6UU-1715717006045)]
附上:我们之前因为秋招收集的二十套一二线互联网公司Android面试真题(含BAT、小米、华为、美团、滴滴)和我自己整理Android复习笔记(包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。)
[外链图片转存中…(img-iCePS8Sf-1715717006049)]
里面包含不同方向的自学编程路线、面试题集合/面经、及系列技术文章等,资源持续更新中…
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!