Dispatchers.Main.immediate ってなに？

Dispatchers.Main は MainCoroutineDispatcher です。

view plainprint?

1. package kotlinx.coroutines  
2. ...   
3.   
4. public actual object Dispatchers {  
5.     ...  
6.     @JvmStatic  
7.     public actual val Main: MainCoroutineDispatcher get() = MainDispatcherLoader.dispatcher  
8.     ...  
9. }  

package kotlinx.coroutines ... public actual object Dispatchers { ... @JvmStatic public actual val Main: MainCoroutineDispatcher get() = MainDispatcherLoader.dispatcher ... } Dispatchers.Main.immediate は MainCoroutineDispatcher に定義されており、Dispatchers.Main.immediate 自体も MainCoroutineDispatcher です。

view plainprint?

1. package kotlinx.coroutines  
2. ...   
3.   
4. public abstract class MainCoroutineDispatcher : CoroutineDispatcher() {  
5.     ...  
6.     public abstract val immediate: MainCoroutineDispatcher  
7.     ...  
8. }  

package kotlinx.coroutines ... public abstract class MainCoroutineDispatcher : CoroutineDispatcher() { ... public abstract val immediate: MainCoroutineDispatcher ... } kotlinx-coroutines-android では HandlerDispatcher が MainCoroutineDispatcher を継承し、

view plainprint?

1. package kotlinx.coroutines.android  
2. ...  
3. public sealed class HandlerDispatcher : MainCoroutineDispatcher(), Delay {  
4.     ...  
5.     public abstract override val immediate: HandlerDispatcher  
6. }  

package kotlinx.coroutines.android ... public sealed class HandlerDispatcher : MainCoroutineDispatcher(), Delay { ... public abstract override val immediate: HandlerDispatcher } HandlerContext が HandlerDispatcher を継承しています。

view plainprint?

1. package kotlinx.coroutines.android  
2. ...   
3.   
4. internal class HandlerContext private constructor(  
5.     private val handler: Handler,  
6.     private val name: String?,  
7.     private val invokeImmediately: Boolean  
8. ) : HandlerDispatcher(), Delay {  
9.     ...  
10.     @Volatile  
11.     private var _immediate: HandlerContext? = if (invokeImmediately) this else null  
12.   
13.     override val immediate: HandlerContext = _immediate ?:  
14.         HandlerContext(handler, name, true).also { _immediate = it }  
15.     
16.     override fun isDispatchNeeded(context: CoroutineContext): Boolean {  
17.         return !invokeImmediately || Looper.myLooper() != handler.looper  
18.     }  
19.     ...  
20. }  

package kotlinx.coroutines.android ... internal class HandlerContext private constructor( private val handler: Handler, private val name: String?, private val invokeImmediately: Boolean ) : HandlerDispatcher(), Delay { ... @Volatile private var _immediate: HandlerContext? = if (invokeImmediately) this else null override val immediate: HandlerContext = _immediate ?: HandlerContext(handler, name, true).also { _immediate = it } override fun isDispatchNeeded(context: CoroutineContext): Boolean { return !invokeImmediately || Looper.myLooper() != handler.looper } ... } HandlerContext では immediate にセットされる HandlerContext は invokeImmediately プロパティが true になる、ということがわかります。

invokeImmediately は isDispatchNeeded() で使われます。isDispatchNeeded() の実装をみると、invokeImmediately が false のときは常に isDispatchNeeded() が true を返すことがわかります。また Looper.myLooper() != handler.looper のときも isDispatchNeeded() が true を返すことがわかります。つまり、invokeImmediately が true かつ Looper.myLooper() == handler.looper のときだけ isDispatchNeeded() は false を返します。

このことから、immediate にセットされる HandlerContext では、Looper.myLooper() が handler.looper と同じだと isDispatchNeeded() が false を返すということがわかります。

isDispatchNeeded() は coroutine を dispatch メソッドで実行するべきかどうか判定するときに呼ばれます。デフォルトは true を返すようになっています。

view plainprint?

1. package kotlinx.coroutines  
2. ...   
3.   
4. public abstract class CoroutineDispatcher :  
5.     AbstractCoroutineContextElement(ContinuationInterceptor), ContinuationInterceptor {  
6.     ...  
7.     public open fun isDispatchNeeded(context: CoroutineContext): Boolean = true  
8.     ...  
9. }  

package kotlinx.coroutines ... public abstract class CoroutineDispatcher : AbstractCoroutineContextElement(ContinuationInterceptor), ContinuationInterceptor { ... public open fun isDispatchNeeded(context: CoroutineContext): Boolean = true ... }

つまり、（kotlinx-coroutines-android の） Dispatchers.Main.immediate はすでに UI スレッドにいる場合（現在の Looper.myLooper() が handler.looper と同じ場合）そのまますぐに実行される Dispatcher ということです。

例えば Dispatchers.Main を使った以下のコードだと

view plainprint?

1. class MainActivity : AppCompatActivity() {  
2.   
3.     override fun onCreate(savedInstanceState: Bundle?) {  
4.         super.onCreate(savedInstanceState)  
5.   
6.         CoroutineScope(Dispatchers.Main).launch {  
7.             println("1 : ${Thread.currentThread().name}")  
8.         }  
9.   
10.         println("2 : ${Thread.currentThread().name}")  
11.     }  
12. }  

class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) CoroutineScope(Dispatchers.Main).launch { println("1 : ${Thread.currentThread().name}") } println("2 : ${Thread.currentThread().name}") } } 出力は 2 が 1 より先になります。

view plainprint?

1. I/System.out: 2 : main  
2. I/System.out: 1 : main  

I/System.out: 2 : main I/System.out: 1 : main CoroutineScope の dispatcher を Dispatchers.Main.immediate に変えると

view plainprint?

1. class MainActivity : AppCompatActivity() {  
2.   
3.     override fun onCreate(savedInstanceState: Bundle?) {  
4.         super.onCreate(savedInstanceState)  
5.   
6.         CoroutineScope(Dispatchers.Main.immediate).launch {  
7.             println("1 : ${Thread.currentThread().name}")  
8.         }  
9.   
10.         println("2 : ${Thread.currentThread().name}")  
11.     }  
12. }  

class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) CoroutineScope(Dispatchers.Main.immediate).launch { println("1 : ${Thread.currentThread().name}") } println("2 : ${Thread.currentThread().name}") } } 1 が先に出力されるようになります。

view plainprint?

1. I/System.out: 1 : main  
2. I/System.out: 2 : main  

I/System.out: 1 : main I/System.out: 2 : main UI スレッドにいない場合はすぐには実行されず dispatch されます。

view plainprint?

1. class MainActivity : AppCompatActivity() {  
2.   
3.     override fun onCreate(savedInstanceState: Bundle?) {  
4.         super.onCreate(savedInstanceState)  
5.   
6.         CoroutineScope(Dispatchers.Default).launch {  
7.             println("3 : ${Thread.currentThread().name}")  
8.   
9.             CoroutineScope(Dispatchers.Main.immediate).launch {  
10.                 println("1 : ${Thread.currentThread().name}")  
11.             }  
12.   
13.             println("4 : ${Thread.currentThread().name}")  
14.         }  
15.   
16.         println("2 : ${Thread.currentThread().name}")  
17.     }  
18. }  

class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) CoroutineScope(Dispatchers.Default).launch { println("3 : ${Thread.currentThread().name}") CoroutineScope(Dispatchers.Main.immediate).launch { println("1 : ${Thread.currentThread().name}") } println("4 : ${Thread.currentThread().name}") } println("2 : ${Thread.currentThread().name}") } }

view plainprint?

1. I/System.out: 2 : main  
2. I/System.out: 3 : DefaultDispatcher-worker-2  
3. I/System.out: 4 : DefaultDispatcher-worker-2  
4. I/System.out: 1 : main  

I/System.out: 2 : main I/System.out: 3 : DefaultDispatcher-worker-2 I/System.out: 4 : DefaultDispatcher-worker-2 I/System.out: 1 : main

viewModelScope, lifecycleScope は dispatcher として Dispatchers.Main.immediate が指定されています。

view plainprint?

1. val LifecycleOwner.lifecycleScope: LifecycleCoroutineScope  
2.     get() = lifecycle.coroutineScope  
3.     
4. val Lifecycle.coroutineScope: LifecycleCoroutineScope  
5.     get() {  
6.         while (true) {  
7.             ...  
8.             val newScope = LifecycleCoroutineScopeImpl(  
9.                 this,  
10.                 SupervisorJob() + Dispatchers.Main.immediate  
11.             )  
12.             ...  
13.         }  
14.     }  

val LifecycleOwner.lifecycleScope: LifecycleCoroutineScope get() = lifecycle.coroutineScope val Lifecycle.coroutineScope: LifecycleCoroutineScope get() { while (true) { ... val newScope = LifecycleCoroutineScopeImpl( this, SupervisorJob() + Dispatchers.Main.immediate ) ... } }

view plainprint?

1. val ViewModel.viewModelScope: CoroutineScope  
2.         get() {  
3.             ...  
4.             return setTagIfAbsent(JOB_KEY,  
5.                 CloseableCoroutineScope(SupervisorJob() + Dispatchers.Main.immediate))  
6.         }  

val ViewModel.viewModelScope: CoroutineScope get() { ... return setTagIfAbsent(JOB_KEY, CloseableCoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)) }