Dagger2是什么
Dagger2是一款基于Java注解來(lái)實(shí)現(xiàn)的完全在編譯階段完成依賴注入的開源庫(kù)，主要用于模塊間解耦鸽捻、提高代碼的健壯性和可維護(hù)性。Dagger2在編譯階段通過(guò)apt利用Java注解自動(dòng)生成Java代碼泽腮，然后結(jié)合手寫的代碼來(lái)自動(dòng)幫我們完成依賴注入的工作御蒲。
Dagger 2 is the first to implement the full stack with generated code.
概念有點(diǎn)官方抽象，上面提到的依賴注入是什么東西呢诊赊？
依賴注入(Dependency Injection)
在類A中要用到一個(gè)B的對(duì)象（A依賴B）厚满，需要通過(guò)新建B的實(shí)例或其他一些主動(dòng)的方式來(lái)獲取對(duì)象，然后才能調(diào)用碧磅。而通過(guò)外部的方式自動(dòng)將B的對(duì)象分配給A（注入）碘箍，實(shí)現(xiàn)被動(dòng)方式來(lái)獲取對(duì)象，這個(gè)過(guò)程稱為依賴注入鲸郊。
你可以先簡(jiǎn)單的理解Dagger2就是讓你不需要初始化對(duì)象了丰榴，任何對(duì)象聲明完了就可以直接使用。
使用前的準(zhǔn)備
添加apt插件
build.gradle(project)
dependencies {
classpath 'com.android.tools.build:gradle:3.3.2'
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
引入dagger2依賴
bulid.gradle(app)
implementation 'com.google.dagger:dagger:2.6'
annotationProcessor 'com.google.dagger:dagger-compiler:2.6'
注意：上面的兩個(gè)版本盡量一致秆撮，要不然可能會(huì)拋異常
dagger.Provides missing element type
初步使用
寫一個(gè)栗子：構(gòu)造一個(gè)汽車
不用Dagger2的普通寫法：
輪胎
public class Tyre {
@Override
public String toString() {
return "我是輪胎";
}
}
汽車類
public class Car {
Tyre tyre; //輪胎
public Car(){
tyre = new Tyre();
}
public Tyre getTyre() {
return tyre;
}
public void setTyre(Tyre tyre) {
this.tyre = tyre;
}
@Override
public String toString() {
return "Car{" +
"tyre=" + tyre +
'}';
}
}
MainActivity
public class MainActivity extends AppCompatActivity {
Car mCar;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mCar = new Car();
System.out.println(mCar.toString());
}
}
運(yùn)行結(jié)果：Car{tyre=我是輪胎}
可見不用Dagger2的普通寫法四濒，我們是需要主動(dòng)創(chuàng)建汽車對(duì)象，也就是說(shuō)要通過(guò)實(shí)例化汽車對(duì)象來(lái)實(shí)現(xiàn)依賴职辨。
那么使用Dagger2就不需要在依賴的類中通過(guò)new來(lái)創(chuàng)建依賴盗蟆，也就是說(shuō)不需要 mCar = new Car() 這一步了。
使用Dagger2更改之前先看這幾個(gè)注解：
- @inject：聲明依賴注入的對(duì)象
- @Moudle：依賴提供方舒裤，負(fù)責(zé)提供依賴中所需要的對(duì)象
- @Component：依賴注入組件喳资，負(fù)責(zé)將依賴注入到依賴需求方。
- @Provides：會(huì)根據(jù)返回值類型在有此注解的方法中尋找應(yīng)調(diào)用的方法
使用Dagger2改寫
添加一個(gè)汽車Module類
用于提供對(duì)象腾供，需要用到@Module和@Providers注解
@Module
public class CarModule {
@Provides
public Car getCar(){
return new Car();
}
}
添加一個(gè)MainComponent接口
用于表示給哪些類注入哪些對(duì)象仆邓。需要用到@Component
比如這里我的MainActivity類需要用到Car對(duì)象亏栈，那么就可以新建一個(gè)接口，在接口上添加注解@Component宏赘，并把剛剛寫好的的CarModule加上。并在接口下的新增一個(gè)注入方法黎侈，把需要使用該對(duì)象的類作為參數(shù)傳入進(jìn)來(lái)察署。
@Component(modules = CarModule.class)
public interface MainComponent {
void inject(MainActivity mainActivity);
}
修改MainActivity
去掉主動(dòng)創(chuàng)建Car對(duì)象的方式，需要使用@Inject
public class MainActivity extends AppCompatActivity {
@Inject
Car mCar;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
MainComponent mainComponent = DaggerMainComponent.create();
mainComponent.inject(this);
System.out.println(mCar.toString());
}
}
在運(yùn)行之前峻汉，需要先Build > Make Project
apt會(huì)自動(dòng)生成一個(gè)DaggerMainComponent類（這個(gè)類在app->build->generated->source->apt->debuge->com.xxxx.xxxx包下）贴汪，我們就可以利用這個(gè)類來(lái)實(shí)現(xiàn)依賴注入。之后簡(jiǎn)單的分析一下這個(gè)類如何工作的休吠。
分析自動(dòng)生成的輔助代碼
apt生成的輔助類做了什么實(shí)現(xiàn)類這些依賴注入的呢扳埂？
public final class DaggerMainComponent implements MainComponent {
private Provider<Car> getCarProvider;
private MembersInjector<MainActivity> mainActivityMembersInjector;
private DaggerMainComponent(Builder builder) {
assert builder != null;
initialize(builder);
}
public static Builder builder() {
return new Builder();
}
public static MainComponent create() {
return builder().build();
}
@SuppressWarnings("unchecked")
private void initialize(final Builder builder) {
this.getCarProvider = CarModule_GetCarFactory.create(builder.carModule);
this.mainActivityMembersInjector = MainActivity_MembersInjector.create(getCarProvider);
}
//注入依賴的具體實(shí)現(xiàn)
@Override
public void inject(MainActivity mainActivity) {
mainActivityMembersInjector.injectMembers(mainActivity);
}
public static final class Builder {
private CarModule carModule;
private Builder() {}
public MainComponent build() {
if (carModule == null) {
this.carModule = new CarModule();
}
return new DaggerMainComponent(this);
}
public Builder carModule(CarModule carModule) {
this.carModule = Preconditions.checkNotNull(carModule);
return this;
}
}
}
通過(guò)建造者設(shè)計(jì)模式創(chuàng)建了DaggerMainComponent和CarModule對(duì)象，然后具體實(shí)現(xiàn)了inject方法：通過(guò)一個(gè)注射器將需要該依賴對(duì)象的類對(duì)象（這里是MainActivity對(duì)象）注入進(jìn)去瘤礁。
注入后會(huì)調(diào)用injectMembers方法阳懂，可以看出來(lái)Car對(duì)象在這里就被賦值創(chuàng)建了。
public void injectMembers(MainActivity instance) {
if (instance == null) {
throw new NullPointerException("Cannot inject members into a null reference");
}
instance.mCar = mCarProvider.get();
}
這里的instance就是MainActivity 的實(shí)例對(duì)象柜思，而mCar就是我們?cè)贛ainActivity聲明的Car對(duì)象岩调。之后調(diào)用mCarProvider的get方法會(huì)調(diào)用下面的方法：
//調(diào)用carModule的getCar方法獲取Car的實(shí)例對(duì)象
public Car get() {
return Preconditions.checkNotNull(
module.getCar(), "Cannot return null from a non-@Nullable @Provides method");
}
看到 module.getCar() 就知道它調(diào)用了CarModule的getCar方法創(chuàng)建了Car對(duì)象。
總結(jié)
到這里你可能有點(diǎn)哭笑不得赡盘，一句new就可以完成的功能怎么讓你玩的這么復(fù)雜了呢号枕，沒(méi)這么寫必要吧。其實(shí)陨享，這里筆者是為了讓你好理解葱淳，Dagger2還是挺難上手的，如果一開始就用特別復(fù)雜的例子來(lái)解釋會(huì)讓觀眾大大看起來(lái)云里霧里抛姑。這也是筆者看了很多寫Dagger博客的通病赞厕，所以才動(dòng)手寫這篇博客的目的。當(dāng)然定硝，之后還會(huì)寫它的最佳實(shí)踐坑傅，那時(shí)候你就會(huì)發(fā)現(xiàn)它的好處和強(qiáng)大了。
