Jetpack Hilt有哪些改善又有哪些限制？

Hilt以Android專屬DI框架的身份繼續完善了Jetpack的布局，它在前輩Dagger2的基礎上做了諸多改善，同時又存在很多限制，本文將逐一回答，

Hilt的由來

先來看下官方對于Hilt的描述，

Hilt provides a standard way to incorporate Dagger dependency injection into an Android application.
To simplify Dagger-related infrastructure for Android apps.
To create a standard set of components and scopes to ease setup, readability/understanding, and code sharing between apps.
To provide an easy way to provision different bindings to various build types (e.g. testing, debug, or release).

正如描述的那樣，Hilt是在Dagger(Dagger2)的基礎上專為Android App打造的依賴注入方案，它在保留Dagger2的編譯時注入的性能優勢前提下，簡化了注解的使用，同時針對Android框架類進行了優化，

在展開Hilt的講述之前先來簡單回顧下依賴注入的各個角色和流程，

依賴注入流程

• 依賴的需求方，通過構造引數或欄位依賴其他實體的角色，一般使用@Inject描述這種需求
• 依賴的提供方，對被依賴的實體提供實作的角色，比如使用@Provides描述這種來源
• 依賴的注入方，將提供方的實作注入到需求方的角色，比如使用@Component描述這種注入組件
  

Hilt的改善

定義應用組件

給Application添加@HiltAndroidApp注解即可告知Hilt生成應用級別的組件，自動實作了依賴注入的起點，免去了Dagger2的手動呼叫，

@HiltAndroidApp
class MyApplication : Application() {...}

定義Android框架類組件

@AndroidEntryPoint注解用來為Activity，Fragment，Service等Android框架類生成Hilt組件，省去了定義相應SubComponent的模板處理，

@AndroidEntryPoint
open class BaseActivity() : AppCompatActivity() {...}

系結生命周期

@InstallIn注解可以告知Hilt每個模塊將用在或系結到哪個Android類中，比如指定的value為ApplicationComponent的話將表明該模塊在整個應用周期內只會實體化一份，即單例，其他的還有系結到Activity生命周期的ActivityComponent，

@Module
@InstallIn(ApplicationComponent::class)
class NetworkModule {...}

預設作用域

@Singleton和@ActivityRetainedScoped等注解用以宣告該注入的作用范圍，比如Activity因為Configuration Change重繪了但@ActivityRetainedScoped注釋的依賴的并不會重新創建，

@ActivityRetainedScoped
class MovieAdapter @Inject constructor() { ... }

@AndroidEntryPoint
class DemoActivity : AppCompatActivity() {
    @Inject lateinit var movieAdapter: MovieAdapter 
    ...
}

注入Context

通過@ApplicationContext 和@ActivityContext注解等可以快速注入Context實體，省得我們自己提供Context的實作，

class MovieAdapter @Inject constructor(@ActivityContext private val context: Context)
        : RecyclerView.Adapter<RecyclerView.ViewHolder>() {...}

Jetpack組件的支持

Hilt實作了一些擴展幫助我們注入ViewModel和WorkManager的依賴，比如@ViewModelInject注解就可以告知Hilt此處需要注入ViewModel實體，

class MovieViewModel @ViewModelInject constructor(private val repository: Repository,
                                                  var movieAdapter: MovieAdapter
) : ViewModel() {...}

Hilt和Dagger2一樣支持@Qualifier定義多型別注入的注解，@Inject，@Provides以及@Binds的使用也沒有差別，不再贅述，感興趣的可以查詢官方檔案獲得更詳盡的介紹，
https://developer.android.google.cn/training/dependency-injection/hilt-android

實戰DEMO

照例使用OMDB API演示下Hilt的使用，

總體上通過@ViewModelInject向ViewModel注入Repository，Repository依賴RemoteData和LocalData，

• RemoteData通過NetworkModule提供單例的Retrofit介面，向OMDB發出搜索電影的請求
• LocalData依賴AnalysisModule提供的AnalysisService介面將選中的電影記錄進RoomModule提供的Room Database中

地址

Hilt Demo

框圖 & 截圖

Hilt的限制

Hilt的改善必然伴隨著一些限制，遵照了這些限制Hilt才能發揮它的優勢，

1. 框架類存在依附類的話同樣需要添加@AndroidEntryPoint

假使只給Framgent添加了@AndroidEntryPoint但所屬Activity沒有添加的話，啟動Fragment的時候會發生如下例外，

Hilt Fragments must be attached to an @AndroidEntryPoint Activity.

原理在于Fragment在attach的時候后會確保Fragment依附的Activity實作了GeneratedComponentManager介面，即是否添加了@AndroidEntryPoint注解，

2. 僅支持擴展自ComponentActivity的Activity

如果@AndroidEntryPoint注釋的Activity并非ComponentActivity的子類，那么在編譯階段就無法通過，

Activities annotated with @AndroidEntryPoint must be a subclass of androidx.activity.ComponentActivity.

@AndroidEntryPoint注釋的Activity是支持ViewModel注入的，而ViewModel的實作完全依賴于ComponentActivity，所以作此限制很有必要，畢竟都已經用Jetpack全家桶了，Activity這么重要的組件還用老的也太沒決心了，

3. 僅支持擴展自androidx.Fragment包的Fragment

和Activity的限制一樣，采用AOSP的Fragment的話，編譯階段就不會讓你通過，

@AndroidEntryPoint base class must extend ComponentActivity, (support) Fragment, View, Service, or BroadcastReceiver.

事實上AOSP的Fragment自Android 9 就已Deprecated，在于其缺乏很多特性，包括Lifecycle，ViewMode等，進而無法和ComponentActivity搭配使用，

4. 也不支持Retained Fragment

呼叫setRetainInstance(true)的Fragment就是Retained Fragment，意味著Configuration Change導致持有的view銷毀了但Fragment本身沒有銷毀，

如果不小心將Retained Fragment添加了@AndroidEntryPoint，那么在橫豎屏切換導致畫面重繪的時候可能會發生如下例外，

onAttach called multiple times with different Context! Hilt Fragments should not be retained.

Configuration Change導致Activity重建，但Retained Fragment實體保留了下來，意味著同一個Fragment實體要被重復注入依賴，這并不合理，所以Hilt在第一次注入Fragment前會依據依附的Activity創建一個Context實體，后續將檢查這個實體是否為空來確保每次注入的Fragment都是新的，

5. 向Activity等框架類注入實體的話需要采用欄位注入
Application、Activity等Android特有類的實體由系統創建，無法通過建構式注入，只能采用欄位注入的方式，

6. 注入的欄位不能為私有的

不小心將注入的欄位宣告成private也沒關系，編譯期會向你發出提醒，

Execution failed for task ‘:app:kaptDebugKotlin’. A failure occurred while executing org.jetbrains.kotlin.gradle.internal.KaptExecution.

7. 框架類的基類可統一添加@AndroidEntryPoint，但抽象類則不需要

框架類的基類一次性添加了這個注解各Hilt便可生成統一的組件向各子類注入依賴，每個子類不用額外添加，但基類是抽象類的話則不可以使用該注解，每個子類仍然需要各自添加，否則會發生編譯錯誤，

8 無法為BrocastReceiver生成獨立的Component組件

不同于Activity和Fragment，Hilt直接從ApplicationComponent組件向BrocastReceiver注入依賴，從原理上講BrocastReceiver實體的創建和回呼都是由ApplicationThread直接調度的，所以設計成這樣？

9. ActivityRetainedComponent組件在第一次呼叫onCreate()時創建，在最后一次呼叫Activity#onDestroy()時銷毀，

ActivityRetainedComponent組件在Configuration Change導致Activity重繪后仍然存在，生命周期長于ActivityComponent組件，可以添加@ActivityRetainedScope注解來系結這個組件，

需要提醒的一點是如果采用@ViewModelInject提供ViewModel的依賴，那么無需再使用@ActivityRetainedScope來注釋依賴的實體，因為它已經被自動系結到了ActivityRetainedComponent組件，

10. 默認的系結在每次注入都會創建新的實體，

基于記憶體開銷的考慮，默認情況下都系結都沒有限定作用域，即注入每個依賴的地方都會提供一個新的實體，如果被依賴的實體具有明確的使用場景或范圍，可以為這個注入指定作用域，比如整個應用周期內保留一份實體的@Singleton作用域，

11. View里進行的欄位注入默認將系結到ActivityComponent組件

如果View來自于Fragment，在@AndroidEntryPoint以外可以添加@WithFragmentBindings將注入精準地系結到FragmentComponent組件，

12. ContentProvider不能直接使用Hilt注解

四大組件中只有ContentProvider實體的創建先于Application，可是整個應用的注入起點是Application組件，所以無法直接為ContentProvider提供注入的支持，

但如果ContentProvider確有注入需求的話，需要自行定義@EntryPoint注釋的介面并通過@InstallIn指定依賴項需要系結到的組件，具體的使用程序和跟Dagger2很類似，

13. 使用@ViewModelInject向ViewModel注入依賴的特別注意

• 如果使用viewModels()的KTX獲取ViewModel實體的話，可能會遇到找不到該KTX的問題，這時候注意下gradle檔案有沒有匯入fragment-ktx的依賴
• 如果運行失敗并提示viewmodel不包含默認建構式，一定記得檢查下hilt-compiler的注釋處理器有沒有在gradle檔案里宣告
• 如果編譯發生如下的錯誤，需記得在gradle的kotlinOptions里宣告jvm的版本為1.8

Cannot inline bytecode built with JVM target 1.8 into bytecode that is being built with JVM target 1.6. Please specify proper ‘-jvm-target’ option

結語

相較于Dagger2的改善足以窺見Hilt的諸多優點，

• 高度封裝了框架類的注入免于手動初始化組件
• 預設了充分的作用域和方便的Context注入
• 針對Jetpack組件的支持
  當我們需要在Android App上匯入DI的話可以優先考慮它，

但Hilt也不是完美的，除了上述羅列的一堆限制以外，還存在天生的劣勢，比如無法應用在動態功能模塊專案當中，依據實際需要做出抉擇，是小而美的Hilt，還是大而強的Dagger2，

本文DMEO

Hilt Demo

參考資料:

https://developer.android.google.cn/training/dependency-injection/hilt-android
https://developer.android.google.cn/training/dependency-injection/hilt-jetpack
https://mp.weixin.qq.com/s/VKyyNqAPFnlclGKnIbisAw
https://guolin.blog.csdn.net/article/details/109787732

推薦閱讀：

Dagger2和它在SystemUI上的應用
除了SQLite一定要試試Room