Dagger2 使用记录

Dagger是干嘛的呢？
我的理解：一个依赖注入(DI)框架，使用范围是java和android。
DI--dependence inject。

本文主要是记录Android项目中，使用Dagger2的一个简单的demo。如果需要Dagger入门的话，强烈推荐深入浅出Dagger2 : 从入门到爱不释手系列。

Dagger的优点：

1.解耦。
2.简化代码。

Dagger注解

要使用Dagger首先必须了解相关的注解含义，下文主要介绍Dagger使用时，最基本的的注解。

• @Inject
  javax.inject.Inject
  翻译过来就是“注入”的意思。

构造函数注入：

public class Student {
    private String name;
    @Inject
    public Student() {
        this.name = "小美";
    }
    ...
}

属性注入：

@Inject
User user;

被注入的属性不能用private修饰。标记user对象为目标依赖类。

方法注入：
依赖需要this对象的时刻可以提供安全的this对象。

• @Module
  dagger.Module
  通常自定义的类，可通过其在其构造函数上添加@Injcet注解，实现对象的自动创建，但是第三方依赖，不能给其中类添加@Injcet。因此Module应运而生。
  Module其实是一个简单工厂模式，Module里面的方法基本都是创建类实例的方法。

• @Component
  dagger.Component
  Component是注入器，它一端连接目标类，另一端连接目标类依赖实例，它把目标类依赖实例注入到目标类中。

@Component(modules = ActivityModule.class)
public interface MainComponent {
    void inject(MainActivity activity);
}

@Component(modules = ActivityModule.class)如何理解？
上面已说明Component是注入器，并且是一个目标类和目标依赖实例的连接桥。而Module是创建类的工厂。因此@Component(modules = ActivityModule.class)的含义就是ActivityModule.class为目标类提供依赖实例，并通过MainComponent连接。

• @Provides
  dagger.Provides
  Module中的创建类实例方法用Provides进行标注。

@Module
public class ActivityModule {
    @Provides
    public User provideUser(){
        return  new User("user from ActivityModule");
    }
   ...
}

• 注解小结：
  个人认为@Component是Dagger2的核心注解，因为其是目标类和目标依赖实例连接的桥梁，为方便理解将其当作是注射器，将目标依赖实例注入到目标类中。

Dagger2 使用

• 添加Dagger库
  Dagger主要是通过注解(annotation)及注解处理器实现，因此需要添加两个库，如下：

implementation 'com.google.dagger:dagger:2.+'
annotationProcessor 'com.google.dagger:dagger-compiler:2.+'

annotationProcessor：注解处理器。

• Demo代码
  （1）目标依赖类

//User类
public class User {
    public String name;
    @Inject
    public User(){
    }
    public User(String name){
        this.name = name;
    }
}
//Student 类
public class Student {

    private String name;

    @Inject
    public Student() {
        this.name = "小美";
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
//DaggerPresenter类
public class DaggerPresenter {

    MainActivity activity;
    User user;

    public DaggerPresenter(MainActivity activity,User user){
        this.user = user;
        this.activity = activity;
    }
    public void showUserName(){
        activity.showUserName(user.name);
    }
}

（2）提供目标依赖实例的Module类
此处提供的是自定义依赖实例，一般用于提供第三方依赖类的实例。
自定义依赖类的实例提供，可通过@Inject注解实现。

@Module
public class ActivityModule {

    private MainActivity activity;

    public ActivityModule(MainActivity activity) {
        this.activity = activity;
    }

    @Provides
    public MainActivity provideActivity(){
        return  activity;
    }
    @Provides
    public User provideUser(){
        return  new User("user from ActivityModule");
    }
    @Provides
    public DaggerPresenter provideDaggerPresenter(MainActivity activity,User user) {
        return new DaggerPresenter(activity, user);
    }
}

（3）注射器类
MainComponent.java

//情况1
@Component(modules = ActivityModule.class)
public interface MainComponent {
    void inject(MainActivity activity);
}

//情况2：
@Component
public interface MainComponent {
    void inject(MainActivity activity);
}

需要Module提供目标依赖实例的情况，需要按照情况1定义Component。

自定义Component类后，build项目，并自动编译生成相关类。如下图：

image.png

如果想更好的理解Dagger2的依赖注入原理，可查看上图中的相关代码。这里推荐# 浅析Dagger2依赖注入实现过程。

（4）注入目标类

public class MainActivity extends AppCompatActivity {

    @Inject
    Student student;

    @Inject
    DaggerPresenter presenter;

    @Inject
    User user;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //*******关键代码*******
        DaggerMainComponent.builder().activityModule(new ActivityModule(this)).build().inject(this);
        //*******关键代码*******
        TextView tv = findViewById(R.id.tv);
        tv.setText(student.getName());
        presenter.showUserName();
    }

    public void showUserName(String name) {
        Toast.makeText(this,name,Toast.LENGTH_LONG).show();
    }
}

到此为此，dagger基本使用完成了。但是我还是留了个知识点未讲哦。

在demo中在User类中的构造函数上，添加了@Inject，但是添加/不添加 并没有区别。为什么呢( ⊙o⊙?)
因为在MainModule类中，提供了User类的实例创建方法。而注解处理器在编译过程中，是先去找Module中是否有User的实例创建方法，如果找到了，则User的实例由此方法创建。如果没有找到，再去User类中，去找是否有@Inject标记的构造方法。
根据此原理可知，Student类中的@Inject不能删除。