前言
最近在做項目中窟赏，用到了Dagger2，所以找了一些博客和其他的一些學習資源箱季，算是知道如何使用了涯穷，但是對其理解還相差很遠。所以這篇文章重點針對與使用藏雏，和使用中常見的一些問題拷况。對更深層的東西我就不再這里不懂裝懂了。如果以后有機會或需要會在以后學習更加深入后在另寫文章掘殴。
Dagger2
根據官網來說他就是一個快速的依賴注入框架赚瘦。如果對依賴注入不太了解，那么請看這篇文章依賴注入原理奏寨，在這里我就不過多介紹了起意。其實他的作用重點就是解耦和管理實例對象。那我們看看他具體有什么好處：
依賴的注入和配置獨立于組件之外病瞳，注入的對象在一個獨立揽咕、不耦合的地方初始化，這樣在改變注入對象時套菜，我們只需要修改對象的實現方法亲善，而不用大改代碼庫。
依賴可以注入到一個組件中：我們可以注入這些依賴的模擬實現逗柴，這樣使得測試更加簡單蛹头。
app中的組件不需要知道有關實例創(chuàng)建和生命周期的任何事情，這些由我們的依賴注入框架管理的
這是網上的一切說法。對于文字我們不好理解掘而，還是看看在具體應用中我們該如何去使用挟冠。不過在使用之前我們先簡單的理解及概念。
@Inject:
通常在需要依賴的地方使用這個注解袍睡。換句話說知染，你用它告訴Dagger這個類或者字段需要依賴注入。這樣斑胜，Dagger就會構造一個這個類的實例并滿足他們的依賴控淡。
@Module:
Modules類里面的方法專門提供依賴，所以我們定義一個類止潘，用@Module注解掺炭，這樣Dagger在構造類的實例的時候，就知道從哪里去找到需要的 依賴凭戴。modules的一個重要特征是它們設計為分區(qū)并組合在一起（比如說涧狮，我們的app中可以有多個組成在一起的modules）
@Provide:
在modules中，我們定義的方法是用這個注解么夫，以此來告訴Dagger我們想要構造對象并提供這些依賴者冤。
@Component:
Components從根本上來說就是一個注入器，也可以說是@Inject和@Module的橋梁档痪，它的主要作用就是連接這兩個部分涉枫。
讀不懂也沒關系，我們接下來實戰(zhàn)代碼腐螟。在講解后在結合概念我們就能很好的理解了
引入
引入方法有2種：
第一種：
在工程的build.gradle文件中添加android-apt插件（該插件后面介紹）
buildscript {
....
dependencies {
classpath 'com.android.tools.build:gradle:2.1.0'
// 添加android-apt 插件
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
}
在app的中的build.gradle文件中添加配置
apply plugin: 'com.android.application'
// 應用插件
apply plugin: 'com.neenbedankt.android-apt'
android {
compileSdkVersion 23
buildToolsVersion "23.0.2"
defaultConfig {
applicationId "com.mahao.alex.architecture"
minSdkVersion 15
targetSdkVersion 23
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.3.0'
// dagger 2 的配置
compile 'com.google.dagger:dagger:2.4'
apt 'com.google.dagger:dagger-compiler:2.4'
compile 'org.glassfish:javax.annotation:10.0-b28'// 添加java 注解庫
}
以上兩個配置就可以了愿汰。
android-apt是Gradle編譯器的插件，根據其官方文檔乐纸，主要兩個目的：
編譯時使用該工具衬廷，最終打包時不會將該插件打入到apk中。
能夠根據設置的源路徑锯仪，在編譯時期生成相應代碼泵督。
在導入類庫時，
compile 'com.google.dagger:dagger:2.4'
apt 'com.google.dagger:dagger-compiler:2.4'
dagger是主要的工具類庫庶喜。dagger-compiler為編譯時期生成代碼等相關的類庫。
在android-apt的文檔中救鲤，也推薦使用這種方式久窟。因為，編譯時期生成代碼的類庫在運行期并不需要本缠，那么將其分為兩個庫斥扛，（運行類庫dagger）和（編譯器生成代碼類庫（dagger-compiler）），那么在打包時，就不需要將dagger-compiler打入其中（用不到）稀颁，減小APK 的大小
第二種：
這種方法比較簡單(Android Studio2.2以上)芬失，直接引入依賴
compile 'com.google.dagger:dagger:2.9'
annotationProcessor 'com.google.dagger:dagger-compiler:2.9'
推薦第一種方式
實踐
public class ApiService {
public void register() {
//注冊的方法
Log.i("TAG", "ApiService: ");
}
}
public class UserStroe {
public void login(){
//登錄的方法
}
}
首先假設我們現在有兩個方法，一個是注冊匾灶，另一個是登錄棱烂。如果我們現在MainActivity中調用register();我們一般會這么寫：
ApiSeivie apiServce=new ApiService();
apiService.register();
如果們們使用Dagger2該如何使用呢？
- module
首先：我們先創(chuàng)建module(他是主要提供實例的類)阶女，這里我們定義為UserModule：
@Module
public class UserModule {
public UserModule() {
}
@Provides
public ApiService provideApiService() {
return new ApiService();
}
}
@Module:
Modules類里面的方法專門提供依賴颊糜，所以我們定義一個類，用@Module注解秃踩，這樣Dagger在構造類的實例的時候衬鱼，就知道從哪里去找到需要的依賴。
@Provide:
在modules中憔杨，我們定義的方法是用這個注解鸟赫，以此來告訴Dagger我們想要構造對象并提供這些依賴。
現在我們回頭在看看概念是不就明白其中的含義了消别。
可以看到我們在MainActivity中需要ApiService惯疙，我們在module中創(chuàng)建他的實例。等他需要的時候我們就給他⊙叮現在module創(chuàng)建好了霉颠。我們還需要調用者(MainActivity)和被調用者(module)之間的橋梁，這就是Component荆虱。
注意蒿偎，在module中，我們創(chuàng)建的方法必須是public不可以是privite怀读。這個也很好理解诉位。我們創(chuàng)建的方法本來就是給外界調用的，如果你用privite的話只能本類使用了菜枷。
Component：
@Component(modules = {UserModule.class})
public interface UserComponet {
void inject(MainActivity activity);
}
注意：inject方法接收父類型參數苍糠，而調用時傳入的是子類型對象則無法注入。比如你想作用BaseActivity啤誊，inject()就傳入BaseActivity,但是只能作用BaseActivity不能作用子類MainActivity岳瞭。反之亦然；
@Component：
我們定義UserComponet并加上@Component注解蚊锹。表明他是一個橋梁瞳筏。首先他必須是一個接口。其次我們必須依賴一個module(當然牡昆，從{}這個符號我們就可以看到姚炕，他可以同時依賴多個module)，它還有另一參數dependencies，這里我們先不說他柱宦，等后面講到了再說他些椒。這里我們看到他里面只有一個方法 void inject().這里我們傳入MainActivity，因為我們想在這個類中使用我們實例ApiService掸刊。這樣module和MainActivity通過Component就關聯起來了免糕。創(chuàng)建好這些類以后我們需要Rebuild Progect。
這是會生成一個DaggerUserComponet類痒给，這個類命名是以Dagger開頭接上我們UserComponet類名说墨。這個類方法很少，主要就是將我們的MainActivity和Component關聯起來苍柏，通過：
DaggerUserComponet.create().inject(this);
將我們的MainActivity傳入Component的inject()方法中尼斧，這樣這個橋梁就就通了，我們就可以使用了试吁，如下：
public class MainActivity extends AppCompatActivity {
@Inject
ApiService mApiService;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerUserComponet.create().inject(this);
mApiService.register();
Log.d("TAG", "onCreate: " + mApiService);
}
}
注意 這里我們 @Inject注解的對象不能用privite修飾棺棵。
在我們的想要的創(chuàng)建的對象加上@Inject注解并且調用DaggerUserComponet.create().inject(this);后我們就可以使用這個對象了。我們運行看看結果：
dagger2 D/TAG: ApiService:
com.example.ggxiaozhi.dagger2 D/TAG: onCreate: com.example.ggxiaozhi.dagger2.ApiService@4a7c73b4
可以看到正常運行沒有問題了熄捍。實例對象已經被我們創(chuàng)建出來了烛恤。我們用2張圖總結一下：
這張圖從概念出發(fā)，我們再從我們的例子中總結出來經驗概括就是這樣的：
明白了流程后那他是怎么解耦的呢余耽？使用方法就這么簡單就結束了嗎缚柏？答案是肯定的。我們一定不止這么簡單碟贾，關于解耦的話我就舉一個簡單的例子币喧。之前我們創(chuàng)建了2個類注冊和登錄，現在我們再創(chuàng)建一個類去管理他們：
public class UserManager {
UserStroe mUserStroe;
ApiService mApiService;
public UserManager() {
mApiService = new ApiService();
mUserStroe = new UserStroe();
}
public void register() {
mApiService.register();
mUserStroe.login();
}
}
然后我們在MainActivity中去調用UserManager中的register方法袱耽。這么一個看好像是沒什么問題杀餐，但是如果我們mApiService.register();需要一個Context參數怎么辦？你可能會這么該：
public class UserManager {
UserStroe mUserStroe;
ApiService mApiService;
public UserManager(Context context) {
mApiService = new ApiService(context);
mUserStroe = new UserStroe();
}
public void register() {
mApiService.register();
mUserStroe.login();
}
}
調用處new UserManager(this);但是你注意看朱巨，我們只是需要一個context就要將UserManager和MainActivity中的代碼都要改史翘，要是在實際項目中，需要改更多的參數呢冀续？所以我們來看下用Dagger2該如何解決琼讽。這里我把需求再復雜話一些。首先我們還是先從module來看：
這里我們將例子復雜一下假設ApiService需要一個context沥阳，userStroe需要一個url跨琳。我們就可以這樣寫
@Module
public class UserModule {
Context context;
public UserModule(Context context) {
this.context = context;
}
@Provides
public ApiService provideApiService() {
return new ApiService(context);
}
@Provides
public String providerUrl() {
return "www.baidu.com";
}
@Provides
public UserManager provideUserManager(ApiService apiService, UserStroe userStroe) {
return new UserManager(userStroe, apiService);
}
}
public class UserManager {
UserStroe mUserStroe;
ApiService mApiService;
public UserManager(UserStroe mUserStroe, ApiService mApiService) {
this.mUserStroe = mUserStroe;
this.mApiService = mApiService;
}
public void register() {
mApiService.register();
mUserStroe.login();
}
}
public class UserStroe {
@Inject
public UserStroe(String url) {
Log.d("TAG", "UserStroe: " + url);
}
public void login() {
Log.d("TAG", "UserStroe: ");
}
}
public class MainActivity extends AppCompatActivity {
@Inject
UserManager mManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerUserComponet.builder().userModule(new UserModule(this)).build().inject(this);
mManager.register();
Log.d("TAG", "onCreate: " + mManager);
}
}
這里我們創(chuàng)建DaggerUserComponet用了方法：
DaggerUserComponet.builder().userModule(new UserModule(this)).build().inject(this);
這個方法與之前用的其實內部都是一樣的，因為我們UserModule需要context參數桐罕，所以我們選擇這種構建方法
可以看到在創(chuàng)建對象時我們可以在module中像之前一樣提供一個創(chuàng)建的方法，第二種我們也可以通過在對象的構造函數上加上@Inject注解，這里我們需要一個url和context功炮，我們只需要提供一個創(chuàng)建String的url方法即可溅潜，并通過UserModule的構造函數將conetxnt傳入，最后提供一個創(chuàng)建UserManager的方法將兩個參數穿進去薪伏，最后運行一下：
dagger2 D/TAG: UserStroe: www.baidu.com
com.example.ggxiaozhi.dagger2 D/TAG: ApiService:
com.example.ggxiaozhi.dagger2 D/TAG: UserStroe:
com.example.ggxiaozhi.dagger2 D/TAG: onCreate: com.example.ggxiaozhi.dagger2.UserManager@4a7c6f00
可以看到我們修改了這么多滚澜，又需要URL，又需要context但是我們創(chuàng)建UserManager和調用方法沒變嫁怀，因為我們只是需要UserManager中的方法设捐，里面你需要什么，怎么實現的對MainActivity它并不關心塘淑。所以這樣就大大做到了解耦的目的萝招。其實使用Dagger2就說白了就是調用者需要什么實例我就在module中創(chuàng)建什么實例，如果這個實例需要參數存捺，需要什么參數槐沼，我就在mudule給你創(chuàng)建你想要的參數。
結語
這篇文章屬于入門捌治，下一章才是重點岗钩，我們會介紹@Qualifier，@Named 肖油，@Singleton以及自定義注解兼吓。
