轉載自:https://blog.csdn.net/hsk256/article/details/51530667
現在Dagger2在項目里用的越來越多了，最近花了些時間學習了一下Dagger2，這篇文章主要幫助理解Dagger2的注入實現過程，如有錯誤，還請指正!
什么是Dagger2
Dagger2是Dagger的升級版，是一個依賴注入框架，現在由Google接手維護。 恩，這里有個關鍵字依賴注入，因此我們得先知道什么是依賴注入，才能更好的理解Dagger2。
依賴注入是面向對象編程的一種設計模式，其目的是為了降低程序耦合，這個耦合就是類之間的依賴引起的。
舉個例子：我們在寫面向對象程序時，往往會用到組合，即在一個類中引用另一個類，從而可以調用引用的類的方法完成某些功能,就像下面這樣.
public class ClassA {
...
ClassB b;
...
public ClassA() {
b = new ClassB();
}
public void do() {
...
b.doSomething();
...
}
}
這個時候就產生了依賴問題，ClassA依賴於ClassB，必須借助ClassB的方法，才能完成一些功能。這樣看好像並沒有什么問題，但是我們在ClassA的構造方法里面直接創建了ClassB的實例，問題就出現在這，在ClassA里直接創建ClassB實例，違背了單一職責原則，ClassB實例的創建不應由ClassA來完成；其次耦合度增加，擴展性差，如果我們想在實例化ClassB的時候傳入參數，那么不得不改動ClassA的構造方法，不符合開閉原則。
因此我們需要一種注入方式，將依賴注入到宿主類（或者叫目標類）中，從而解決上面所述的問題。依賴注入有一下幾種方式：
通過接口注入
interface ClassBInterface { void setB(ClassB b); } public class ClassA implements ClassBInterface { ClassB classB; @override void setB(ClassB b) { classB = b; } }通過set方法注入
public class ClassA { ClassB classB; public void setClassB(ClassB b) { classB = b; } }通過構造方法注入
public class ClassA { ClassB classB; public void ClassA(ClassB b) { classB = b; }通過Java注解
public class ClassA { //此時並不會完成注入，還需要依賴注入框架的支持，如RoboGuice,Dagger2 @inject ClassB classB; ... public ClassA() {}
在Dagger2中用的就是最后一種注入方式，通過注解的方式，將依賴注入到宿主類中。
如何引入Dagger2
配置apt插件(在build.gradle(Project:xxx)中添加如下代碼)
dependencies { classpath 'com.android.tools.build:gradle:2.1.0' //添加apt插件 classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' }添加依賴(在build.gradle(Module:app)中添加如下代碼)
apply plugin: 'com.android.application' //添加如下代碼，應用apt插件 apply plugin: 'com.neenbedankt.android-apt' ... dependencies { ... compile 'com.google.dagger:dagger:2.4' apt 'com.google.dagger:dagger-compiler:2.4' //java注解 compile 'org.glassfish:javax.annotation:10.0-b28' ... }
使用Dagger2
下面用一個栗子來說明，如何使用Dagger2，需要說明的是，這個栗子是基於mvp模式的，所以如果還不了解mvp的話，可以先去了解mvp，再繼續看下面的內容。
在mvp中，最常見的一種依賴關系，就是Activity持有presenter的引用，並在Activity中實例化這個presenter，即Activity依賴presenter，presenter又需要依賴View接口，從而更新UI，就像下面這樣：
public class MainActivity extends AppCompatActivity implements MainContract.View {
private MainPresenter mainPresenter;
...
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//實例化presenter 將view傳遞給presenter
mainPresenter = new MainPresenter(this);
//調用Presenter方法加載數據
mainPresenter.loadData();
...
}
}
public class MainPresenter {
//MainContract是個接口，View是他的內部接口，這里看做View接口即可
private MainContract.View mView;
MainPresenter(MainContract.View view) {
mView = view;
}
public void loadData() {
//調用model層方法，加載數據
...
//回調方法成功時
mView.updateUI();
}
這樣Activity與presenter僅僅耦合在了一起，當需要改變presenter的構造方式時，需要修改這里的代碼。如果用依賴注入的話，是這樣的：
public class MainActivity extends AppCompatActivity implements MainContract.View {
@Inject
MainPresenter mainPresenter;
...
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerMainComponent.builder()
.mainModule(new MainModule(this))
.build()
.inject(this);
//調用Presenter方法加載數據
mainPresenter.loadData();
...
}
}
public class MainPresenter {
//MainContract是個接口，View是他的內部接口，這里看做View接口即可
private MainContract.View mView;
@Inject
MainPresenter(MainContract.View view) {
mView = view;
}
public void loadData() {
//調用model層方法，加載數據
...
//回調方法成功時
mView.updateUI();
}
@Module
public class MainModule {
private final MainContract.View mView;
public MainModule(MainContract.View view) {
mView = view;
}
@Provides
MainView provideMainView() {
return mView;
}
}
@Component(modules = MainModule.class)
public interface MainComponent {
void inject(MainActivity activity);
}
額，貌似變得更復雜了，還不如不用Dagger2呢。不過仔細想想也是可以理解的，直接組合方式雖然簡單，但是具有耦合性，為了解決這種耦合，可能就會多產生一些輔助類，讓這種直接的依賴關系，變為間接，降低耦合。跟大多數設計模式一樣，為了達到高內聚低耦合，往往會有很多接口與類，Daager2也是如此，雖然看似復雜了些，不過這在軟件工程中是值得的。下面，就來分析下上面代碼是什么意思。
我們先看MainActivity里的代碼，之前是直接聲明MainPresenter，現在在聲明的基礎上加了一個注解@Inject，表明MainPresenter是需要注入到MainActivity中，即MainActivity依賴於MainPresenter，這里要注意的是，使用@Inject時，不能用private修飾符修飾類的成員屬性。
然后我們在MainPresenter的構造函數上同樣加了@Inject注解。這樣MainActivity里的mainPresenter與他的構造函數建立了某種聯系。這種聯系我們可以這樣理解，當看到某個類被@Inject標記時，就會到他的構造方法中，如果這個構造方法也被@Inject標記的話，就會自動初始化這個類，從而完成依賴注入。
然后，他們之間並不會憑空建立起聯系，因此我們想到，肯定需要一個橋梁，將他們連接起來，也就是下面要介紹的Component。
Component是一個接口或者抽象類，用@Component注解標注（這里先不管括號里的modules），我們在這個接口中定義了一個inject()方法,參數是Mainactivity。然后rebuild一下項目，會生成一個以Dagger為前綴的Component類，這里是DaggerMainComponent，然后在MainActivity里完成下面代碼.
DaggerMainComponent.builder()
.mainModule(new MainModule(this))
.build()
.inject(this);
此時Component就將@Inject注解的mainPresenter與其構造函數聯系了起來。此時，看到這里，如果是初學者的話，一定會非常迷惑，究竟是怎么建立起聯系的，實例化過程在哪？別急，后面會講解這個過程原理的。
此時我們已經完成了presenter的注入過程，但是我們發現還有一個MainModule類，這個類是做什么的？MainModlue是一個注解類，用@Module注解標注，主要用來提供依賴。等等，剛才通過@Inject就可以完成依賴，為什么這里還要用到Module類來提供依賴？之所以有Module類主要是為了提供那些沒有構造函數的類的依賴，這些類無法用@Inject標注，比如第三方類庫，系統類，以及上面示例的View接口。
我們在MainModule類里聲明了MainContract.View成員屬性，在構造方法里將外界傳進來的view賦值給mView，並通過一個@Provides標注的以provide開頭的方法，將這個view返回，這個以provide開頭的方法就是提供依賴的，我們可以創建多個方法來提供不同的依賴。那么這個類究竟是怎么作用的？可以想到上面提到的@Component注解括號里的東西了。就是下面這個
@Component(modules = MainModule.class)
public interface MainComponent {
void inject(MainActivity activity);
}
所以Module要發揮作用，還是要依靠於Component類，一個Component類可以包含多個Module類，用來提供依賴。我們接着看下面這段代碼：
DaggerMainComponent.builder()
.mainModule(new MainModule(this))
.build()
.inject(this);
這里通過new MainModule(this)將view傳遞到MainModule里，然后MainModule里的provideMainView()方法返回這個View，當去實例化MainPresenter時，發現構造函數有個參數，此時會在Module里查找提供這個依賴的方法，將該View傳遞進去，這樣就完成了presenter里View的注入。
我們來重新理一遍上面的注入過程，首先弄清楚以下幾個概念：
- @Inject 帶有此注解的屬性或構造方法將參與到依賴注入中，Dagger2會實例化有此注解的類
- @Module 帶有此注解的類，用來提供依賴，里面定義一些用@Provides注解的以provide開頭的方法，這些方法就是所提供的依賴，Dagger2會在該類中尋找實例化某個類所需要的依賴。
- @Component 用來將@Inject和@Module聯系起來的橋梁，從@Module中獲取依賴並將依賴注入給@Inject
接着我們重新回顧一下上面的注入過程：首先MainActivity需要依賴MainPresenter，因此，我們在里面用@Inject對MainPresenter進行標注，表明這是要注入的類。然后，我們對MainPresenter的構造函數也添加注解@Inject，此時構造函數里有一個參數MainContract.View，因為MainPresenter需要依賴MainContract.View，所以我們定義了一個類，叫做MainModule，提供一個方法provideMainView，用來提供這個依賴，這個MainView是通過MainModule的構造函數注入進來的，接着我們需要定義Component接口類，並將Module包含進來，即
@Component(modules = MainModule.class)
public interface MainComponent {
void inject(MainActivity activity);
}
同時里面聲明了一個inject方法，方法參數為ManActivity，用來獲取MainActivity實例，以初始化在里面聲明的MainPresenter
DaggerMainComponent.builder()
.mainModule(new MainModule(this))
.build()
.inject(this);
此時，注入過程就完成了，或許到此時，還是會有一些疑惑，因為我們看不到實例化的過程在哪里，為什么要這樣去寫代碼，所以下面，就基於這個實例，分析Dagger2內部究竟做了什么。
Dagger2注入原理
Dagger2與其他依賴注入框架不同，它是通過apt插件在編譯階段生成相應的注入代碼，下面我們就具體看看Dagger2生成了哪些注入代碼？
我們先看MainPresenter這個類，在這個類中我們對構造方法用了@Inject標注，然后Rebuild Project，Dagger2會在/app/build/generated/apt/debug/目錄下生成一個對應的工廠類MainPresenter_Factory，我們看下面具體代碼（為了方便理解，我把MainPresenter也貼了出來）
public class MainPresenter {
MainContract.View mView;
@Inject
MainPresenter(MainContract.View view) {
mView = view;
}
}
public final class MainPresenter_Factory implements Factory<MainPresenter> {
private final Provider<MainContract.View> viewProvider;
public MainPresenter_Factory(Provider<MainContract.View> viewProvider) {
assert viewProvider != null;
this.viewProvider = viewProvider;
}
@Override
public MainPresenter get() {
return new MainPresenter(viewProvider.get());
}
public static Factory<MainPresenter> create(Provider<MainContract.View> viewProvider) {
return new MainPresenter_Factory(viewProvider);
}
}
對比MainPresenter,我們發現在MainPre_Factory里也生成了對應的代碼。首先是viewProvide，這是一個Provider類型，泛型參數就是我們的MainContract.View，接着通過構造方法，對viewProvider進行實例化。其實這里有個疑惑，上面的成員屬性為什么不直接是MainContract.View，而是Provider類型？看到provider我們應該想到這個MainContract.View是一個依賴，而依賴的提供者是MainModule，因此這個viewProvider一定是由MainModul提供的。我們接着看下面的get()方法，看到這個方法，我想我們有點恍然大悟的感覺，原來MainPresenter的實例化就在這里，構造函數里的參數就是我們依賴的MainContract.View，它是由viewProvider通過get()提供。接着是一個create()方法，並且有一個參數viewProvider，用來創建這個MainPresenter_Factory類。
上面我們得出，viewProvider是由MainModule提供的，所以我們接着看MainModule所對應的注入類。
@Module
public class MainModule {
private final MainContract.View mView;
public MainModule(MainContract.View view) {
mView = view;
}
@Provides
MainContract.View provideMainView() {
return mView;
}
}
public final class MainModule_ProvideMainViewFactory implements Factory<MainContract.View> {
private final MainModule module;
public MainModule_ProvideMainViewFactory(MainModule module) {
assert module != null;
this.module = module;
}
@Override
public MainContract.View get() {
return Preconditions.checkNotNull(
module.provideMainView(), "Cannot return null from a non-@Nullable @Provides method");
}
public static Factory<MainContract.View> create(MainModule module) {
return new MainModule_ProvideMainViewFactory(module);
}
}
看到上面的類名，我們發現了一種對應關系，在MainModule中定義的@Provides修飾的方法會對應的生成一個工廠類，這里是MainModule_ProvideMainViewFactory。我們看到這個類里有一個get()方法，其中調用了MainModule里的provideMainView()方法來返回我們所需要的依賴MainContract.View。還記得在MainPresenter_Factory里的get()方法中，實例化MainPresenter時候的參數viewProvider.get()嗎？到這里我們就明白了，原來那個viewProvider就是生成的MainModule_ProvideMainViewFactory，然后調用了其get()方法，將我們需要的MainContract.View注入到MainPresenter里。
看到這里我們應該明白了MainPresenter的實例化過程。MainPresenter會對應的有一個工廠類，在這個類的get()方法中進行MainPresenter創建，而MainPresenter所需要的View依賴，是由MainModule里定義的以provide開頭的方法所對應的工廠類提供的。
雖然我們明白了實例化的創建過程，但是此時還是有點疑惑，MainPresenter_Factory的創建是由create()完成的，那么crate是在哪調用的，此時創建的MainPresenter實例是怎么跟@Inject注解的MainPresenter關聯起來的，我想你已經知道了答案，沒錯就是Component。前面說過Component是連接@Module和@Inject的橋梁，所以上面的疑惑就要到編譯后Component所對應的類中尋找答案。
@Component(modules = MainModule.class)
public interface MainComponent {
void inject(MainActivity activity);
}
public final class DaggerMainComponent implements MainComponent {
private Provider<MainContract.View> provideMainViewProvider;
private Provider<MainPresenter> mainPresenterProvider;
private MembersInjector<MainActivity> mainActivityMembersInjector;
private DaggerMainComponent(Builder builder) {
assert builder != null;
initialize(builder);
}
public static Builder builder() {
return new Builder();
}
@SuppressWarnings("unchecked")
private void initialize(final Builder builder) {
this.provideMainViewProvider = MainModule_ProvideMainViewFactory.create(builder.mainModule);
this.mainPresenterProvider = MainPresenter_Factory.create(provideMainViewProvider);
this.mainActivityMembersInjector = MainActivity_MembersInjector.create(mainPresenterProvider);
}
@Override
public void inject(MainActivity activity) {
mainActivityMembersInjector.injectMembers(activity);
}
public static final class Builder {
private MainModule mainModule;
private Builder() {}
public MainComponent build() {
if (mainModule == null) {
throw new IllegalStateException(MainModule.class.getCanonicalName() + " must be set");
}
return new DaggerMainComponent(this);
}
public Builder mainModule(MainModule mainModule) {
this.mainModule = Preconditions.checkNotNull(mainModule);
return this;
}
}
}
從上面代碼看到定義的MainComponent會生成一個對應的DaggerMainComponent，並且實現了MainComponent里的方法。我們看到代碼中又出現了Provide類型的成員屬性，前面說過這個Provide類型就是所提供的依賴，我們在看它們是在哪實例化的。我們看到有一個initialize()方法
@SuppressWarnings("unchecked")
private void initialize(final Builder builder) {
this.provideMainViewProvider = MainModule_ProvideMainViewFactory.create(builder.mainModule);
this.mainPresenterProvider = MainPresenter_Factory.create(provideMainViewProvider);
this.mainActivityMembersInjector = MainActivity_MembersInjector.create(mainPresenterProvider);
}
看到這估計就明白了剛才的疑惑。首先創建了MainModule_ProvideMainViewFactory實例，用來提供MainContract.View依賴。這里可能有個小疑惑，create()方法返回的是Factory類型，而provideMainViewProvider是個Provider類型，其實看源碼就明白了，Factory繼承自Provider。
public interface Factory<T> extends Provider<T> {
}
然后將provideMainViewProvider傳遞到MainPresenter_Factory里，即就是前面講到的viewProvider。接着將這個mainPresenterProvider又傳遞到MainActivity_MembersInjector中進行實例化，我們看到這個類前面是MainActivity開頭，因此可以想到是MainActivity對應得注入類，我們后面再分析這個類。
接着是我們在MainComponent里定義的Inject方法的實現，這里調用了mainActivityMembersInjector.injectMembers(activity)方法，將我們的MainActivity注入到該類中。
接着就是Builder內部類，用來創建我們的module以及自身實例。所以在DaggerMainComponent里主要用來初始化依賴，而真正的將這些依賴於Inject關聯起來的就是剛才的MainActivity_MembersInjector類，我們看看這個類里做了什么。
public final class MainActivity_MembersInjector implements MembersInjector<MainActivity> {
private final Provider<MainPresenter> mainPresenterProvider;
public MainActivity_MembersInjector(Provider<MainPresenter> mainPresenterProvider) {
assert mainPresenterProvider != null;
this.mainPresenterProvider = mainPresenterProvider;
}
public static MembersInjector<MainActivity> create(
Provider<MainPresenter> mainPresenterProvider) {
return new MainActivity_MembersInjector(mainPresenterProvider);
}
@Override
public void injectMembers(MainActivity instance) {
if (instance == null) {
throw new NullPointerException("Cannot inject members into a null reference");
}
instance.mainPresenter = mainPresenterProvider.get();
}
public static void injectMainPresenter(
MainActivity instance, Provider<MainPresenter> mainPresenterProvider) {
instance.mainPresenter = mainPresenterProvider.get();
}
}
這個類的關鍵就是injectMembers()方法，還記得這個方法在哪調用嗎?我想你肯定記得，就在剛才提到的DaggerMainComponent類中的inject()方法里,所以這里的instance實例是由DaggerMainComponent提供的，然后我們看到了最關鍵的一句代碼
instance.mainPresenter = mainPresenterProvider.get();
看到這，我想應該一切都明白了，將mainPresenterProvider中創建好的MainPresenter實例賦值給instance(MainActivity)的成員mainPresenter，這樣我們用@Inject標注的mainPresenter就得到了實例化，接着就可以在代碼中使用了。
到這里，就分析完了Dagger2的注入過程，如果不去看這些生成的類，就很難理解整個過程究竟是怎么發生的，從而導致還是不知道怎么去使用這個依賴注入框架。所以重點去理解這個內部實現原理是非常重要的，剛開始學的時候也是一臉懵逼，總搞不太清之間的關系，不知道究竟怎么寫，弄懂了整個來龍去脈后，發現就知道怎么去運用了。
關於Dagger2的其他使用就不多講了，可以看其他的優秀博客，我會再后面附上鏈接，方便學習。Dagger2就是一個依賴注入工具，至於怎么使用完全在個人，所以不必糾結到底怎么去寫才是正確的，只要弄懂原理，靈活運用，能夠做到盡可能解耦，適合自己的業務就是最好的寫法。
感謝：
http://www.jianshu.com/p/cd2c1c9f68d4
http://alighters.com/blog/2016/04/15/dagger2-indepth-understanding/
http://chriszou.com/2016/05/10/android-unit-testing-di-dagger.html
http://blog.nimbledroid.com/2016/03/07/performance-of-dependency-injection-libraries-zh.html