Androidはワンツーパンチ 三歩進んで二歩下がる

プログラミングやどうでもいい話

"Type mismatch: inferred type is MainActivity but LifecycleOwner was expected"コンパイルエラー対応(AndroidX, support libraly, gradleのtranstive推移的依存関係の解決)

※2019/05/10時点の状況です。
Googleの CodeLabsのAndroid Room with a View - Kotlinを写経した時に遭遇したエラーの覚書です。

実行した環境

参考サイト様

参考にさせていただきました。本当にありがとうございました!

発生した現象

AppCompatActivityを継承したクラス内でデータの変更をobserveするために下記のようなコードを書くとコンパイルエラーが発生しました。 observeメソッドのowner引数にthisを渡している箇所です。

書いたコード(Kotlin)

    wordViewModel.allWords.observe(this, Observer { words ->
        words?.let { adapter.setWords(it) }
    })

f:id:sakura_bird1:20190510004029p:plain:w400

エラーメッセージ

Type mismatch: inferred type is MainActivity but LifecycleOwner was expected

エラー発生時のbuild.gradle(Project)

buildscript {
    ext.kotlin_version = '1.3.21'
    repositories {
        google()
        jcenter()
        
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

ext {
    roomVersion = '2.1.0-alpha07'
    archLifecycleVersion = '2.1.0-alpha04'
    androidxArchVersion = '2.1.0-alpha02'
    coroutines = '1.2.1'
}

エラー発生時のbuild.gradle(Module:app)

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'

android {
    compileSdkVersion 28
    defaultConfig {
        applicationId "exam.com.sakurafish.room.roomwordsample"
        minSdkVersion 19
        targetSdkVersion 28
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    // Room components
    implementation "androidx.room:room-runtime:$rootProject.roomVersion"
    implementation "androidx.room:room-ktx:$rootProject.roomVersion"
    kapt "androidx.room:room-compiler:$rootProject.roomVersion"
    androidTestImplementation "androidx.room:room-testing:$rootProject.roomVersion"

    // Lifecycle components
    implementation "androidx.lifecycle:lifecycle-extensions:$rootProject.archLifecycleVersion"
    kapt "androidx.lifecycle:lifecycle-compiler:$rootProject.archLifecycleVersion"
    androidTestImplementation "androidx.arch.core:core-testing:$rootProject.androidxArchVersion"

    // ViewModel Kotlin support
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$rootProject.archLifecycleVersion"

    // Coroutines
    api "org.jetbrains.kotlinx:kotlinx-coroutines-core:$rootProject.coroutines"
    api "org.jetbrains.kotlinx:kotlinx-coroutines-android:$rootProject.coroutines"

    implementation 'androidx.recyclerview:recyclerview:1.1.0-alpha05'

    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    implementation 'androidx.appcompat:appcompat:1.0.2'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    implementation 'com.google.android.material:material:1.0.0'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test:runner:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
}

原因

原因:LifecycleOwnerを実装していないクラスを継承していたため(推移的依存関係が絡むので結構やっかい)

エラーメッセージにあるLifecycleOwnerを実装しているのは、実際にはAppCompatActivityの上流のComponentActivityになります。
このComponentActivityの含まれるライブラリのバージョンによってはLifecycleOwnerを実装していないため、このようなエラーメッセージが発生しました。
androidx.appcompat:appcompat:1.0.2となっている箇所のバージョンアップをするか、recyclerview:1.1.0-alpha05をimplementationしている箇所を削除すればコンパイルエラーは解決するのですが、原因がわかるまでややこしかったのでもう少し詳しく説明します。

androidx.core:core1.1.0-beta01がクセモノ?

エラーが発生した時のbuild.gradleのdependenciesではrecyclerview:1.1.0-alpha05をインストールするようにしている箇所があります。

 implementation 'androidx.recyclerview:recyclerview:1.1.0-alpha05'

これはandroidx.core:core1.1.0-beta01@aarを依存するライブラリにしています。
androidx.core:coreは他のところからも依存されていますが、recyclerviewが依存しているのが最新のため、gradleの推移的依存関係の管理により全てに適用してしまいます。
gradleの推移的依存関係の解決

このバージョンのソースコードを見ると、androidx.core.app.ComponentActivity内ではLifecycleOwnerはimplementsされていません。

とてもややこしいことに、androidx.appcompat:appcompat:1.0.2が参照している古いバージョンであるandroidx.core:core1.0.1ではLifecycleOwnerが実装されています。
実装していたりしていなかったりしてるのは何故なのかと疑問に思いました。

ComponentActivityが2つになっていた

ソースコードを眺めてみると、
appcompatのversion 1.0.0-alpha01からandroidx.core.app.ComponentActivityに新しいサブクラス、androidx.activity.ComponentActivityが出来たようです。
パッケージが変わっていますね。
FragmentActivityが新クラスを継承するようになったことから、androidx.core.app.ComponentActivityからLifecycleOwnerの実装が削除されました。
さらにandroidx.activity:activity1.0.0-alpha01@aarのようなライブラリが新しく作られて、新クラスはandroidx.core:coreからは分離されたようです。

appcompatが古かった

図であらわすとこのような感じです。
f:id:sakura_bird1:20190511234735p:plain:w500

androidx.appcompat:appcompat:1.0.2が古いため、androidx.activity.ComponentActivityを継承していないのにもかかわらず参照先ライブラリが新しくなっており既にLifecycleOwnerの実装が削除されていたというわけです。

本来androidx.appcompat:appcompat:1.0.2androidx.core:core:1.0.1に依存していたのがgradleの推移的依存関係の解決により、recyclerview:1.1.0-alpha05が依存するより新しいライブラリで上書きされてしまったのですね。

当エントリはサンプルコードを書いていましたので、バージョンに-alphaとか付いている安定バージョンではないものを使っています。
安定バージョンを使い、依存ライブラリ同士のバージョンをなるべく揃えるようにすれば、AndroidXでもこの状況はそんなに発生しないかなと思っています。

gradleの推移的依存関係の解決

ライブラリが依存しているライブラリが別のライブラリからも依存されていてさらに依存してしまう関係のことを推移的な依存関係といいます。
gradleでは競合してしまうライブラリはその中で一番最新のバージョンのものを強制的に適用することで推移的依存関係の解決を行っています。
参考サイト様がとてもわかりやすく説明してくださっています。

依存関係は以下のコマンドで表示できます。

 ./gradlew :app:dependencies

androidx.appcompat:appcompat:1.0.2が依存するandroidx.core:core:1.0.1が上書きされているのがわかります。
f:id:sakura_bird1:20190512003747p:plain:w400

自分で推移的依存関係の解決を行いたい時はこちらの参考サイト様が参考になりました。
GradleのResolutionStrategy – Kenji Abe – Medium

解決方法

方法1. appcompatを新しくする

     implementation 'androidx.appcompat:appcompat:1.1.0-alpha05'

recyclerviewに合わせてアップグレードします。
AndroidXのライブラリ同士のバージョンをなるべく揃えるようにします。

方法2. recyclerviewを削除する

 implementation 'androidx.recyclerview:recyclerview:1.1.0-alpha05'

の箇所を削除します。ついでに↓のappcompatも削除しても大丈夫です。

 implementation 'androidx.appcompat:appcompat:1.0.2'

削除しても大丈夫な理由はMaterial Components For Android にはRecyclerViewが最初から入っていたです。
新しいバージョンのライブラリを使いたいというときなどは、バージョンを指定して導入すればよいと思います。

Material Components For Android にはRecyclerViewが最初から入っていた

本エントリの主題からは外れますが、Material Componentsだけで色んなライブラリを含んでいるという話です。

'com.android.support:design'及び'com.google.android.material:material'のMVN Repository を見てみました。
2019/05/10時点の最新バージョンです。

Maven Repository: com.android.support » design » 28.0.0
https://mvnrepository.com/artifact/com.android.support/design/28.0.0

Maven Repository: com.google.android.material » material » 1.1.0-alpha06
https://mvnrepository.com/artifact/com.google.android.material/material/1.1.0-alpha06

recyclerview入っていますね。他にも
annotation, appcompat, cardview, coordinatorlayout, core, fragment, legacy-support-core-ui, legacy-support-core-utils, transition, vectordrawable, viewpager2が入っています。

以上です。