Android依赖注入框架Dagger2的学习

---

在写作业项目的时候了解了一下安卓中的一些常用框架，然后发现了现在实际项目中很常见的Dagger2框架，于是对其进行了一些学习，下面分享一下我的学习体会

什么是Dagger2

Dagger2是一个Android中依赖注入的框架，依赖注入大家应该都很熟悉了在用Spring进行开发时应该经常会碰到。简单来说就是经常出现需要在一个对象里去创建另一个对象的情况，类之间相互依赖产生耦合导致代码难以维护。Dagger2就是通过注解的方式，把已经初始化好的类的实例注入到目标类中

在安卓应用中使用Dagger2

引入Dagger2

配置Dagger2要在gradle中加入依赖
project的gradle:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.1'
        //加上下面这个，因为会用到apt
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}

app的gradle:

dependencies {
    compile 'com.google.dagger:dagger:2.9'
    apt 'com.google.dagger:dagger-compiler:2.9'
}

使用Dagger2的注解

Dagger2中常用的注解一共有4个：@Inject，@Provides，@Module，@Component。这部分刚开始看的很懵逼，感觉非常混乱，用一张图简要描述一下（个人觉得参考文献1的图非常的通俗易懂，感兴趣的同学可以参考那篇博文）

此处输入图片的描述

• @Inject
  @Inject就是用来标注要依赖的类。一处用在被依赖的类的构造函数，一处用在目标类中被依赖的类的对象实例处。
• @Component
  @Component就是在@Inject标注的被依赖类的实例和构造函数间搭起了桥梁。大概的工作过程就是：Component会查找目标类中用Inject注解标注的属性，查找到相应的属性后会接着查找该属性对应的用Inject标注的构造函数，然后初始化该属性的实例并把实例进行赋值，通过inject方法注入。
• @Module
  @Module也是用来标注依赖的，但是@Inject需要标注在构造函数上，对于一些不能修改的第三方类库等就可以用@Module来标注，基本形式见下

@Module
    public class ModuleClass{
          //A是第三方类库中的一个类,通常Module使用provide的方法名
          A provideA(){
               return A();
          }
    }

• @Provides
  @Provides和上面的@Module一起解决第三方类库依赖注入的，用@Provides标注Module中的provide方法。然后Component在搜索到目标类中用Inject注解标注的属性后，Component就会去Module中去查找用Provides标注的对应的创建类实例方法进行注入。

一个简单的实例

下面用一个简单的例子来加深理解

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 {
    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);
}

上面的注入过程大概就是：首先MainActivity需要依赖MainPresenter，因此用@Inject对MainPresenter进行标注，表明这是要注入的类。然后，我们对MainPresenter的构造函数也添加注解@Inject，此时构造函数里有一个参数MainContract.View说明MainPresenter需要依赖MainContract.View，所以我们定义了一个类，叫做MainModule，提供一个方法provideMainView来提供这个依赖，这个MainView是通过MainModule的构造函数注入进来的，接着我们需要定义Component接口类，并将Module包含进来，最后通过

DaggerMainComponent.builder()
                .mainModule(new MainModule(this))
                .build()
                .inject(this);

完成注入

---

参考文献：
Android：dagger2让你爱不释手-基础依赖注入框架篇
依赖注入神器：Dagger2详解系列
Dagger2从入门到放弃再到恍然大悟