Android Hilt依賴注入的使用講解
什么是依賴注入
首先,某個類的成員變量稱為依賴,如若此變量想要實例化引用其類的方法,可以通過構(gòu)造函數(shù)傳參或者通過某個方法獲取對象,此等通過外部方法獲取對象實例的稱為依賴注入;而依賴注入又可以簡單分為手動注入和自動注入兩種方式;Hilt就是基于Dagger進行場景化優(yōu)化的一個依賴注入庫,Hilt是Google專門為Android平臺打造的一個依賴注入庫,在使用上極大程度進行啦簡化(與dagger相比)
使用依賴注入的好處
Google文檔中介紹的優(yōu)勢如下:
- 重用代碼
- 易于重構(gòu)
- 易于測試
簡單來說,在開發(fā)中某些內(nèi)容需要進行層層手動調(diào)用,而且需要手動進行實例化;對于Hilt而言,它可以自動進行依賴注入,并且為項目中的每個 Android 類提供容器并自動管理其生命周期;某些需要全局使用的數(shù)據(jù),可以通過Hilt進行共享,從而簡化代碼
Hilt中常用的預(yù)定義限定符
@HiltAndroidApp
所有使用 Hilt 的應(yīng)用都必須包含一個帶有 @HiltAndroidApp
注解的 Application 類。@HiltAndroidApp
會觸發(fā) Hilt 的代碼生成操作,生成的代碼包括應(yīng)用的一個基類,該基類充當(dāng)應(yīng)用級依賴項容器,記得此Application類要在清單文件中進行引用
@HiltAndroidApp class App : Application() { ... }
@AndroidEntryPoint
如果某個Activity要使用Hilt依賴注入,就必須給Activity添加@AndroidEntryPoint注解
,同理Activity中的某個Fragment也需要使用,也必須添加@AndroidEntryPoint注解
;
目前Hilt 支持以下 Android 類:
- Application(通過使用 @HiltAndroidApp)
- ViewModel(通過使用 @HiltViewModel)
- Activity
- Fragment
- View
- Service
- BroadcastReceiver
@AndroidEntryPoint class MainActivity : ComponentActivity() {...}
@Module
Hilt帶有一個模塊的類,使用@Module
注解的類,它會告知Hilt,它提供了哪些實例,通常和@Provider
搭配使用,必須通過@InstallIn
注解為其添加作用域
@InstallIn
對于您可以從中執(zhí)行字段注入的每個 Android 類,都有一個關(guān)聯(lián)的 Hilt 組件,您可以在 @InstallIn
注解中引用該組件。每個 Hilt 組件負責(zé)將其綁定注入相應(yīng)的 Android 類。
Android 組件 | 默認綁定 |
---|---|
SingletonComponent | Application |
ActivityRetainedComponent | Application |
ViewModelComponent | SavedStateHandle |
ActivityComponent | Application 和 Activity |
FragmentComponent | Application、Activity 和 Fragment |
ViewComponent | Application、Activity 和 View |
ViewWithFragmentComponent | Application、Activity、Fragment 和 View |
ServiceComponent | Application 和 Service |
@Module @InstallIn(SingletonComponent::class) object AppModule {...}
@Provides
如果想要讓Hilt知道,提供了哪些實例對象,可以使用@Provides
進行注解,以下提供啦一個數(shù)據(jù)庫實例,并且作用域是全局單例
@Provides @Singleton fun providerAccountBean():AccountBean{ return AccountBean("FranzLiszt","123456") }
@Inject
如果想要使用Hilt自動進行啦依賴注入的對象,可以使用@Inject
注解進行調(diào)用;如下,無需進行實例化,它會自動引用providerAccountBean()
提供的對象
@Inject lateinit var bean: AccountBean
@HiltViewModel
通過名稱就可以了解,它需要與ViewModel
類聯(lián)合使用,作用于ViewModel上;如下,與@Inject
結(jié)合使用,在構(gòu)造函數(shù)引用啦上述Hilt
提供的對象
@HiltViewModel class AccountViewModel @Inject constructor(private val bean: AccountBean):ViewModel() {...}
Hilt的使用
依賴
第一步:在project/build.gradle
中添加如下代碼
plugins {
...
id 'com.google.dagger.hilt.android' version '2.44' apply false
}
第二步:在app/build.gradle
中添加如下代碼
plugins {
...
id 'kotlin-kapt'
id 'dagger.hilt.android.plugin'
}
第三步:在app/build.gradle
中添加如下代碼
//Dagger - Hilt
implementation("com.google.dagger:hilt-android:2.44")
kapt("com.google.dagger:hilt-android-compiler:2.44")// Compose dependencies
implementation "androidx.lifecycle:lifecycle-viewmodel-compose:2.4.0-beta01"
implementation "androidx.hilt:hilt-navigation-compose:1.0.0-alpha03"
第四步:在app/build.gradle
中添加如下代碼
android{
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
建立實體類
data class AccountBean(var username:String,var password:String)
添加Hilt入口
@HiltAndroidApp class APP:Application() {}
提供對象
此處作為用例,只是簡單寫一個測試用例,在函數(shù)中可以編寫復(fù)雜的程序,并不會影響程序性能,在程序初始化編譯時會耗時一丟丟。一下提供啦單例AccountBean
對象
@Module @InstallIn(SingletonComponent::class) object AppModule { @Provides @Singleton fun providerAccountBean():AccountBean{ return AccountBean("FranzLiszt","123456") } }
獲取對象
給Activity添加HiltAndroidEntryPoint
注解,然后可以通過Inject
注解獲取上面providerAccountBean
方法提供的對象
@AndroidEntryPoint class MainActivity : ComponentActivity() { @Inject lateinit var bean: AccountBean ... }
然后就可以直接進行對象引用
@Composable fun showAccountInfo() { Column( verticalArrangement = Arrangement.Center, horizontalAlignment = Alignment.CenterHorizontally ) { Text(text = bean.username) Spacer(modifier = Modifier.height(20.dp)) Text(text = bean.password) } }
應(yīng)用與ViewModel中
在ViewModel中使用HiltViewModel
注解,然后就可以使用Inject
注解獲取Hilt自動注入依賴的對象
@HiltViewModel class AccountViewModel @Inject constructor(private val bean: AccountBean):ViewModel() {...}
定義兩個具有狀態(tài)的成員變量,其中AccountState
是一個數(shù)據(jù)類,具有text和hint兩個成員變量
private val _usernameState = mutableStateOf(AccountState( hint = "input username" )) val usernameState:State<AccountState> = _usernameState private val _passwordState = mutableStateOf(AccountState( hint = "input password" )) val passwordState:State<AccountState> = _passwordState
在ViewModel初始化函數(shù)中,將Hilt提供的對象的值賦值給VM中的兩個狀態(tài)變量
init { _usernameState.value = usernameState.value.copy(text = bean.username) _passwordState.value = passwordState.value.copy(text = bean.password) }
通過外部事件進行對應(yīng)處理,外部輸入框不斷進行值修改,此處同步給VM中的狀態(tài)變量
fun onEvent(event: AccountEvent){ when(event){ is AccountEvent.ChangeUsername ->{ _usernameState.value = usernameState.value.copy(text = event.value) } is AccountEvent.ChangePassword ->{ _passwordState.value = passwordState.value.copy(text = event.value) } } }
使用
此處直接獲取ViewModel的兩個成員變量值,然后與兩個輸入框進行綁定,通過監(jiān)聽輸入框的onValueChange
方法,當(dāng)其值不斷修改時,然后調(diào)用VM中的onEvent
方法,然后修改VM中的狀態(tài)內(nèi)容,由于輸入框綁定了VM的狀態(tài)變量,然后狀態(tài)變量值改變后,相對應(yīng)的UI界面會進行重組
@Composable fun showAccountInfo (viewModel: AccountViewModel = hiltViewModel()){ val username = viewModel.usernameState.value val password = viewModel.passwordState.value Column( verticalArrangement = Arrangement.Center, horizontalAlignment = Alignment.CenterHorizontally ) { TextField( value = username.text, placeholder = { Text(text = username.hint)}, onValueChange = { viewModel.onEvent(AccountEvent.ChangeUsername(it)) } ) Spacer(modifier = Modifier.height(20.dp)) TextField( value = password.text, placeholder = { Text(text = password.hint)}, onValueChange = { viewModel.onEvent(AccountEvent.ChangePassword(it)) } ) } }
總結(jié)
上述的倆個測例,只是使用Hilt提供的便利的冰山一角;Hilt使用起來很方便,而去可以提高代碼結(jié)構(gòu),省去不必要的代碼;其中Koin
依賴注入庫也備受好評,雖然我沒有使用過,因為Google推Hilt
,就首先入手啦;在性能上,我看了一些其他文章上介紹,大差不差的,所有根據(jù)自己需要進行選擇。
到此這篇關(guān)于Android Hilt依賴注入的使用講解的文章就介紹到這了,更多相關(guān)Android Hilt依賴注入內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
android開機自啟動原理與實現(xiàn)案例(附源碼)
完成一下步驟后,啟動一次程序,完成注冊。等下次手機開機時,該軟件即會自動啟動,具體實現(xiàn)如下,感興趣的朋友可以參考下哈2013-06-06OpenHarmony如何調(diào)用電話服務(wù)API撥打電話
OpenHarmony3.1版本標準系統(tǒng)增加了通話相關(guān)的聯(lián)系人應(yīng)用,來電應(yīng)用等,在系統(tǒng)服務(wù)層面電話相關(guān)功能也比較完善,這篇文章主要介紹了OpenHarmony如何調(diào)用電話服務(wù)API撥打電話2022-11-11Android程序開發(fā)之UIScrollerView里有兩個tableView
這篇文章主要介紹了UIScrollerView里有兩個tableView 的相關(guān)資料,需要的朋友可以參考下2016-04-04Android Studio報錯unable to access android sdk add-on list解決方案
這篇文章主要介紹了Android Studio報錯unable to access android sdk add-on list解決方案,本文通過多種方式給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-03-03android 調(diào)用系統(tǒng)的照相機和圖庫實例詳解
android手機有自帶的照相機和圖庫,我們做的項目中有時用到上傳圖片到服務(wù)器,今天做了一個項目用到這個功能,所以把我的代碼記錄下來和大家分享,有需求的朋友可以參考下2012-12-12Arduino 數(shù)據(jù)類型轉(zhuǎn)換(單機片)詳細介紹
這篇文章主要介紹了Arduino 數(shù)據(jù)類型轉(zhuǎn)換(單機片)詳細介紹的相關(guān)資料,需要的朋友可以參考下2016-11-11