本篇的內(nèi)容不涉及Dagger2的源碼，只是為了更好的使用.
想進(jìn)一步了解的話(huà)可以閱讀以下文章:
dagger2讓你愛(ài)不釋手-基礎(chǔ)依賴(lài)注入框架篇
dagger2讓你愛(ài)不釋手-重點(diǎn)概念講解魔市、融合篇
dagger2讓你愛(ài)不釋手-終結(jié)篇
Dagger2 這次入門(mén)就不用放棄了
Dagger2 使用正確姿勢(shì)
Dagger2 徹底了解如何構(gòu)建依賴(lài)關(guān)系
本著不重復(fù)造輪子的精神,理論上面幾篇文章很詳細(xì)了,那我就直接結(jié)合我的開(kāi)發(fā)來(lái)談?wù)劙?/p>
Dagger2的配置
目錄添加apt支持庄新，apt是用于自動(dòng)生成代碼來(lái)進(jìn)行依賴(lài)注入的迁霎。
項(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'
}
第一步：編寫(xiě)Module
編寫(xiě)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);
}
}
類(lèi)要用@Module注解來(lái)標(biāo)示，可以看到我這個(gè)AcitivtyModule中定義了一個(gè)構(gòu)造函數(shù)，需要傳進(jìn)來(lái)一個(gè)XXXActivity對(duì)象黍瞧。
我們需要明確Module的作用是用來(lái)提供生成依賴(lài)對(duì)象的佛舱，比如我要注入PlanManagerAdapter椎例，那么這個(gè)Module的作用就是需要生成一個(gè)PlanManagerAdapter 的對(duì)象，來(lái)讓Dagger2注入到XXXActivity中请祖。當(dāng)然還可以是XXXPresenter對(duì)象,或者普通的bean對(duì)象等.
細(xì)心的同學(xué)應(yīng)該看到了函數(shù)provideAdapter上面使用@Provides注解(@ActivityScope后面講),用@Provides注解的函數(shù)名需要以provide開(kāi)頭订歪，然后后面接什么內(nèi)容都可以，看自己喜歡肆捕，事實(shí)上這里是根據(jù)返回值類(lèi)型來(lái)標(biāo)識(shí)的刷晋，方法名并不重要，只需要保證以provide開(kāi)頭即可慎陵。
然后這里需要傳入一個(gè)List<DataListBean>參數(shù),仔細(xì)看我上面的代碼中還定義了兩個(gè)函數(shù)眼虱，分別為provideList和provideActivity，這里provideAdapter的參數(shù)就是通過(guò)provideList這兩個(gè)函數(shù)來(lái)獲取的席纽。剩下的provideActivity則是會(huì)出現(xiàn)在開(kāi)發(fā)中的需要activity的地方,用@Inject注解標(biāo)識(shí)就可以獲取到activity的對(duì)象,如果沒(méi)有聲明provideList這個(gè)函數(shù)的話(huà)蒙幻，編譯期間會(huì)報(bào)錯(cuò)。
編寫(xiě)AppModule
我的項(xiàng)目中提供一個(gè)全局的RetrofitHelper對(duì)象來(lái)進(jìn)行網(wǎng)絡(luò)請(qǐng)求胆筒，他的生命周期是和APP一致的邮破，這個(gè)時(shí)候我們就需要編寫(xiě)AppModule 了。
@Module
public class AppModule {
@Provides
@Singleton
RetrofitHelper provideRetrofitHelper() {
return new RetrofitHelper();
}
}
- 這里provide方法除了@Provides之外還添加了一個(gè)@Singleton注解仆救，這里只是標(biāo)注一下讓大家看起來(lái)方便識(shí)別是全局單例的對(duì)象只是添加一個(gè)@Singleton注解并不能說(shuō)明RetrofitHelper對(duì)象就是單例,這還要看在哪里初始化(后面講)抒和。
第二步：編寫(xiě)Component
編寫(xiě)ActivityComponent
@ActivityScope
@Component(dependencies = AppComponent.class, modules = ActivityModule.class)
public interface ActivityComponent {
void inject(HomeActivity homeActivity);
}
編寫(xiě)AppComponent了：
@Singleton
@Component(modules = AppModule.class)
public interface AppComponent {
RetrofitHelper retrofitHelper(); //http的幫助類(lèi)
}
- 我們編寫(xiě)的ActivityComponent需要用@Component注解來(lái)標(biāo)識(shí)，同時(shí)聲明了(modules = ActivityModule.class),并且依賴(lài)了AppComponent(dependencies = AppComponent.class),Component之間也可以依賴(lài),然后提供了一個(gè)方法彤蔽，叫做inject摧莽，用來(lái)在Activity中注入。這里的AppComponent提供了一個(gè)方法顿痪，用來(lái)暴露RetrofitHelper對(duì)象的镊辕。
第三步:在目標(biāo)類(lèi)中(activity)注入
Make Project，之后就會(huì)生成DaggerActivityComponent和DaggerAppComponent的類(lèi)蚁袭，之后我們?cè)贛yApplicaiotn中實(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ù)中編寫(xiě)如下代碼：
DaggerActivityComponent.builder()
.appComponent(MyApplication.getAppComponent())
.activityModule(new ActivityModule(this))
.build()
.inject(this);
這些工作做完之后接下來(lái)看下調(diào)用代碼
- 首先在activity中注入PlanManagerAdapter 對(duì)象
這個(gè)對(duì)象就是來(lái)自ActivityModule中的provideAdapter方法返回的對(duì)象,此處再次強(qiáng)調(diào)因?yàn)镻lanManagerAdapter構(gòu)造需要傳入?yún)?shù),這個(gè)參數(shù)也要在ActivityModule中創(chuàng)建對(duì)象并返回.
-
其次就是在Presenter中注入了activity(可以作為上下文)和網(wǎng)絡(luò)請(qǐng)求幫助類(lèi)RetrofitHelper
-
大家會(huì)有疑問(wèn)RetrofitHelper并沒(méi)有在ActivityModule中啊,但是大家不要忘了,我在ActivityComponent中進(jìn)行了依賴(lài),這樣就可以解決問(wèn)題了
注入方式
- 注入實(shí)例的方式一種是通過(guò)編寫(xiě)Moudle征懈，并且提供一些provideXXX()的方法，然后通過(guò)Component把這些對(duì)象進(jìn)行注入揩悄。
-
其實(shí)在Dagger2中還有一種方式實(shí)現(xiàn)對(duì)象的注入卖哎，這種方式比較簡(jiǎn)單。就像上面我需要在activity中注入PlanManagerAdapter對(duì)象，除了編寫(xiě)Moudle,我們還可以在PlanManagerAdapter的構(gòu)造函數(shù)中添加@Inject注解即可亏娜，代碼如下：
這樣就不需要在Moudle中添加provideXXX()的方法了,兩種方式都可以.
當(dāng)在目標(biāo)類(lèi)(activity)遇到
@Inject
類(lèi)XXX XXX;
整個(gè)Dagger2的依賴(lài)注入的過(guò)程如下：
步驟1：查找Module中是否存在創(chuàng)建該類(lèi)ProvidesXXX的方法焕窝。
步驟2：若存在創(chuàng)建類(lèi)ProvidesXXX方法，查看該方法是否存在參數(shù)
步驟2.1：若存在參數(shù)维贺，則按從步驟1開(kāi)始依次初始化每個(gè)參數(shù)(上面講過(guò)有參數(shù)的情況)
步驟2.2：若不存在參數(shù)它掂，則直接初始化該類(lèi)實(shí)例，一次依賴(lài)注入到此結(jié)束
步驟3：若不存在創(chuàng)建類(lèi)方法溯泣，則查找Inject注解的構(gòu)造函數(shù),看構(gòu)造函數(shù)是否存在參數(shù)
步驟3.1：若存在參數(shù)群发，則從步驟1開(kāi)始依次初始化每個(gè)參數(shù)
步驟3.2：若不存在參數(shù)，則直接初始化該類(lèi)實(shí)例发乔，一次依賴(lài)注入到此結(jié)束
為什么ActivityComponent要提供一個(gè)inject方法
在XXXActivity中對(duì)對(duì)某些需要注入的成員添加@Inject注解的時(shí)候熟妓，Dagger2就會(huì)生成一個(gè)XXXActivity_MembersInjector的東西，這個(gè)是對(duì)成員變量進(jìn)行注入的關(guān)鍵類(lèi)栏尚，涉及到再深入的內(nèi)容起愈，我就沒(méi)再研究了。我們只需要知道當(dāng)我們需要向目標(biāo)類(lèi)(Activity)注入一些成員變量的時(shí)候译仗，我們需要在ActivityComponent中提供一個(gè)方法：
void inject(XXXActivity xxxActivity);
并且在初始化的時(shí)候調(diào)用這個(gè)方法抬虽，才能成功注入。
Scope的使用纵菌，如何實(shí)現(xiàn)單例阐污？
在我們的AppComponent中添加了一個(gè)注解為@Singleton
，@Singleton就是一個(gè)Scope咱圆，事實(shí)上@Sinleton中并沒(méi)有創(chuàng)建單例的能力笛辟，那么AppComponent中提供的依賴(lài)注入是如何實(shí)現(xiàn)單例的呢。其實(shí)這個(gè)原理很簡(jiǎn)單序苏。首先Module提供了創(chuàng)建實(shí)例的方法手幢，接著AppComponent
中對(duì)Module進(jìn)行管理，最后MyAppComponent在自定義Applicaiton中被實(shí)例化了一次忱详。
其實(shí)@Singletop還有有一些作用的围来，首先一方面能讓你直面的了解到這是一個(gè)單例，其次這個(gè)@Singletop能夠更好的管理Modlue和Component之間的關(guān)系匈睁。
Dagger2需要保證Component和Module是匹配的监透，就需要用到這個(gè)注解。
為什么這樣說(shuō)航唆，上文中我定義了一個(gè)ActivityScope
@Scope
public @interface ActivityScope {
}
因?yàn)槭且驗(yàn)槲以贏ppComponent中是有@Singletop,ActivityComponent中依賴(lài)了AppComponent
胀蛮，所以我們需要使用一個(gè)Scope來(lái)匹配他們之間的關(guān)系，不然就會(huì)在編譯期間報(bào)錯(cuò)佛点。并不是說(shuō)ActivityScope能讓實(shí)例和Activity生命周期一致醇滥。和Activity生命周期一致是因?yàn)锳ctivityComponent是在Activity中生成實(shí)例的黎比。
Qualifier 限定符的作用以及使用超营。
這也是一個(gè)很強(qiáng)大的注解鸳玩，首先為什么需要用這么一個(gè)東西呢，之前說(shuō)道過(guò)演闭，在Module中的provide方法實(shí)際上是根據(jù)返回值來(lái)進(jìn)行識(shí)別的不跟。但是假設(shè)我需要根據(jù)不同的需求傳入不同的構(gòu)造參數(shù)的時(shí)候，如何區(qū)分呢米碰？比如：一個(gè)Presenter窝革，可能他有兩個(gè)構(gòu)造函數(shù)，分別對(duì)應(yīng)不同的需求吕座，這種情況下虐译，provide方法的返回值都是Presenter，那么就需要使用Qualifier吴趴。具體怎么使用呢漆诽。
首先聲明一個(gè)注解用@Qualifier修飾，然后在需要區(qū)別的地方添加就行了锣枝，下面是一個(gè)實(shí)例代碼：
深入理解Java：注解（Annotation）自定義注解入門(mén)
@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é)
寫(xiě)完才發(fā)現(xiàn),雖然對(duì)Dagger的使用心里很明白了但是寫(xiě)成文字叫大家理解還是火候不夠，還有疑問(wèn)的可以參考下開(kāi)篇的文章或者留言一起交流陨闹。
