依赖注入之Dagger2初探

本是古典何须时尚 2022-06-02 06:07 230阅读 0赞

## 何为Dagger2 ##

Dagger2是Google提供的依赖注入框架，依赖注入为Android中组件之间的解耦提供了很好的解决方案。  
使用它可以自动生成创建依赖关系所需要的代码。减少很多模板化的代码，更易于测试，降低耦合，创建可复用可互换的模块。已经在越来越多的开源项目中被使用，其已经发展成为未来的一个技术趋势。

## 为什么要使用Dagger2 ##

MVP设计模式中，M层提供数据，V层做界面展示，而P层则成为M和V的桥梁，这其中就必然涉及到M和V的交互及处理，如果业务复杂或者多个页面共用，它还是面临着高度的耦合性。如果需求发生变动，必然需要更改P中的内容。而在MVP中，我们通常在activity层中需要拿到p层的对象，那么在开发中有可能我们很多activity或者fragment都可能需要拿到这个p层对象的实例，假如我们P层类的构造发生变化(例如增加了参数）我们要在很多地方都得进行修改，这就是耦合度太高的弊端。

为了解决这种耦合性的问题，有一帮牛叉的人就思索着：能不能有个容器，这个容器在我们需要用到某个对象的时候帮我们创建好需要的对象，像对象工厂一样，并且帮我们管理这些对象。当发生变化时，我们只需要换一个容器就可以了。就这样，dagger2应运而生。

## 如何理解Dagger2 ##

简而言之，dagger2中组成内容的对应关系：

*  类Module：使用@Module修饰，装载对象的容器。
 *  接口Component：使用@Component修饰，存放这些容器的仓库。它是连接Module和依赖注入对象的桥梁。
 *  注解@Provides：该容器创建对象的动作。
 *  注解@Inject:从容器中取出这个对象的动作。
 *  注解@Qualifier：用来给@Inject和@Provides贴上关联标签(进行注解)。如果一个对象可以由一个或多个容器的@Provides修饰提供，这时候就需要用Qualifier进行标签关联。 [还不清楚的可点击了解.][.]
 *  注解@Scope：从容器取出对象的有效期，即生命周期。

## Dagger2的核心使用流程： ##

*  1.使用@Module修饰编写Module,再通过@Provides修饰该对象的创建方法。
 *  2.使用@Component的modules属性修饰存放Module容器的仓库Component，并同时定义依赖注入的接口方法inject，参数为依赖注入的对象。
 *  3.执行编译，使用自动生成的\[”Dagger” + Component名\]类先装载Module，再用之前定义的依赖注入接口方法，最后在注入对象上添加@Inject进行注入关联。

## 如何使用Dagger2 ##

1.增加Dagger2依赖包

dependencies {
        //Dagger2
        implementation 'com.google.dagger:dagger:2.13'
        annotationProcessor 'com.google.dagger:dagger-compiler:2.13'
    
        implementation 'com.google.dagger:dagger-android:2.13'
        implementation 'com.google.dagger:dagger-android-support:2.13'
        annotationProcessor 'com.google.dagger:dagger-android-processor:2.13'
    
        compileOnly 'org.glassfish:javax.annotation:10.0-b28'
    
        //ARouter
        compile 'com.alibaba:arouter-api:1.3.1'
        annotationProcessor 'com.alibaba:arouter-compiler:1.1.4'
    
        //butterknife的sdk
        implementation 'com.jakewharton:butterknife:8.8.1'
        annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
    }

2.编写Module

@Module
    public class LoginModule { 
        @ActivityScope
        @Provides
        LoginPresenter getPresenter() {
            return new LoginPresenter();
        }
    
    }

3.编写Component装载module

（1）使用Dagger2单独编写Component装载module

@ActivityScope
    @Component(modules = {LoginModule.class})
    public interface LoginComponent { 
        void inject(LoginActivity activity);
    }

（2）使用Dagger-Android 统一生成装载module

@ActivityScope @ContributesAndroidInjector(modules = LoginModule.class) abstract LoginActivity contributeSecondActivityInjector();

4.编译工程

AndroidStudio -> Build -> Make Project

5.进行依赖注入

(1)使用Dagger2,通过Component取出module注入依赖

@Override
    protected void onResume() {
       super.onResume();
       DaggerLoginComponent.builder().loginModule(new LoginModule()).build().inject(this);
       mPresenter.attachV(this);
    }

(2)使用Dagger-Android在BaseActivity中统一AndroidInjection统一取出module注入依赖

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        AndroidInjection.inject(this);  //统一注入
        super.onCreate(savedInstanceState);
        setContentView(getLayoutId());
    }

## Dagger2使用中存在的问题 ##

1.看过上面介绍后，可能有人会疑问：一个Component难道只能存储一个依赖注入对象的所有module？那岂不是我需要创建很多的Component实现接口，而且还有很多重复的劳动，多了也同样不好管理。能不能使用一个Component，对多个依赖注入对象进行Module的存储呢？

2.在Android中，我们需要进行依赖注入的对象大多数是Activity、Fragment、Service、BroadcastReceiver等，如果像上面那样使用Dagger进行依赖注入的话，就需要为每个Activity、Fragment等创建Component和Module，并在生命周期中写上一长串依赖注入的实现，这样会显得非常麻烦，那么能否有一种方式，能够将他们的所有依赖注入信息统一注册在一个全局Component(AppComponent)中,并在每次Activity、Fragment等创建的时候自动进行依赖注入，这样就完全实现了依赖注入的可配置，每个类都无需关注依赖注入如何实现。

那么如何解决以上问题呢？Google为此不懈努力，开发出了Dagger2-android库。

## 何为Dagger2-android ##

Dagger2-Android是Google基于Dagger2开发的应用于Android开发的扩展库。通过它，我们能够通过简单的配置，无需书写过多的Component就可以轻松地实现Android的依赖注入。可以说是Android实现依赖注入的一大法宝。

## 如何使用Dagger2-android进行全局依赖配置 ##

1.我们先声明我们的Application类，并实现HasActivityInjector接口，然后添加到manifest清单文件中：

public class MyApplication extends Application implements HasActivityInjector { 
        @Inject
        DispatchingAndroidInjector<Activity> dispatchingAndroidInjector;
    
        @Override
        public void onCreate() {
            super.onCreate();
    
            AppInjector.init(this); //全局依赖注入
    
        }
    
        @Override
        public AndroidInjector<Activity> activityInjector() {
            return dispatchingAndroidInjector;
        }
    }

2.定义全局依赖仓库AppComponent，添加依赖注入的Module。

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

3.定义基础Activity的Subcomponent–ActivitySubComponent，统一Activity的依赖注入接口：

在实际使用Dagger2过程中，我们不可能书写过多的Component，那样可读性和可维护性都会大大降低，@Subcomponent主要解决的是就是Component复用的问题。  
Subcomponent就好比将多个统一(类似)的依赖注入Component接口打包到一个Module(暂记为AllModule)中，而这些Subcomponent又可以放入多个Module。

这样在外层我们只需要定义一个全局的父Component，而在这个父Component中，我们放入了装载了多个Subcomponent的AllModule。这样如果我们需要新添加依赖的话，只需要在AllModule中进行Module注册即可，无需添加新的Component，而且也方便管理。

@Subcomponent(modules = {
            AndroidInjectionModule.class,
    })
    public interface ActivitySubComponent extends AndroidInjector<BaseActivity> { 
    
        @Subcomponent.Builder
        abstract class Builder extends AndroidInjector.Builder<BaseActivity> {   //构建规则
        
        }
    
    }

4.定义存放多个ActivitySubComponent的Module–ActivitysModule:

@Module(subcomponents = {
            ActivitySubComponent.class
    })
    public abstract class ActivitysModule {
    
        @ActivityScope
        @ContributesAndroidInjector(modules = LoginModule.class)
        abstract LoginActivity contributeLoginActivityInjector();
    
        @ActivityScope
        @ContributesAndroidInjector(modules = MainModule.class)
        abstract MainActivity contributeMainActivitytInjector();
    
    }

5.在全局依赖仓库AppComponent中装入ActivitysModule，并进行全局依赖注入：

使用Application注册Activity生命周期回调，在Activity创建的时候自动进行依赖注入。

DaggerAppComponent.builder().build().inject(myApplication);
            myApplication
                    .registerActivityLifecycleCallbacks(new Application.ActivityLifecycleCallbacks() {
                        @Override
                        public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
                            AndroidInjection.inject(activity);   //动态自动进行依赖注入
                        }
                     ···省略其他Callbacks
                     
                    });

需要了解更多有关Dagger2和MVP内容的，[请点击查看][Link 1]

## 更多框架演示 ##

*  [MVP][]
 *  [MVVM][]
 *  [Google Architecture Components][]

[.]: https://www.jianshu.com/p/e521bd239cd9
[Link 1]: https://github.com/googlesamples/android-architecture
[MVP]: https://github.com/xuexiangjys/MyMVP
[MVVM]: https://github.com/xuexiangjys/MyMVVM
[Google Architecture Components]: https://github.com/xuexiangjys/GoogleComponentsDemo