引入Dagger2
首先，我們需要將Dagger2的依賴寫入我們的gradle中，具體配置如下
android {
...
}
dependencies {
...
compile "com.google.dagger:dagger:2.8"
annotationProcessor "com.google.dagger:dagger-compiler:2.8"
provided 'javax.annotation:jsr250-api:1.0'
compile 'javax.inject:javax.inject:1'
...
}
配置好之后就可以使用dagger2了。
注解
這里先講講四種基礎(chǔ)的注解，他們分別是：
- @Inject Inject主要有兩個(gè)作用，一個(gè)是使用在構(gòu)造函數(shù)上，通過(guò)標(biāo)記構(gòu)造函數(shù)讓Dagger2來(lái)使用（Dagger2通過(guò)Inject標(biāo)記可以在需要這個(gè)類實(shí)例的時(shí)候來(lái)找到這個(gè)構(gòu)造函數(shù)并把相關(guān)實(shí)例new出來(lái)）從而提供依賴，另一個(gè)作用就是標(biāo)記在需要依賴的變量讓Dagger2為其提供依賴。
- @Provides 用Provides來(lái)標(biāo)注一個(gè)方法，該方法可以在需要提供依賴時(shí)被調(diào)用，從而把預(yù)先提供好的對(duì)象當(dāng)做依賴給標(biāo)注了@Injection的變量賦值。Provides主要用于標(biāo)注Module里的方法
- @Module 用Module標(biāo)注的類是專門用來(lái)提供依賴的。有的人可能有些疑惑，看了上面的@Inject，需要在構(gòu)造函數(shù)上標(biāo)記才能提供依賴，那么如果我們需要提供的類構(gòu)造函數(shù)無(wú)法修改怎么辦，比如一些jar包里的類，我們無(wú)法修改源碼。這時(shí)候就需要使用Module了。Module可以給不能修改源碼的類提供依賴，當(dāng)然，能用Inject標(biāo)注的通過(guò)Module也可以提供依賴
- @Component Component一般用來(lái)標(biāo)注接口，被標(biāo)注了Component的接口在編譯時(shí)會(huì)產(chǎn)生相應(yīng)的類的實(shí)例來(lái)作為提供依賴方和需要依賴方之間的橋梁，把相關(guān)依賴注入到其中。
example
我們想在activity中調(diào)用Car。下面是car類
public class Car {
@Inject
public Car() {
}
public String run() {
return "car run ";
}
}
給car的構(gòu)造方法添加Inject注解，Dagger2通過(guò)Inject注解可以在需要Car這個(gè)類實(shí)例的時(shí)候來(lái)找到這個(gè)構(gòu)造函數(shù)并把相關(guān)實(shí)例new出來(lái)。
接下來(lái)需要一個(gè)Component，代碼如下：
@Component
public interface CarComponent {
void inject(CarActivity activity);
}
添加完CarComponent類后，先build一下，會(huì)生成一個(gè)DaggerCarComponent的類。DaggerCarComponent是CarComponent的一個(gè)實(shí)現(xiàn)類。DaggerCarComponent的作用是把需要注入的對(duì)象注入到CarActivity里面。
然后在Activity里注入這個(gè)Car，代碼如下：
@Inject
Car mCar;
private CarComponent mCarComponent;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_car);
mCarComponent = DaggerCarComponent.builder().build();
mCarComponent.inject(this);
TextView text = findViewById(R.id.text);
text.setText(mCar.run());
}
運(yùn)行代碼，效果如下：
上面的例子只是用到了Inject和Component，下面介紹一下另外兩個(gè)注解的用法。
假設(shè)Car這個(gè)類事第三方的類，而且我們沒(méi)有辦法修改這個(gè)類（就是不能在這個(gè)類的構(gòu)造函數(shù)上加上@Inject的注解），這個(gè)時(shí)候就需要用到Provides和Module。先把Car的構(gòu)造函數(shù)上的@Inject給去掉，
public class Car {
public Car() {
}
public String run() {
return "car run ";
}
}
然后創(chuàng)建一個(gè)Module類，來(lái)提供Car的實(shí)例，代碼如下：
@Module
public class CarModule {
@Provides
public Car provide(){
return new Car();
}
}
@Provides表明這個(gè)是一個(gè)提供實(shí)例的方法，Dagger2在實(shí)例化被注入的對(duì)象的時(shí)候，會(huì)先去找有沒(méi)有被@Provides標(biāo)記的提供對(duì)象實(shí)例的方法，如果沒(méi)有就會(huì)去找有沒(méi)有背@Inject標(biāo)記的構(gòu)造方法。
接下來(lái)把Module與Component關(guān)聯(lián)起來(lái)，修改CarComponent，添加modules = CarModule.class，代碼如下：
@Component(modules = CarModule.class)
public interface CarComponent {
void inject(CarActivity activity);
}
這里再說(shuō)明一個(gè)問(wèn)題，我們有兩種方式可以提供依賴，一個(gè)是注解了@Inject的構(gòu)造方法，一個(gè)是在Module里提供的依賴，那么Dagger2是怎么選擇依賴提供的呢，規(guī)則是這樣的：
- 步驟1：查找Module中是否存在創(chuàng)建該類的方法。
- 步驟2：若存在創(chuàng)建類方法，查看該方法是否存在參數(shù)
- 步驟2.1：若存在參數(shù)，則按從步驟1開始依次初始化每個(gè)參數(shù)
- 步驟2.2：若不存在參數(shù)，則直接初始化該類實(shí)例，一次依賴注入到此結(jié)束
- 步驟3：若不存在創(chuàng)建類方法，則查找Inject注解的構(gòu)造函數(shù)，看構(gòu)造函數(shù)是否存在參數(shù)
- 步驟3.1：若存在參數(shù)，則從步驟1開始依次初始化每個(gè)參數(shù)
- 步驟3.2：若不存在參數(shù)，則直接初始化該類實(shí)例，一次依賴注入到此結(jié)束
然后運(yùn)行一下代碼，效果和上一個(gè)一樣。
下面介紹一個(gè)注入TextView的例子：
新建一個(gè)TextViewModule，代碼如下：
@Module
public class TextViewModule {
private Context mContext;
public TextViewModule(Context context) {
mContext = context;
}
@Provides
public TextView provideTextView() {
return new TextView(mContext);
}
}
provideTextView用于提供TextView。然后把這個(gè)Module和Component關(guān)聯(lián)起來(lái)。代碼如下：
@Component(modules = {CarModule.class, TextViewModule.class})
public interface CarComponent {
void inject(CarActivity activity);
}
在modules中再加一個(gè)TextViewModule.class就好。然后把TextView注入到CarActivity中，最后再把這個(gè)TextView添加到Activity的content view里面。代碼如下：
public class CarActivity extends Activity {
@Inject
Car mCar;
@Inject
TextView mTextView;
private CarComponent mCarComponent;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_car);
mCarComponent = DaggerCarComponent.builder().textViewModule(new TextViewModule(this)).build();
mCarComponent.inject(this);
ViewGroup root = findViewById(android.R.id.content);
root.addView(mTextView);
mTextView.setText("added TextView");
TextView text = findViewById(R.id.text);
text.setText(mCar.run());
}
}
這里要說(shuō)一下textViewModule(new TextViewModule(this))這句代碼，這里是給Component添加一個(gè)TextViewModule的實(shí)例，每當(dāng)Component關(guān)聯(lián)一個(gè)Module的時(shí)候，Component的實(shí)現(xiàn)類都會(huì)增加一個(gè)傳入Module實(shí)例的方法，DaggerCarComponent中就會(huì)有如下兩個(gè)方法。
public Builder carModule(CarModule carModule) {
this.carModule = Preconditions.checkNotNull(carModule);
return this;
}
public Builder textViewModule(TextViewModule textViewModule) {
this.textViewModule = Preconditions.checkNotNull(textViewModule);
return this;
}
那我們?yōu)樯恫挥玫鬰arModule來(lái)傳入一個(gè)CarModule對(duì)象呢？因?yàn)镃arModule有一個(gè)無(wú)參數(shù)的構(gòu)造方法，Dagger會(huì)默認(rèn)去掉這個(gè)無(wú)參數(shù)的構(gòu)造方法，而TextViewModule則沒(méi)這種構(gòu)造方法，這需要在用的時(shí)候調(diào)運(yùn)textViewModule(new TextViewModule(this))。
下面來(lái)看一下運(yùn)行效果：
