本篇的內容不涉及Dagger2的源碼，只是為了更好的使用.
想進一步了解的話可以閱讀以下文章:
dagger2讓你愛不釋手-基礎依賴注入框架篇
dagger2讓你愛不釋手-重點概念講解、融合篇
dagger2讓你愛不釋手-終結篇
Dagger2 這次入門就不用放棄了
Dagger2 使用正確姿勢
Dagger2 徹底了解如何構建依賴關系
本著不重復造輪子的精神,理論上面幾篇文章很詳細了,那我就直接結合我的開發來談談吧
Dagger2的配置
目錄添加apt支持，apt是用于自動生成代碼來進行依賴注入的。
項目中的build.gradle添加：
dependencies {
//構建android項目的gradle
classpath 'com.android.tools.build:gradle:2.2.3'
//構建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注解來標示，可以看到我這個AcitivtyModule中定義了一個構造函數，需要傳進來一個XXXActivity對象。
我們需要明確Module的作用是用來提供生成依賴對象的，比如我要注入PlanManagerAdapter，那么這個Module的作用就是需要生成一個PlanManagerAdapter 的對象，來讓Dagger2注入到XXXActivity中。當然還可以是XXXPresenter對象,或者普通的bean對象等.
細心的同學應該看到了函數provideAdapter上面使用@Provides注解(@ActivityScope后面講),用@Provides注解的函數名需要以provide開頭，然后后面接什么內容都可以，看自己喜歡，事實上這里是根據返回值類型來標識的，方法名并不重要，只需要保證以provide開頭即可。
然后這里需要傳入一個List<DataListBean>參數,仔細看我上面的代碼中還定義了兩個函數，分別為provideList和provideActivity，這里provideAdapter的參數就是通過provideList這兩個函數來獲取的。剩下的provideActivity則是會出現在開發中的需要activity的地方,用@Inject注解標識就可以獲取到activity的對象,如果沒有聲明provideList這個函數的話，編譯期間會報錯。
編寫AppModule
我的項目中提供一個全局的RetrofitHelper對象來進行網絡請求，他的生命周期是和APP一致的，這個時候我們就需要編寫AppModule 了。
@Module
public class AppModule {
@Provides
@Singleton
RetrofitHelper provideRetrofitHelper() {
return new RetrofitHelper();
}
}
- 這里provide方法除了@Provides之外還添加了一個@Singleton注解，這里只是標注一下讓大家看起來方便識別是全局單例的對象只是添加一個@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注解來標識，同時聲明了(modules = ActivityModule.class),并且依賴了AppComponent(dependencies = AppComponent.class),Component之間也可以依賴,然后提供了一個方法，叫做inject，用來在Activity中注入。這里的AppComponent提供了一個方法，用來暴露RetrofitHelper對象的。
第三步:在目標類中(activity)注入
Make Project，之后就會生成DaggerActivityComponent和DaggerAppComponent的類，之后我們在MyApplicaiotn中實例化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函數中編寫如下代碼：
DaggerActivityComponent.builder()
.appComponent(MyApplication.getAppComponent())
.activityModule(new ActivityModule(this))
.build()
.inject(this);
這些工作做完之后接下來看下調用代碼
- 首先在activity中注入PlanManagerAdapter 對象
這個對象就是來自ActivityModule中的provideAdapter方法返回的對象,此處再次強調因為PlanManagerAdapter構造需要傳入參數,這個參數也要在ActivityModule中創建對象并返回.
-
其次就是在Presenter中注入了activity(可以作為上下文)和網絡請求幫助類RetrofitHelper
-
大家會有疑問RetrofitHelper并沒有在ActivityModule中啊,但是大家不要忘了,我在ActivityComponent中進行了依賴,這樣就可以解決問題了
注入方式
- 注入實例的方式一種是通過編寫Moudle，并且提供一些provideXXX()的方法，然后通過Component把這些對象進行注入。
-
其實在Dagger2中還有一種方式實現對象的注入，這種方式比較簡單。就像上面我需要在activity中注入PlanManagerAdapter對象，除了編寫Moudle,我們還可以在PlanManagerAdapter的構造函數中添加@Inject注解即可，代碼如下：
這樣就不需要在Moudle中添加provideXXX()的方法了,兩種方式都可以.
當在目標類(activity)遇到
@Inject
類XXX XXX;
整個Dagger2的依賴注入的過程如下：
步驟1：查找Module中是否存在創建該類ProvidesXXX的方法。
步驟2：若存在創建類ProvidesXXX方法，查看該方法是否存在參數
步驟2.1：若存在參數，則按從步驟1開始依次初始化每個參數(上面講過有參數的情況)
步驟2.2：若不存在參數，則直接初始化該類實例，一次依賴注入到此結束
步驟3：若不存在創建類方法，則查找Inject注解的構造函數,看構造函數是否存在參數
步驟3.1：若存在參數，則從步驟1開始依次初始化每個參數
步驟3.2：若不存在參數，則直接初始化該類實例，一次依賴注入到此結束
為什么ActivityComponent要提供一個inject方法
在XXXActivity中對對某些需要注入的成員添加@Inject注解的時候，Dagger2就會生成一個XXXActivity_MembersInjector的東西，這個是對成員變量進行注入的關鍵類，涉及到再深入的內容，我就沒再研究了。我們只需要知道當我們需要向目標類(Activity)注入一些成員變量的時候，我們需要在ActivityComponent中提供一個方法：
void inject(XXXActivity xxxActivity);
并且在初始化的時候調用這個方法，才能成功注入。
Scope的使用，如何實現單例？
在我們的AppComponent中添加了一個注解為@Singleton
，@Singleton就是一個Scope，事實上@Sinleton中并沒有創建單例的能力，那么AppComponent中提供的依賴注入是如何實現單例的呢。其實這個原理很簡單。首先Module提供了創建實例的方法，接著AppComponent
中對Module進行管理，最后MyAppComponent在自定義Applicaiton中被實例化了一次。
其實@Singletop還有有一些作用的，首先一方面能讓你直面的了解到這是一個單例，其次這個@Singletop能夠更好的管理Modlue和Component之間的關系。
Dagger2需要保證Component和Module是匹配的，就需要用到這個注解。
為什么這樣說，上文中我定義了一個ActivityScope
@Scope
public @interface ActivityScope {
}
因為是因為我在AppComponent中是有@Singletop,ActivityComponent中依賴了AppComponent
，所以我們需要使用一個Scope來匹配他們之間的關系，不然就會在編譯期間報錯。并不是說ActivityScope能讓實例和Activity生命周期一致。和Activity生命周期一致是因為ActivityComponent是在Activity中生成實例的。
Qualifier 限定符的作用以及使用。
這也是一個很強大的注解，首先為什么需要用這么一個東西呢，之前說道過，在Module中的provide方法實際上是根據返回值來進行識別的。但是假設我需要根據不同的需求傳入不同的構造參數的時候，如何區分呢？比如：一個Presenter，可能他有兩個構造函數，分別對應不同的需求，這種情況下，provide方法的返回值都是Presenter，那么就需要使用Qualifier。具體怎么使用呢。
首先聲明一個注解用@Qualifier修飾，然后在需要區別的地方添加就行了，下面是一個實例代碼：
深入理解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中添加一個注解@ForApplicition，接著在需要使用這個Context的地方再次標示即可。這樣假設有其他一些提供了Activity的Context的地方和這里發生沖突的時候，Dagger2也能準確找到這個Applicaiton的Context。
總結
寫完才發現,雖然對Dagger的使用心里很明白了但是寫成文字叫大家理解還是火候不夠，還有疑問的可以參考下開篇的文章或者留言一起交流。
