一、啥是Dagger2

Dagger2的內容有點多，一點得有耐心。

1.1 簡介

Dagger2是一個Android/Java平臺上快速依賴注入框架，由谷歌開發，最早的版本Dagger1 由Square公司開發。依賴注入框架主要用於模組間解耦，提高程式碼的健壯性和可維護性。

幾大優點:

• 全域性物件例項的簡單訪問方式,@Inject
• 複雜的依賴關係只需要簡單的配置
• 讓單元測試和整合測試更加方便
• 輕鬆指定作用域

1.1 主要元素

關係圖：

主要元素有以下三個:

• Container: 相當於Android的Activity，在activity裡面獲取其他類的例項

• Component: 一個介面，告訴activty你要獲取例項的類在哪裡找

• Module: activty要的東西就在這裡初始化。

1.2 主要註解

看不懂下面的註解可以先看例子使用了，然後回來看就懂了。還有其他註解，在後面會講到。

1. @Inject

通常在需要依賴的地方使用這個註解。你用它告訴Dagger這個類或欄位需要依賴注入,，Dagger就會構建一個這個類的例項並滿足他們的依賴。

2. @Module

用來修飾modules類。 所以我們定義一個類，用@Module註解，這樣Dagger在構造類的例項時候，就知道從哪裡去找到需要的依賴。modules的一個重要特徵是它們設計為分割槽並組合在一起（比如說，我們的app中可以有很多在一起的modules）

3. @Provide

我們在modules中定義的方法就是是用這個註解來修飾，以此來告訴Dagger我們想要構造物件並提供這些依賴。

4. @Component

Components從根本上來說就是一個注入器，也可以說是@Inject和@Module的橋樑，他的主要作用就是連結這兩個部分。Components可以提供所有定義了的型別的例項，比如： 我們必須用@Component註解一個介面然後列出所有的

二、Dagger2基本使用

2.1 導包

在專案的build.gradle新增:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'
 

        //下面新增apt
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

    }
}

....

在需要的Module的build.gradle新增兩個部分:

apply plugin: 'com.android.application'
//新增的第一部分
apply plugin: 'com.neenbedankt.android-apt'
android {
    ......
}

dependencies {
    ......

    //新增的第二部分,版本太高會導致編譯失敗，這裡用2.8就可以了
    compile 'com.google.dagger:dagger:2.8'      //dagger的api
    apt "com.google.dagger:dagger-compiler:2.8"  //指定註解處理器
    compile 'org.glassfish:javax.annotation:10.0-b28'  //Adnroid缺失的部分javax註解
}

2.2 建立你要例項化的類

這裡假如我想在Activity裡面例項化一個LoginCtrl的類。於是建立一個LoginCtrl類

public class LoginCtrl {


    public void login(String name,String pass){
        Log.e("[email protected]@", "name:"+name+" pass:"+pass);
    }

}

2.3 建立module類

在這個類裡面 真正的例項化LoginCtrl類。建立一個LoginModule類，類使用@Module修飾，然後裡面新增方法provideLoginCtrl (方法名隨便)，返回型別為LoginCtrl，使用@Provides修飾方法名。如下：

@Module
public class LoginModule {

    @Provides LoginCtrl provideLoginCtrl(){
        return new LoginCtrl();
    }

}

2.4 建立Component介面

建立一個LoginComponent介面，用來告訴Activity你要例項化的東西在這裡。 @Component的引數提供Module進行聯絡, 接口裡面的方法和activty進行聯絡。 這樣形成了橋樑

PS:注意接口裡面的方法必須要有引數，不然會編譯錯誤

@Component(modules = LoginModule.class)
public interface LoginComponent {

    //要新增方法，方法必須新增引數，引數型別必須和呼叫時候一致
    void inject(TestActivity activity);

}

2.5 構建

搞完上面的步驟之後，點選選單欄的Build -> Build Project 或者 Build Module。稍等一會兒。 等構建完成之後，就會在module -> 的build -> generated -> source -> apt -> debug -> 包名/路徑 -> 看到生成對應的檔案

2.6 在Activity注入

接下來就可以使用了,在activity中使用@Inject修飾你要例項化的類，然後使用類Dagger+Compontent介面的類名初始化Dagger，就成功注入了，我這裡是新建的一個TestAtivity。

public class TestActivity extends Activity {


    @Inject
    LoginCtrl loginCtrl;    //注入的方式例項化LoginCtrl

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //初始化注入，inject是LoginComponent接口裡面自定義的方法；
        DaggerLoginComponent.create().inject(this);

        // 然後就可以呼叫loginCtrl裡面的方法了  
        loginCtrl.login("tianping","pass");

    }
}

就可以看到輸出

com.tpnet.dagger2test E/[email protected]@: name:tianping pass:pass

PS注意:Component介面方法裡面的引數，在Activity傳遞的時候必須型別一致，MainActivity就是MainActivity.this。如果引數型別是Context，你傳遞了MainActivity.this過去就會導致注入失敗，例項化物件為空。

三、Module引數傳遞

把上面的栗子修改一下，新增兩個類，在LoginCrtl裡面進行控制這兩個類。

LoginStore.java類，看作為本地儲存登入資訊的類。

public class LoginStore {


    private Context mContext;

    public LoginStore(Context mContext) {
        this.mContext = mContext;
    }

    public void login(String name,String pass){
        Log.e("@@", "LoginStore進行儲存: name="+name+",pass="+pass);
        SharedPreferences.Editor editor = mContext.getSharedPreferences("login",Context.MODE_PRIVATE).edit();
        editor.putString("name",name);
        editor.putString("pass",pass);
        editor.apply();
    }
}

LoginService.java類，看作為連結網路登入的類。

public class LoginService {

    public void login(String name,String pass){
        //網路請求登入....
        Log.e("@@", "LoginService登入: name="+name+",pass="+pass);

    }

}

LoginCtrl修改為:

public class LoginCtrl {


    private LoginStore mLoginStore;
    private LoginService mLoginService;

    public LoginCtrl(LoginService service, LoginStore store) {
        this.mLoginStore = store;
        this.mLoginService = service;
    }

    public void login(String name,String pass){

        mLoginService.login(name,pass);

        mLoginStore.login(name,pass);
    }

}

LoginModule修改為:

@Module
public class LoginModule {

    private Context mContext;   //供給LoginStore使用


    public LoginModule(Context mContext) {
        this.mContext = mContext;
    }

    @Provides LoginCtrl provideLoginCtrl(LoginService service, LoginStore store){
        return new LoginCtrl(service,store);
    }

}

3.1 Module構造方法傳參

看了上面修改完之後的程式碼，LoginModule類裡面需要在構造方法裡面傳參，怎麼傳呢？
在activity初始化的時候使用builder:

public class TestActivity extends Activity {


    @Inject
    LoginCtrl loginCtrl;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //DaggerLoginComponent.create().inject(this);

        //當Module需要構造方法傳參的時候，使用builder的方式初始化Dagger。
        DaggerLoginComponent.builder()
                .loginModule(new LoginModule(this))  //loginModule這個方法是構建之後才有的
                .build()
                .inject(this);


        loginCtrl.login("天平","密碼");

    }

}

總結就是:
當Module需要構造方法傳參的時候，使用builder的方式初始化Dagger

3.2 module裡面的方法引數

上面的修改完的程式碼執行肯定會報錯的,報錯資訊如下:

原因就是在LoginModule裡面，provideLoginCtrl方法有兩個引數:LoginService和LoginStore，這倆引數並沒有註解例項化，所以這裡就報錯了。 解決方法是下面兩個。

• 通過構造方法@Inject
• 在Module類裡面@Provide

3.2.1 通過構造方法Inject

module裡面的方法需要引數的解決方法1: 通過構造方法@Inject

又分兩種情況，帶引數的構造方法和不帶引數的。

1. 不帶引數的

如果Moudle裡面的方法的引數這個類的構造方法不需要引數的，直接在構造方法新增@Inject即可。

例如Loginservice，在LoginService裡新增一個Inject構造方法:

public class LoginService {

    //構造方法沒有引數的，直接在構造方法用@Injext修飾即可
    @Inject
    public LoginService() {

    }

    public void login(String name, String pass){
        //網路請求登入....
        Log.e("@@", "LoginService登入: name="+name+",pass="+pass);

    }

}

1. 帶引數的

如果Moudle裡面的方法的引數這個類的構造方法需要帶引數的。例如LoginStore,構造方法需要提供Context引數。Inject之後，還需要在Module類裡面@Provide一個String型別的方法，作為LoginStore構造方法的引數

LoginStore.java修改為:

public class LoginStore {

    private Context mContext;

    //這裡@Inject構造方法，然後在Module類裡面還需要Provide一個String的方法
    @Inject
    public LoginStore(Context mContext) {
        this.mContext = mContext;
    }

    public void login(String name,String pass){
        Log.e("@@", "LoginStore進行儲存: name="+name+",pass="+pass);
        SharedPreferences.Editor editor = mContext.getSharedPreferences("login",Context.MODE_PRIVATE).edit();
        editor.putString("name",name);
        editor.putString("pass",pass);
        editor.apply();
    }
}

LoginModule.java修改為i:

@Module
public class LoginModule {

    private Context mContext;   //供給LoginStore使用


    public LoginModule(Context mContext) {
        this.mContext = mContext;
    }

    //為LoginStore提供構造引數
    @Provides Context provideStoreContext(){
        return mContext;
    }

    @Provides LoginCtrl provideLoginCtrl(LoginService service, LoginStore store){
        return new LoginCtrl(service,store);
    }

}

好了，程式正常，這時候執行程式就會看到輸出:

03-04 19:14:00.124 31170-31170/? E/@@: LoginService登入: name=天平,pass=密碼
03-04 19:14:00.124 31170-31170/? E/@@: LoginStore進行儲存: name=天平,pass=密碼

3.2.2 在Module類裡面@Provide

module裡面的方法需要引數的解決方法1: 在Module類裡面@Provide一個引數型別。

1. 我們把程式碼改回3.2.1之前那樣
2. 修改LoginModule增加兩個方法

@Module
public class LoginModule {

    private Context mContext;   //供給LoginStore使用


    public LoginModule(Context mContext) {
        this.mContext = mContext;
    }


    /**
     * 為provideLoginCtrl方法的service引數提供例項化
     * @return
     */
    @Provides LoginService provideLoginService(){
        return new LoginService();
    }


    /**
     * 為provideLoginCtrl方法的store引數提供例項化
     * @return
     */
    @Provides LoginStore provideLoginStore(){
        return new LoginStore(mContext);
    }


    @Provides LoginCtrl provideLoginCtrl(LoginService service, LoginStore store){
        return new LoginCtrl(service,store);
    }

}

程式正常執行，看到輸出內容為:

03-04 19:20:40.795 31739-31739/com.tpnet.dagger2test E/@@: LoginService登入: name=天平,pass=密碼
03-04 19:20:40.795 31739-31739/com.tpnet.dagger2test E/@@: LoginStore進行儲存: name=天平,pass=密碼

簡單概括: 有需有求，activity的Inject需要什麼物件，Module類就提供什麼物件。

四、Dagger2模組化

在1.1的關係圖上面有說到多個Module , 說明了一個Component是可以依賴多個Module的，方法有三種:

• 多個@Module修飾類
• include @Moudle修飾類
• dependencies依賴Component

來逐個理解。

4.1 多個@Module修飾類

Component的值為@Module修飾類， 在@Component的接口裡面需要新增Module類，如果需要依賴多個module類，用陣列就行了。

再新建一個getInfoModule.java類:

@Module
public class getInfoModule {

}

在Logincomponent裡面新增module陣列即可

@Component(modules = {LoginModule.class,getInfoModule.class})
public interface LoginComponent {

    void inject(TestActivity activity);

}

這是第一種模組化方法

4.2 include @Moudle修飾類

@Moudle修飾的類include @Moudle修飾類， 這裡是在LoginModule類裡面的@Module修飾符新增includes module

把4.1在LoginModule.java新增的程式碼刪掉， 然後修改LoginModule的程式碼:

//這裡includes了需要的Module
@Module(includes = getInfoModule.class)
public class LoginModule {

    private Context mContext;   //供給LoginStore使用


    public LoginModule(Context mContext) {
        this.mContext = mContext;
    }


    ....(下面的程式碼就不拷貝了)

}

4.3 dependencies依賴Component

Component 依賴dependencies Component， 新建一個GetInfoComponent.java 介面，在裡面依賴需要的Module:

@Component(modules = getInfoModule.class)
public interface GetInfoComponent {

}

然後在LoginComponent.java裡面使用dependencies依賴GetInfoComponent.class

@Component(modules = LoginModule.class,dependencies = GetInfoComponent.class)
public interface LoginComponent {

    void inject(TestActivity activity);

}

五、建立區分不同例項

問題1. Activity裡面@Inject的類是根據什麼初始化的呢？

其實是根據Module類裡面的方法的返回型別進行判斷。

問題2. 那麼問題就來了，加入我在activity需要注入兩個相同型別的類呢？ 怎麼區分呢？

有兩種方法:

• 在Module裡面的方法和Activity Inject的類上面新增@Named(value)修飾，value就是用以區分
• 自定義註解。

5.1 方法1:@Named(value)區分

在3.2.2的程式碼上進行修改,在TestActivity再Inject一個LoginCtrl:

public class TestActivity extends Activity {

    @Named("one")   //用以區分LoginCtrl例項
    @Inject
    LoginCtrl loginCtrlOne;

    @Named("two")  //用以區分LoginCtrl例項
    @Inject
    LoginCtrl loginCtrlTwo;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //DaggerLoginComponent.create().inject(this);

        //當Module需要構造方法傳參的時候，使用builder的方式初始化Dagger。
        DaggerLoginComponent.builder()
                .loginModule(new LoginModule(this))  //loginModule這個方法是構建之後才有的
                .build()
                .inject(this);

        loginCtrlOne.login("天平one","密碼one");

        loginCtrlTwo.login("天平two","密碼two");

    }

}

在LoginModule.java裡面編輯新增一個返回LoginCtrl的方法

@Module
public class LoginModule {

    private Context mContext;   //供給LoginStore使用


    public LoginModule(Context mContext) {
        this.mContext = mContext;
    }


    /**
     * 為provideLoginCtrl方法的service引數提供例項化
     * @return
     */
    @Provides
    LoginService provideLoginService(){
        return new LoginService();
    }


    /**
     * 為provideLoginCtrl方法的store引數提供例項化
     * @return
     */
    @Provides
    LoginStore provideLoginStore(){
        return new LoginStore(mContext);
    }


    @Named("one")  //用以區分LoginCtrl例項
    @Provides
    LoginCtrl provideLoginCtrlOne(LoginService service, LoginStore store){
        Log.e("@@", "provideLoginCtrlOne被呼叫: ");
        return new LoginCtrl(service,store);
    }

    @Named("two")  //用以區分LoginCtrl例項
    @Provides
    LoginCtrl provideLoginCtrlTwo(LoginService service, LoginStore store){
        Log.e("@@", "provideLoginCtrlTwo被呼叫: ");
        return new LoginCtrl(service,store);
    }

}

可以看到輸出內容為一下，程式正常：

03-04 22:30:24.051 13833-13833/? E/@@: provideLoginCtrlOne被呼叫: 
03-04 22:30:24.051 13833-13833/? E/@@: provideLoginCtrlTwo被呼叫: 
03-04 22:30:24.051 13833-13833/? E/@@: LoginService登入: name=天平one,pass=密碼one
03-04 22:30:24.051 13833-13833/? E/@@: LoginStore進行儲存: name=天平one,pass=密碼one
03-04 22:30:24.061 13833-13833/? E/@@: LoginService登入: name=天平two,pass=密碼two
03-04 22:30:24.061 13833-13833/? E/@@: LoginStore進行儲存: name=天平two,pass=密碼two

5.2 方法2:自定義註解

我們按住Ctrl，然後滑鼠點選@Named，可以看到他的註解原始碼為：

@Qualifier
@Documented
@Retention(RUNTIME)
public @interface Named {

    /** The name. */
    String value() default "";
}

主要就是@Qualifier這個註解，我們也可以自己定義註解來區分。

5.2.1 使用value
建立一個註解，例如TPTest.java:

@Qualifier
@Retention(RUNTIME)
public @interface TPTest {
    String value() default "";
}

然後把5.1的例子的@Named改為@TPTest，你會發現也是可以的。。

5.2.2 不使用value
5.2.1是定義了一個註解，利用裡面的value進行區分，也可以用兩個註解進行區分。

新建一個One註解:

@Qualifier
@Retention(RUNTIME)
public @interface One {
    //這裡沒有value
}

再新建一個Two註解

@Qualifier
@Retention(RUNTIME)
public @interface Two {
    //這裡沒有value
}

然後把之前的@TPTest("one")改為@One ， @TPTest("two")改為@Two , 執行你會發現還是一樣的。

5.3 @Qualifier註解

在剛剛自定義註解的時候可以看到Qualifier這個關鍵詞，這個關鍵詞的作用就是: 用來區分不同的物件例項，@Named 是@Qualifier的一種實現而已。