2024/7/25

【Kotlin/Android】LifecycleObserverの使い方！ライフサイクルに処理を依存させる

この記事からわかること

Android Studio/KotlinのLifecycleObserverの使い方
ライフサイクルに特定の処理を依存させる方法
onCreate()、onStart()、onAttach、onPause()、onStop()、onDestroy()の違いと処理

index

[open]

LifecycleObserver
DefaultLifecycleObserver
Activityのライフサイクルを観測する
Fragmentのライフサイクルを観測する
LifecycleEventObserver

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

環境

Android Studio：Flamingo
Kotlin：1.8.20

LifecycleObserver

公式リファレンス：LifecycleObserver

KotlinのLifecycleObserverはLifecycleOwner(ActivityやFragmentなど)のライフサイクルの変化を観測し任意の処理を実行させることができるインターフェイスです。LifecycleObserverインターフェースを直接使用するのではなく継承したサブクラスであるDefaultLifecycleObserverまたはLifecycleEventObserverを継承したサブクラスを作成して使用します。

【Kotlin/Android Studio】Activityのライフサイクルの種類と役割

【Kotlin/Android Studio】Fragmentのライフサイクルの種類と役割

LifecycleObserverで観測対象にできるライフサイクルはonStartからonDestroyまでになります。

【Kotlin/Android Studio】Activityのライフサイクルの種類と役割

引用：公式リファレンス：The activity lifecycle

DefaultLifecycleObserver

DefaultLifecycleObserverを継承したサブクラスを作成
lifecycle.addObserverで追加する

ライフサイクルの変化を検知して任意の処理を実行するにはDefaultLifecycleObserverを継承してサブクラスを定義します。継承すると各ライフサイクルメソッドをoverrideできるのでその中に任意の処理を記述します。

class MyLifecycleObserver : DefaultLifecycleObserver {

    override fun onStart(owner: LifecycleOwner) {
        Log.d("Lifecycle" , "onStart")
    }
    override fun onResume(owner: LifecycleOwner) {
        Log.d("Lifecycle" , "onResume")
    }
    override fun onPause(owner: LifecycleOwner) {
        Log.d("Lifecycle" , "onPause")
    }
    override fun onStop(owner: LifecycleOwner) {
        Log.d("Lifecycle" , "onStop")
    }
    override fun onDestroy(owner: LifecycleOwner) {
        Log.d("Lifecycle" , "onDestroy")
    }
}

Activityのライフサイクルを観測する

Activityのライフサイクルを観測するにはonCreateの中でlifecycleにaddObserverメソッドを使用してクラスを渡します。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    lifecycle.addObserver(MyLifecycleObserver())
}

これで実装は完了であとはActivityのライフサイクルが変化するたびにMyLifecycleObserverの各メソッドの処理が呼ばれるようになります。

Fragmentのライフサイクルを観測する

Fragmentのライフサイクルを観測するにはActivityの時と同じようにonCreateの中でlifecycleにaddObserverメソッドを使用してクラスを渡します。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    lifecycle.addObserver(MyLifecycleObserver())
}

onViewCreatedの中でviewLifecycleOwner.lifecycle.addObserverで追加しても正常に動作しました。

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)

    viewLifecycleOwner.lifecycle.addObserver(MyLifecycleObserver())
}

LifecycleEventObserver

LifecycleEventObserverでも同じようにライフサイクルイベントの変化を検知して任意の処理を実行することができます。DefaultLifecycleObserverでは各ライフサイクルメソッドと同名のメソッドをoverrideすることで処理を実装していましたが、LifecycleEventObserverはonState Changeメソッド1つをoverrideしてその中でイベントを識別して処理を分岐します。

class MyLifecycleObserver : LifecycleEventObserver {
    override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
        when (event) {
            Lifecycle.Event.ON_CREATE -> Log.d("Lifecycle", "onCreate")
            Lifecycle.Event.ON_START -> Log.d("Lifecycle", "onStart")
            Lifecycle.Event.ON_RESUME -> Log.d("Lifecycle", "onResume")
            Lifecycle.Event.ON_PAUSE -> Log.d("Lifecycle", "onPause")
            Lifecycle.Event.ON_STOP -> Log.d("Lifecycle", "onStop")
            Lifecycle.Event.ON_DESTROY -> Log.d("Lifecycle", "onDestroy")
            else -> Log.d("Lifecycle", "OTHER_EVENT")
        }
    }
}