Android上的依賴注入框架：Dagger

在開發程序的時候，會用到各種對象，很多對象在使用之前都需要進行初始化，而如果這個對象會在多個Activity中被使用，你就需要在每個使用的場景中都寫下同樣的代碼。這不僅麻煩，而且增加了出錯的可能。dagger的用途就是：讓你**不需要初始化對象。**換句話說，任何對象聲明完了就能直接用。

* 你也可以去Github查看這片文章

簡介

在開發程序的時候，會用到各種對象，很多對象在使用之前都需要進行初始化。例如你要操作一個SharedPreference，你需要調用getSharedPreferences(String name,int mode)來獲取一個對象，然后才能使用它。而如果這個對象會在多個Activity中被使用，你就需要在每個使用的場景中都寫下同樣的代碼。這不僅麻煩，而且增加了出錯的可能。dagger的用途就是：讓你不需要初始化對象。換句話說，任何對象聲明完了就能直接用。

原理

dagger是使用依賴注入的方式，使用Annotation給需要注入的對象做標記，通過inject()方法自動注入所有對象，從而完成自動的初始化。
示例代碼：

public class MainActivity extends Activity {
    // 通過@Inject對對象進行標記
    @Inject SharedPreferences sharedPreferences;


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

    // 注入依賴
    ObjectGraph.create(AppModule.class).inject(this);

    // 獲取name的值并輸出
    System.out.println(sharedPreferences.getString("name", ""));
}

}</pre> 
依賴注入(Dependency Injection)：在類A中要用到一個B的對象（依賴），需要通過新建B的實例或其他一些主動的方式來獲取對象，然后才能調用。而通過外部的方式自動將B的對象分配給A（注入），實現相對被動的獲取對象，這個過程稱為依賴注入。希望更多了解依賴注入可以自行Google。

使用方式

以一個簡單的“老板和程序員”App為例。你想實現Boss對象的自動注入，那么首先你要告訴程序它要怎么初始化一個Boss。在dagger中，為Boss類的構造方法添加一個@Inject注解，程序就會在需要的時候找到這個被標記的構造方法并調用它，從而獲取一個Boss對象。

public class Boss {
    ...


@Inject
public Boss() {
    ...
}

...

}</pre> 
需要注意的是，如果構造函數含有參數，Dagger會在構造對象的時候先去獲取這些參數（不然誰來傳參？），所以你要保證這些參數的構造方法也有@Inject標記，或者能夠通過@Provides注解（下面會介紹）來獲取到。

然后，在聲明Boss對象的時候，在前面同樣添加@Inject注解。程序會在依賴注入的過程中自動初始化被注解的對象。

public class MainActivity extends Activity {
    @Inject Boss boss;
    ...
}
 
最后，創建ObjectGraph類并執行inject()方法并將當前MainActivity作為參數傳入，Boss的對象就被注入到了MainActivity中。

public class MainActivity extends Activity {
    @Inject Boss boss;


@Override
protected void onCreate(Bundle savedInstanceState) {
    ObjectGraph.create(AppModule.class).inject(this);
}
...

}</pre> 
到此為止，使用Dagger將一個Boss對象注入到MainActivity的流程就完成了。上面這段代碼中出現了兩個類：ObjectGraph和AppModule。其中ObjectGraph是由Dagger提供的類，可以簡單理解為一個工具類，它的create函數中參數為所有的Module，本文不詳述，如果有興趣可以跟進我之后的Dagger詳解。AppModule是一個自定義類，代碼如下：

@Module(injects = MainActivity.class)
public class AppModule {
}
 
可以看到，AppModule是一個空類，只有一行注解。@Module注解表示，這個類是一個Module，Module的作用是提供信息，讓ObjectGraph知道應該怎樣注入所有的依賴。例如，上面這段代碼中聲明了可注入對象的信息：MainActivity.class（使用顯式聲明這樣的看起來很麻煩、多此一舉的方式和Dagger的原理有關，本文不詳述）。

自定義依賴

對構造方法進行注解是很好用的實現依賴的途徑，然而它并不適用于所有情況。


接口（Interface）是沒有構造方法的

第三方庫提供的類，它們的構造方法不能被注解

有些類需要靈活選擇初始化的配置，而不是使用一個單一的構造方法
</ul>

對于這樣的情況，可以使用@Provides注解來提供專用的初始化方法，實現自定義依賴。

@Provides
Coder provideCoder(Boss boss) {
    return new Coder(boss);
}
 
同樣，@Provides注解的方法如果含有參數，它的所有參數也要保證能夠被Dagger獲取到。

所有帶有@Provides注解的方法都需要被封裝到帶有@Module注解的類中：

@Module
public class AppModule {
    @Provides
    Coder provideCoder(Boss boss) {
        return new Coder(boss);
    }
}
 
單例

Dagger支持單例，實現方式也十分簡單：

// @Inject注解構造方法的單例模式
@Singleton
public class Boss {
    ...


@Inject
public Boss() {
    ...
}

...

}</pre>
```java
// @Provides注解提供初始化方法的單例模式
@Provides
@Singleton
Coder provideCoder(Boss boss) {
    return new Coder(boss);
}
 
通過上面的方法添加@Singleton注解之后，對象只會被初始化一次，之后的每次都會被直接注入相同的對象。

Qualifier（限定符）

如果有兩類程序員，他們的能力值power分別是5和1000，應該怎樣讓Dagger對他們做出區分呢？使用@Qualifier注解

首先，創建一個@interface：

@Qualifier
@Documented
@Retention(RUNTIME)
public @interface Level {
  String value() default "";
}
 
然后，為這兩類程序員分別設置@Provides方法，并使用@Qualifier對他們做出不同的標記：

@Provides @Level("low") Coder provideLowLevelCoder() {
    Coder coder = new Coder();
    coder.setName("戰五渣");
    coder.setPower(5);
    return coder;
}

@Provides @Level("high") Coder provideHighLevelCoder() {
    Coder coder = new Coder();
    coder.setName("大神");
    coder.setPower(1000);
    return coder;
}</pre> 
最后，在使用的時候也用上相應的@Qualifier注解。

@Inject @Level("low") Coder lowLevelCoder;
@Inject @Level("high") Coder highLevelCoder;
 
編譯時檢查

實質上，Dagger會在編譯時對代碼進行檢查，并在檢查不通過的時候報編譯錯誤（為什么？這和Dagger的原理有關，有興趣的話可以關注我之后發布的Dagger詳解）。檢查內容主要有三點：


所有含有依賴注入的類，需要被顯式 聲明在相應的Module中。

一個Module中所有@Provides方法的參數都必須在這個Module種提供相應的@Provides方法，或者在@Module注解后添加“complete = false”注明這是一個不完整Module（即它會被其他Module所擴展）。

一個Module中所有的@Provides方法都要被它聲明的注入對象所使用，或者在@Module注解后添加“library = ture”注明（即它是為了擴展其他Module而存在的）。
</ol>

如果需要對Dagger有更多了解，可以參看官方文檔，或者關注我之后的詳解文章。

另外，我們公司友鄰小區招聘Android開發一名，地址北京海淀紫竹橋。

我的Github地址：https://github.com/rengwuxian
來自：http://my.oschina.net/rengwuxian/blog/287892