Androidでマルチモジュール
Androidでマルチモジュールを実践してみました。
サンプル
モジュールを作成
モジュールはAndroid Libraryとして作成します。
Android ライブラリの作成
こちらに詳しく説明されていますが、ここでは簡単な手順を記載します。
- File > New > New Module
- TemplateにAndroid Libraryを選択
- モジュール名・パッケージ名を入力
- [オプション]File > Project StructureでJava 11に変更
モジュールをアプリに追加する
作成したモジュールをアプリに追加するためには、app/build.gradleに依存関係を追加する方法とGUIを使う方法があります。
app/build.gradleに記載する方法
dependencies {
...
implementation(project(":module-name"))
}
GUIを使う方法
- File > Project Structure > Dependencies に移動します。
- ライブラリを使用するモジュールを選択します。ここでは
appとします。 - [Declared Dependencies] タブで+をクリックし、プルダウンから [Module Dependency] を選択します。
- [Add Module Dependency] ダイアログで、ライブラリ モジュールを選択します。
- 通常は[implementation] を選択し、[OK] をクリックします
app/build.gradleに依存が追加されます。
モジュール間での共通ライブラリのバージョン管理
androidx.core:core-ktxなどの一部のライブラリは全てのモジュール、もしくは幾つかのモジュールで使う場合があります。
今まではトップレベルのbuild.gradleでバージョンを管理していましたが、新しい機能のversionCatalogsを使用します。
こちらの記事で書いています。
全体的な構成
全体的な構成は以下のようにしました
- app: アプリ本体
- Feature1のみimportしています
- Infrastructureにはアクセスできません
- Feature1: 機能１のロジックとか
- Infrastructureのみimportしています
- Infrastructure: APIアクセス、DataStoreなど
アクセス修飾子について
モジュール分割をしていく中で、どのクラスを公開しどのクラスを非公開にするかを考えることがありました。
kotlinのデフォルトのアクセス修飾子を調べたところ、publicだったので、他のモジュールで公開したくないクラス等にはinternalかprivateを付けました。
つまづきポイント
APIリクエストからKotlin Flowへの変換
Kotlinには、LiveDataのような機能としてFlowがあります。今回、APIクライアントとしてRetrofitを使いましたが、Flowに変換する部分を書くのに時間がかかってしまいました。
解決策として、こちらの記事を参考にしました。
FlowからLiveDataへの変換
こちらの記事に書かれているように、ライブラリの追加が必要でした。
androidx.lifecycle:lifecycle-livedata-ktx
ViewModel内でcorutineを使うために
viewModelScopeは以下のライブラリにありました。
androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0
このように使っています。
fun listRepo(user: String) {
viewModelScope.launch {
feature1Logic.listRepos(user)
.collect {
_repos.postValue(it)
}
}
}
ViewModelの作成
ViewModelの初期化方法についても、少し前から変わっていました。
viewModels()のところがなかなか見つからなかったのですが、以下の２つのライブラリが必要でした。
androidx.activity:activity-ktx:1.4.0
androidx.activity:fragment-ktx:1.4.0
以下のように使用しています。
private val viewModel by viewModels<MainViewModel>()
Discussion