本篇的內(nèi)容不涉及Dagger2的源碼，只是為了更好的使用.
想進(jìn)一步了解的話可以閱讀以下文章:
dagger2讓你愛不釋手-基礎(chǔ)依賴注入框架篇
dagger2讓你愛不釋手-重點(diǎn)概念講解、融合篇
dagger2讓你愛不釋手-終結(jié)篇
Dagger2 這次入門就不用放棄了
Dagger2 使用正確姿勢
Dagger2 徹底了解如何構(gòu)建依賴關(guān)系
本著不重復(fù)造輪子的精神,理論上面幾篇文章很詳細(xì)了,那我就直接結(jié)合我的開發(fā)來談?wù)劙?/p>
Dagger2的配置
目錄添加apt支持，apt是用于自動(dòng)生成代碼來進(jìn)行依賴注入的。
項(xiàng)目中的build.gradle添加：
dependencies {
//構(gòu)建android項(xiàng)目的gradle
classpath 'com.android.tools.build:gradle:2.2.3'
//構(gòu)建dragger2
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
在module的build.gradle添加：
apply plugin: 'com.neenbedankt.android-apt'
android{
...
}
dependencies {
provided 'org.glassfish:javax.annotation:10.0-b28'
compile 'com.google.dagger:dagger:2.0.2'
compile 'com.google.dagger:dagger-compiler:2.0.2'
}
第一步：編寫Module
編寫ActivityModule
@Module
public class ActivityModule {
private Activity mActivity;
public ActivityModule(Activity activity) {
mActivity = activity;
}
@Provides
@ActivityScope
public Activity provideActivity() {
return mActivity;
}
@Provides
@ActivityScope
public List<DataListBean> provideList() {
return new ArrayList<>();
}
@Provides
@ActivityScope
public PlanManagerAdapter provideAdapter(List<DataListBean> data) {
return new PlanManagerAdapter(data);
}
}
類要用@Module注解來標(biāo)示，可以看到我這個(gè)AcitivtyModule中定義了一個(gè)構(gòu)造函數(shù)，需要傳進(jìn)來一個(gè)XXXActivity對象。
我們需要明確Module的作用是用來提供生成依賴對象的，比如我要注入PlanManagerAdapter，那么這個(gè)Module的作用就是需要生成一個(gè)PlanManagerAdapter 的對象，來讓Dagger2注入到XXXActivity中。當(dāng)然還可以是XXXPresenter對象,或者普通的bean對象等.
細(xì)心的同學(xué)應(yīng)該看到了函數(shù)provideAdapter上面使用@Provides注解(@ActivityScope后面講),用@Provides注解的函數(shù)名需要以provide開頭，然后后面接什么內(nèi)容都可以，看自己喜歡，事實(shí)上這里是根據(jù)返回值類型來標(biāo)識的，方法名并不重要，只需要保證以provide開頭即可。
然后這里需要傳入一個(gè)List<DataListBean>參數(shù),仔細(xì)看我上面的代碼中還定義了兩個(gè)函數(shù)，分別為provideList和provideActivity，這里provideAdapter的參數(shù)就是通過provideList這兩個(gè)函數(shù)來獲取的。剩下的provideActivity則是會(huì)出現(xiàn)在開發(fā)中的需要activity的地方,用@Inject注解標(biāo)識就可以獲取到activity的對象,如果沒有聲明provideList這個(gè)函數(shù)的話，編譯期間會(huì)報(bào)錯(cuò)。
編寫AppModule
我的項(xiàng)目中提供一個(gè)全局的RetrofitHelper對象來進(jìn)行網(wǎng)絡(luò)請求，他的生命周期是和APP一致的，這個(gè)時(shí)候我們就需要編寫AppModule 了。
@Module
public class AppModule {
@Provides
@Singleton
RetrofitHelper provideRetrofitHelper() {
return new RetrofitHelper();
}
}
- 這里provide方法除了@Provides之外還添加了一個(gè)@Singleton注解，這里只是標(biāo)注一下讓大家看起來方便識別是全局單例的對象只是添加一個(gè)@Singleton注解并不能說明RetrofitHelper對象就是單例,這還要看在哪里初始化(后面講)。
第二步：編寫Component
編寫ActivityComponent
@ActivityScope
@Component(dependencies = AppComponent.class, modules = ActivityModule.class)
public interface ActivityComponent {
void inject(HomeActivity homeActivity);
}
編寫AppComponent了：
@Singleton
@Component(modules = AppModule.class)
public interface AppComponent {
RetrofitHelper retrofitHelper(); //http的幫助類
}
- 我們編寫的ActivityComponent需要用@Component注解來標(biāo)識，同時(shí)聲明了(modules = ActivityModule.class),并且依賴了AppComponent(dependencies = AppComponent.class),Component之間也可以依賴,然后提供了一個(gè)方法，叫做inject，用來在Activity中注入。這里的AppComponent提供了一個(gè)方法，用來暴露RetrofitHelper對象的。
第三步:在目標(biāo)類中(activity)注入
Make Project，之后就會(huì)生成DaggerActivityComponent和DaggerAppComponent的類，之后我們在MyApplicaiotn中實(shí)例化DaggerAppComponent:
private static AppComponent appComponent;
@Override
public void onCreate() {
super.onCreate();
appComponent = DaggerAppComponent.builder()
.appModule(new AppModule())
.build();
}
//初始化AppComponent
public static AppComponent getAppComponent() {
return appComponent;
}
然后在Activity的onCreated函數(shù)中編寫如下代碼：
DaggerActivityComponent.builder()
.appComponent(MyApplication.getAppComponent())
.activityModule(new ActivityModule(this))
.build()
.inject(this);
這些工作做完之后接下來看下調(diào)用代碼
- 首先在activity中注入PlanManagerAdapter 對象
這個(gè)對象就是來自ActivityModule中的provideAdapter方法返回的對象,此處再次強(qiáng)調(diào)因?yàn)镻lanManagerAdapter構(gòu)造需要傳入?yún)?shù),這個(gè)參數(shù)也要在ActivityModule中創(chuàng)建對象并返回.
-
其次就是在Presenter中注入了activity(可以作為上下文)和網(wǎng)絡(luò)請求幫助類RetrofitHelper
-
大家會(huì)有疑問RetrofitHelper并沒有在ActivityModule中啊,但是大家不要忘了,我在ActivityComponent中進(jìn)行了依賴,這樣就可以解決問題了
注入方式
- 注入實(shí)例的方式一種是通過編寫Moudle，并且提供一些provideXXX()的方法，然后通過Component把這些對象進(jìn)行注入。
-
其實(shí)在Dagger2中還有一種方式實(shí)現(xiàn)對象的注入，這種方式比較簡單。就像上面我需要在activity中注入PlanManagerAdapter對象，除了編寫Moudle,我們還可以在PlanManagerAdapter的構(gòu)造函數(shù)中添加@Inject注解即可，代碼如下：
這樣就不需要在Moudle中添加provideXXX()的方法了,兩種方式都可以.
當(dāng)在目標(biāo)類(activity)遇到
@Inject
類XXX XXX;
整個(gè)Dagger2的依賴注入的過程如下：
步驟1：查找Module中是否存在創(chuàng)建該類ProvidesXXX的方法。
步驟2：若存在創(chuàng)建類ProvidesXXX方法，查看該方法是否存在參數(shù)
步驟2.1：若存在參數(shù)，則按從步驟1開始依次初始化每個(gè)參數(shù)(上面講過有參數(shù)的情況)
步驟2.2：若不存在參數(shù)，則直接初始化該類實(shí)例，一次依賴注入到此結(jié)束
步驟3：若不存在創(chuàng)建類方法，則查找Inject注解的構(gòu)造函數(shù),看構(gòu)造函數(shù)是否存在參數(shù)
步驟3.1：若存在參數(shù)，則從步驟1開始依次初始化每個(gè)參數(shù)
步驟3.2：若不存在參數(shù)，則直接初始化該類實(shí)例，一次依賴注入到此結(jié)束
為什么ActivityComponent要提供一個(gè)inject方法
在XXXActivity中對對某些需要注入的成員添加@Inject注解的時(shí)候，Dagger2就會(huì)生成一個(gè)XXXActivity_MembersInjector的東西，這個(gè)是對成員變量進(jìn)行注入的關(guān)鍵類，涉及到再深入的內(nèi)容，我就沒再研究了。我們只需要知道當(dāng)我們需要向目標(biāo)類(Activity)注入一些成員變量的時(shí)候，我們需要在ActivityComponent中提供一個(gè)方法：
void inject(XXXActivity xxxActivity);
并且在初始化的時(shí)候調(diào)用這個(gè)方法，才能成功注入。
Scope的使用，如何實(shí)現(xiàn)單例？
在我們的AppComponent中添加了一個(gè)注解為@Singleton
，@Singleton就是一個(gè)Scope，事實(shí)上@Sinleton中并沒有創(chuàng)建單例的能力，那么AppComponent中提供的依賴注入是如何實(shí)現(xiàn)單例的呢。其實(shí)這個(gè)原理很簡單。首先Module提供了創(chuàng)建實(shí)例的方法，接著AppComponent
中對Module進(jìn)行管理，最后MyAppComponent在自定義Applicaiton中被實(shí)例化了一次。
其實(shí)@Singletop還有有一些作用的，首先一方面能讓你直面的了解到這是一個(gè)單例，其次這個(gè)@Singletop能夠更好的管理Modlue和Component之間的關(guān)系。
Dagger2需要保證Component和Module是匹配的，就需要用到這個(gè)注解。
為什么這樣說，上文中我定義了一個(gè)ActivityScope
@Scope
public @interface ActivityScope {
}
因?yàn)槭且驗(yàn)槲以贏ppComponent中是有@Singletop,ActivityComponent中依賴了AppComponent
，所以我們需要使用一個(gè)Scope來匹配他們之間的關(guān)系，不然就會(huì)在編譯期間報(bào)錯(cuò)。并不是說ActivityScope能讓實(shí)例和Activity生命周期一致。和Activity生命周期一致是因?yàn)锳ctivityComponent是在Activity中生成實(shí)例的。
Qualifier 限定符的作用以及使用。
這也是一個(gè)很強(qiáng)大的注解，首先為什么需要用這么一個(gè)東西呢，之前說道過，在Module中的provide方法實(shí)際上是根據(jù)返回值來進(jìn)行識別的。但是假設(shè)我需要根據(jù)不同的需求傳入不同的構(gòu)造參數(shù)的時(shí)候，如何區(qū)分呢？比如：一個(gè)Presenter，可能他有兩個(gè)構(gòu)造函數(shù)，分別對應(yīng)不同的需求，這種情況下，provide方法的返回值都是Presenter，那么就需要使用Qualifier。具體怎么使用呢。
首先聲明一個(gè)注解用@Qualifier修飾，然后在需要區(qū)別的地方添加就行了，下面是一個(gè)實(shí)例代碼：
深入理解Java：注解（Annotation）自定義注解入門
@Module
public class AppModule {
private final App app;
public AppModule(App app) {
this.app = app;
}
@Provides
@Singleton
@ForApplication
Context provideAppContext() {
return app;
}
@Provides
@Singleton
Prefser providePrefser(@ForApplication Context context) {
return new Prefser(context);
}
@Provides
@Singleton
AccountManager provideAccountManager(@ForApplication Context context) {
return AccountManager.get(context);
}
首先在provide中添加一個(gè)注解@ForApplicition，接著在需要使用這個(gè)Context的地方再次標(biāo)示即可。這樣假設(shè)有其他一些提供了Activity的Context的地方和這里發(fā)生沖突的時(shí)候，Dagger2也能準(zhǔn)確找到這個(gè)Applicaiton的Context。
總結(jié)
寫完才發(fā)現(xiàn),雖然對Dagger的使用心里很明白了但是寫成文字叫大家理解還是火候不夠，還有疑問的可以參考下開篇的文章或者留言一起交流。
