Hiltの応用的なインジェクションとモジュール利用

一歩進んだAndroidアプリ開発ができる「Android Jetpack」入門 第18回

　本連載は、「Android Studio2で始めるアプリ開発入門」連載、および『Androidアプリ開発の教科書』の続編にあたる内容として、Jetpackを取り上げていきます。前回は、Hiltによる依存性注入（DI）の基礎を紹介しました。今回は、いよいよ最終回です。Hiltによる応用的なインジェクションの方法、およびモジュールの利用方法を紹介します。

インジェクションの別パターン

　本連載は、Android Jetpackを紹介しています。長らく続いた本連載も、今回が最終回です。

　前回、HiltによるDIの方法としてコンストラクタインジェクションを紹介しました。そのコンストラクタインジェクションが、HiltによるDIの基本です。

　今回は、この基本では対応できないパターンを2個紹介することから始めていきます。

　なお、今回のサンプルデータはGitHubから参照できます。

フィールドインジェクション

　まず、コンストラクタを独自定義できないクラスの場合についてです。アクティビティはその典型です。そこで、前回の図1のパターンからは外れますが、アクティビティからリポジトリを直接利用する場合のインジェクションのコードを紹介します。

　これは、Javaではリスト1、Kotlinではリスト2のコードとなります。

［リスト1］MainActivity.java

@AndroidEntryPoint
public class MainActivity extends AppCompatActivity {
  @Inject
  MemoRepository _memoRepository;
    :
}

［リスト2］MainActivity.kt

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
  @Inject lateinit var _memoRepository: MemoRepository
    :
}

　ここでのポイントは、フィールド／プロパティに@Injectアノテーションを付与することです。この仕組みを、フィールドインジェクション（Field Injection）と言います。

　ただし、該当フィールド／プロパティは、privateにしてはいけません。なぜならprivateだと外部から注入できなくなってしまうからです。また、Kotlinの場合はlateinit varとなります。

ViewModelのインジェクション

　次に、ViewModelのインジェクションです。前回の図1のパターンに話を戻すと、アクティビティ/フラグメントは、ViewModelに依存します。

　しかし、そもそもViewModelは直接newするわけではありません。JavaならばViewModelProviderによる生成コード、Kotlinならばby viewModels()による委譲プロパティとして生成します。

　そこで、ViewModelに関してはアクティビティ/フラグメント側での生成コードはそのままとして、ViewModelクラスに@HiltViewModelアノテーションを付与するだけで、問題なく注入されるようになります。

　そのため、Javaならばリスト3、Kotlinならばリスト4のコードとなります。

［リスト3］MainViewModel.java

@HiltViewModel
public class MainViewModel extends ViewModel {
    :
  @Inject
  public MainViewModel(…) {
    :
  }
    :
}

［リスト4］MainViewModel.kt

@HiltViewModel
class MainViewModel
  @Inject
  constructor(…) : ViewModel() {
    :
}