如何理解Android上的dagger依賴(lài)注入方式

如何理解Android上的dagger依賴(lài)注入方式，很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來(lái)學(xué)習(xí)下，希望你能有所收獲。

簡(jiǎn)介

在開(kāi)發(fā)程序的時(shí)候，會(huì)用到各種對(duì)象，很多對(duì)象在使用之前都需要進(jìn)行初始化。例如你要操作一個(gè)SharedPreference，你需要調(diào)用getSharedPreferences(String name,int mode)來(lái)獲取一個(gè)對(duì)象，然后才能使用它。而如果這個(gè)對(duì)象會(huì)在多個(gè)Activity中被使用，你就需要在每個(gè)使用的場(chǎng)景中都寫(xiě)下同樣的代碼。這不僅麻煩，而且增加了出錯(cuò)的可能。dagger的用途就是：讓你不需要初始化對(duì)象。換句話說(shuō)，任何對(duì)象聲明完了就能直接用。

原理

dagger是使用依賴(lài)注入的方式，使用Annotation給需要注入的對(duì)象做標(biāo)記，通過(guò)inject()方法自動(dòng)注入所有對(duì)象，從而完成自動(dòng)的初始化。
示例代碼：

public class MainActivity extends Activity {      // 通過(guò)@Inject對(duì)對(duì)象進(jìn)行標(biāo)記      @Inject SharedPreferences sharedPreferences;       @Override     protected void onCreate(Bundle savedInstanceState) {          super.onCreate(savedInstanceState);          setContentView(R.layout.activity_main);           // 注入依賴(lài)          ObjectGraph.create(AppModule.class).inject(this);           // 獲取name的值并輸出          System.out.println(sharedPreferences.getString("name", ""));      }  }

依賴(lài)注入(Dependency Injection)：在類(lèi)A中要用到一個(gè)B的對(duì)象（依賴(lài)），需要通過(guò)新建B的實(shí)例或其他一些主動(dòng)的方式來(lái)獲取對(duì)象，然后才能調(diào)用。而通過(guò)外部的方式自動(dòng)將B的對(duì)象分配給A（注入），實(shí)現(xiàn)相對(duì)被動(dòng)的獲取對(duì)象，這個(gè)過(guò)程稱(chēng)為依賴(lài)注入。希望更多了解依賴(lài)注入可以自行Google。

使用方式

以一個(gè)簡(jiǎn)單的“老板和程序員”App為例。你想實(shí)現(xiàn)Boss對(duì)象的自動(dòng)注入，那么首先你要告訴程序它要怎么初始化一個(gè)Boss。在dagger中，為Boss類(lèi)的構(gòu)造方法添加一個(gè)@Inject注解，程序就會(huì)在需要的時(shí)候找到這個(gè)被標(biāo)記的構(gòu)造方法并調(diào)用它，從而獲取一個(gè)Boss對(duì)象。

public class Boss {      ...       @Inject     public Boss() {          ...      }       ...  }

需要注意的是，如果構(gòu)造函數(shù)含有參數(shù)，Dagger會(huì)在構(gòu)造對(duì)象的時(shí)候先去獲取這些參數(shù)（不然誰(shuí)來(lái)傳參？），所以你要保證這些參數(shù)的構(gòu)造方法也有@Inject標(biāo)記，或者能夠通過(guò)@Provides注解（下面會(huì)介紹）來(lái)獲取到。

然后，在聲明Boss對(duì)象的時(shí)候，在前面同樣添加@Inject注解。程序會(huì)在依賴(lài)注入的過(guò)程中自動(dòng)初始化被注解的對(duì)象。

public class MainActivity extends Activity {      @Inject Boss boss;      ...  }

***，創(chuàng)建ObjectGraph類(lèi)并執(zhí)行inject()方法并將當(dāng)前MainActivity作為參數(shù)傳入，Boss的對(duì)象就被注入到了MainActivity中。

public class MainActivity extends Activity {      @Inject Boss boss;       @Override     protected void onCreate(Bundle savedInstanceState) {          ObjectGraph.create(AppModule.class).inject(this);      }      ...  }

到此為止，使用Dagger將一個(gè)Boss對(duì)象注入到MainActivity的流程就完成了。上面這段代碼中出現(xiàn)了兩個(gè)類(lèi)：ObjectGraph和AppModule。其中ObjectGraph是由Dagger提供的類(lèi)，可以簡(jiǎn)單理解為一個(gè)工具類(lèi)，它的create函數(shù)中參數(shù)為所有的Module，本文不詳述，如果有興趣可以跟進(jìn)我之后的Dagger詳解。AppModule是一個(gè)自定義類(lèi)，代碼如下：

@Module(injects = MainActivity.class)  public class AppModule {  }

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

自定義依賴(lài)

對(duì)構(gòu)造方法進(jìn)行注解是很好用的實(shí)現(xiàn)依賴(lài)的途徑，然而它并不適用于所有情況。

• 接口（Interface）是沒(méi)有構(gòu)造方法的

• 第三方庫(kù)提供的類(lèi)，它們的構(gòu)造方法不能被注解

• 有些類(lèi)需要靈活選擇初始化的配置，而不是使用一個(gè)單一的構(gòu)造方法

對(duì)于這樣的情況，可以使用@Provides注解來(lái)提供專(zhuān)用的初始化方法，實(shí)現(xiàn)自定義依賴(lài)。

@Provides Coder provideCoder(Boss boss) {      return new Coder(boss);  }

同樣，@Provides注解的方法如果含有參數(shù)，它的所有參數(shù)也要保證能夠被Dagger獲取到。

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

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

單例

Dagger支持單例，實(shí)現(xiàn)方式也十分簡(jiǎn)單：

// @Inject注解構(gòu)造方法的單例模式  @Singleton public class Boss {      ...       @Inject     public Boss() {          ...      }       ...  }

```java  // @Provides注解提供初始化方法的單例模式  @Provides @Singleton Coder provideCoder(Boss boss) {      return new Coder(boss);  }

通過(guò)上面的方法添加@Singleton注解之后，對(duì)象只會(huì)被初始化一次，之后的每次都會(huì)被直接注入相同的對(duì)象。

Qualifier（限定符）

如果有兩類(lèi)程序員，他們的能力值power分別是5和1000，應(yīng)該怎樣讓Dagger對(duì)他們做出區(qū)分呢？使用@Qualifier注解

首先，創(chuàng)建一個(gè)@interface：

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

然后，為這兩類(lèi)程序員分別設(shè)置@Provides方法，并使用@Qualifier對(duì)他們做出不同的標(biāo)記：

@Provides @Level("low") Coder provideLowLevelCoder() {      Coder coder = new Coder();      coder.setName("戰(zhàn)五渣");      coder.setPower(5);      return coder;  }   @Provides @Level("high") Coder provideHighLevelCoder() {      Coder coder = new Coder();      coder.setName("大神");      coder.setPower(1000);      return coder;  }

***，在使用的時(shí)候也用上相應(yīng)的@Qualifier注解。

@Inject @Level("low") Coder lowLevelCoder;  @Inject @Level("high") Coder highLevelCoder;

編譯時(shí)檢查

實(shí)質(zhì)上，Dagger會(huì)在編譯時(shí)對(duì)代碼進(jìn)行檢查，并在檢查不通過(guò)的時(shí)候報(bào)編譯錯(cuò)誤（為什么？這和Dagger的原理有關(guān)，有興趣的話可以關(guān)注我之后發(fā)布的Dagger詳解）。檢查內(nèi)容主要有三點(diǎn)：

1. 所有含有依賴(lài)注入的類(lèi)，需要被顯式 聲明在相應(yīng)的Module中。

2. 一個(gè)Module中所有@Provides方法的參數(shù)都必須在這個(gè)Module種提供相應(yīng)的@Provides方法，或者在@Module注解后添加“complete = false”注明這是一個(gè)不完整Module（即它會(huì)被其他Module所擴(kuò)展）。

3. 一個(gè)Module中所有的@Provides方法都要被它聲明的注入對(duì)象所使用，或者在@Module注解后添加“l(fā)ibrary = ture”注明（即它是為了擴(kuò)展其他Module而存在的）。

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝您對(duì)億速云的支持。