前言

前幾篇文章主要介紹了Dagger2的使用。對Dagger2不了解的朋友可以看一下下面的幾篇文章。
Android開發(fā)之Dagger2的基本使用（一）
Android開發(fā)之Dagger2--源碼角度分析inject過程（二）
Android開發(fā)之Dagger2--Module&Component（三）
Android開發(fā)之Dagger2--MVP模式中使用（四）
Android開發(fā)之Dagger2--其他注解符（五）

Dagger2開發(fā)Android的問題

使用Dagger2開發(fā)Android的話，有一個困難就是android的一些框架類，如Activity和Fragment等，他們的實例化由操作系統(tǒng)完成，如果要想讓Dagger2也能很好地注入這些對象，你不得不在生命周期里添加以下代碼完成注入過程。

public class FrombulationActivity extends Activity {
  @Inject Frombulator frombulator;

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // DO THIS FIRST. Otherwise frombulator might be null!
    ((SomeApplicationBaseType) getContext().getApplicationContext())
        .getApplicationComponent()
        .newActivityComponentBuilder()
        .activity(this)
        .build()
        .inject(this);
    // ... now you can write the exciting code
  }
}

這樣做存在以下問題：

• 1.上面的代碼要復(fù)制粘貼到所有的Activity中，這就會給以后重構(gòu)代碼造成麻煩，你的團隊越來越多的人復(fù)制上面的代碼塊，會有越來越少的人知道這塊代碼的真正用途。
• 2.更重要的是，它要求請求注射類型（FrombulationActivity ）知道它的注射器，既即使它可以通過接口而不是具體的類型完成，但是它打破了依賴注入的核心原則：一個類不應(yīng)該知道任何關(guān)于它是如何注入的。

以上，所以基于Dagger2的，適用于Android開發(fā)的Dagger2-Android應(yīng)運而生。

以上翻譯以及以下的代碼均來自Dagger2的官網(wǎng)， 官網(wǎng)傳送門

代碼傳送門，已提交到Github

配置

要使用Dagger.Android的話，需要添加下面的依賴。

//If you're using classes in dagger.android you'll also want to include:

  compile 'com.google.dagger:dagger-android:2.15'
  compile 'com.google.dagger:dagger-android-support:2.15' // if you use the support libraries
  annotationProcessor 'com.google.dagger:dagger-android-processor:2.15'

注入Activity

• 1 在application component中注入 AndroidInjectionModule，以確保Android的類（Activity、Fragment、Service、BroadcastReceiver及ContentProvider等）都可以被綁定。

@Singleton
@Component(modules = {AndroidInjectionModule.class,AppModule.class,})
public interface AppComponent {
    void inject(MyApplication application);
}

• 2 創(chuàng)建子組件 - DaggerAndroidActSubComponent：其繼承自 AndroidInjector<YourActivity>，在該子組件中含有一個抽象類Builder， 該Builder繼承自AndroidInjector.Builder，并由@Subcomponent.Builder注解。

@Subcomponent(modules = AndroidInjectionModule.class)
public interface DaggerAndroidActSubComponent extends AndroidInjector<DaggerAndroidActivity>{

    @Subcomponent.Builder
     abstract class Builder extends AndroidInjector.Builder<DaggerAndroidActivity>{

    }

}

• 3. 創(chuàng)建Module - DaggerAndroidActModule：在定義了子組件DaggerAndroidActSubComponent后，定義該子組件的Module - DaggerAndroidActModule，并綁定DaggerAndroidActSubComponent.Builder，然后將DaggerAndroidActModule添加到組件層次中。
     在DaggerAndroidActModule里，提供了一個獲取Student實例的方法。

@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class DaggerAndroidActModule {

    @Binds
    @IntoMap
    @ActivityKey(DaggerAndroidActivity.class)
    abstract AndroidInjector.Factory<? extends Activity> bindDaggerAndroidActivityInjectorFactory(DaggerAndroidActSubComponent.Builder builder);

    @Provides
    @Singleton
    static Student provideStudent() {
        return new Student();
    }
}

• 4 將上一步定義的DaggerAndroidActModule 添加到Application Component中。

@Singleton
@Component(modules = {AndroidInjectionModule.class, AppModule.class, DaggerAndroidActModule.class})
public interface AppComponent {
    void inject(MyApplication application);
}

注意：
如果在Module中提供依賴實例，@Provides方法必須為靜態(tài)方法，否則編譯不通過。

• 5 自定義Application，并實現(xiàn)HasActivityInjector接口，同時注入(@Inject)DispatchingAndroidInjector<Activity>實例，該實例在activityInjector()方法中返回。

public class MyApplication extends Application implements HasActivityInjector{

    @Inject
    DispatchingAndroidInjector<Activity> dispatchingActivityInjector;

    @Override
    public void onCreate() {
        super.onCreate();
        DaggerAppComponent.create()
                .inject(this);
    }

    @Override
    public AndroidInjector<Activity> activityInjector() {
        return dispatchingActivityInjector;
    }
}

• 6. 在DaggerAndroidActivity.onCreat()方法中，在調(diào)用super.onCreate()之前調(diào)用AndroidInjection.inject(this)。
     我在AppModule提供了一個LogUtil對象，在DaggerAndroidActModule中提供給了一個Student對象。

public class DaggerAndroidActivity extends AppCompatActivity {

    @Inject
    LogUtil mLogUtil;

    @Inject
    Student mStudent;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        AndroidInjection.inject(this);
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_dagger_android);

        Log.d("hbj--",mLogUtil.toString());
        Log.d("hbj--",mStudent.toString());
        mLogUtil.d("inject success!");
    }
}

運行結(jié)果可以看到，都是inject成功的，mLogUtil對象也可以打印出log。

有缺點嗎

上面是完全參照官網(wǎng)給出的流程，這樣做是不是完美呢。

• 1 我們每新建一個Activity，都要寫一個DaggerYourActivityModule的Java文件，添加到AppComponent中，
  如果Activity夠多，那這里實在太多了。
• 2 每個DaggerYourActivityModule的Java文件要都有一個DaggerYourActivitySubComponent文件，同樣也需要建立多個SubComponent文件。
• 3 這些DaggerYourActivityModule是要添加到AppComponent中的，最終會造成AppComponent的代碼如下所示：

@Component(modules = {AndroidInjectionModule.class, AppModule.class, DaggerAndroidActModule.class,
DaggerYourActivityModule.class,
DaggerYourActivity1Module.class,
DaggerYourActivity2Module.class,
DaggerYourActivity3Module.class,
DaggerYourActivity4Module.class,
.......})

public interface AppComponent {
    void inject(MyApplication application);
}

在官網(wǎng)上有這么個專業(yè)提示：
···
Pro-tip: If your subcomponent and its builder have no other methods or supertypes than the ones mentioned in step #2, you can use @ContributesAndroidInjector to generate them for you. Instead of steps 2 and 3, add an abstract module method that returns your activity, annotate it with @ContributesAndroidInjector, and specify the modules you want to install into the subcomponent. If the subcomponent needs scopes, apply the scope annotations to the method as well.
···

如果您的subcomponent 及其構(gòu)建器沒有第2步中提到的其他方法或超類型，您可以使用@ContributesAndroidInjector為您生成它們。我們就不需要步驟2和3，取而代之的是添加一個抽象模塊方法，該方法返回您的activity，使用@ContributesAndroidInjector對其進行注解，并指定要安裝到子組件中的模塊。 如果子組件需要scopes，則也可以用@scopes注解到該方法。

代碼如下:

@ActivityScope
@ContributesAndroidInjector(modules = { /* modules to install into the subcomponent */ })
abstract YourActivity contributeYourActivityInjector();

代碼改進

所以我們的代碼改進如下：

• 1 新建一個AllActivitysModule，在這里提供所有的ActivityModule，每個都用@ContributesAndroidInjector注解。

@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}

• 2 修改DaggerAndroidActModule，變成一個普通的Module，和前文對比，刪掉了(subcomponents = DaggerAndroidActSubComponent.class)以及bindDaggerAndroidActivityInjectorFactory()抽象方法。在這里可以根據(jù)需要提供實例。

@Module
public abstract class DaggerAndroidActModule {


    @Provides
    static Student provideStudent() {
        return new Student();
    }
}

• 3 修改AppComponent，刪除原來的DaggerAndroidActModule,把AllActivitysModule.class放進modules中。

@Singleton
@Component(modules = {AndroidInjectionModule.class, AppModule.class, AllActivitysModule.class})
public interface AppComponent {
    void inject(MyApplication application);
}

運行代碼，同樣inject成功。

進一步改進

看一下我們的AllActivitysModule的代碼

@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}

它是依賴于DaggerAndroidActSubComponent.class的，在查看DaggerAndroidActSubComponent的代碼

@Subcomponent(modules = AndroidInjectionModule.class)
public interface DaggerAndroidActSubComponent extends AndroidInjector<DaggerAndroidActivity>{

    @Subcomponent.Builder
     abstract class Builder extends AndroidInjector.Builder<DaggerAndroidActivity>{

    }

}

它AndroidInjector.Builder的是DaggerAndroidActivity，這樣對于其他的Activity是不可以的，我們要求的是對所有Activity都通用。我們繼續(xù)改進代碼。
首先分析一下DaggerAndroidActSubComponent，AndroidInjector.Builder的是DaggerAndroidActivity，而DaggerAndroidActivity完成了什么呢，查看一下，在DaggerAndroidActivity完成的是注入，僅有一行代碼：

 AndroidInjection.inject(this);

所以我們猜想，我們可以抽取一個BaseActivity，所有的Activity都繼承自BaseActivity。

• 新建BaseActivity，在BaseActivity里執(zhí)行 AndroidInjection.inject(this);

public class BaseActivity extends AppCompatActivity{
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        AndroidInjection.inject(this);
        super.onCreate(savedInstanceState);
    }
}

并將其他的Activity繼承BaseActivity。

public class DaggerAndroidActivity extends BaseActivity {
}

• 新建BaseActivityComponent，在這里我們AndroidInjector.Builder的是上部新建的BaseActivity。

@Subcomponent(modules = {AndroidInjectionModule.class})
public interface BaseActivityComponent extends AndroidInjector<BaseActivity>{

    @Subcomponent.Builder
    abstract class Builder extends AndroidInjector.Builder<BaseActivity>{

    }
}

• 修改AllActivitysModule 代碼，子部件換為上部新建的BaseActivityComponent。

@Module(subcomponents = BaseActivityComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}

編譯運行，同樣可以看到結(jié)果。

總結(jié)

經(jīng)過改進，如果我們新添了新的Activity，我們只要下面的步驟:

• 1.新Activity繼承BaseActivity。
• 2. 為新Activity建一個NewActivityModule，這是一個普通的Module，用@Module注解，在這提提供新Activity需要的實例。注意要用static關(guān)鍵字哦。
• 3 新Activity添加到AllActivitysModule 中，類似于下面的代碼。

@Module(subcomponents = BaseActivityComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();
    // 新增一個Activity
    @ContributesAndroidInjector(modules = DaggerAndroid2ActModule.class)
    abstract DaggerAndroid2Activity contributeDaggerAndroid2ActivityInjector();

}

參照官網(wǎng)，經(jīng)過改進，注入過程更加簡潔。
代碼傳送門
除了Activity之外，Dagger-Android還提供了Fragment，BroadcastReceiver,Service等其他組件的注入方式，下篇文章再討論。