Dagger2学习

雨点打透心脏的1/2处 2023-07-20 05:45 21阅读 0赞

**什么是Dagger2**  
Dagger是为Android和Java平台提供的一个完全静态的，在编译时进行依赖注入的框架，原来是由Square公司维护，现在由Google维护。  
我们知道Dagger是一个依赖注入的框架，那么什么是依赖注入呢？  
我们在activity中有可能会用到很多很多的类，这些类要在activity中进行实例化，这样就导致我们的activity非常依赖这么多的类，这样的程序耦合非常  
严重，不便于维护和扩展，有什么办法可以不去依赖这些类呢，这时候就需要有一个容器（IoC），将这些类放到这个容器里并实例化，我们activity在用  
到的时候去容器里面取就可以了，我们从依赖类到依赖这个容器，实现了解耦，这就是我所理解的依赖注入，即所谓控制反转；  
简单的说 Dagger就是用来创造这个容器，所有需要被依赖的对象在Dagger的容器中实例化，并通过Dagger注入到合适的地方，实现解耦，MVP框架就是为解耦而生，因此MVP和Dagger是绝配。

**如何使用？**  
1、依赖  
在module的build.gradle文件中加入：

compile 'com.google.dagger:dagger:2.9'
        annotationProcessor 'com.google.dagger:dagger-compiler:2.9'

2、我们先定义一个简单的类：

public class User {
        private String name;
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }

在Activity中对其操作

private void initData() {
    
            User user = new User();
    
            user.setName("测试");
        }

以上是最普通的用法。  
接下来我们来看Dagger2的用法。  
加一个Inject注解：

public class User {
        private String name;
    
        @Inject
        public User() {
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }

增加一个类：

@Component
    public interface ActivityComponent {
        void inject(MainActivity mainActivity);
    }

在Activity中对其初始化 完整代码如下：

@Inject
        User user;
    
        private void initData() {
            DaggerActivityComponent.builder().build().inject(this);
            user.setName("测试");
        }

在代码编写过程中 我们会发现DaggerActivityComponent会不存在，这是因为注入器是在编译的过程中才生成，所以我们在对注入器编写完成后Make Module一下就会生DaggerActivityComponent  
这时候发现我们的user对象可以正常使用了；看上去感觉挺复杂的，但是对于大型项目引用的类过多的时候，Dagger的优势就体现出来了。

首先我们来了解这几个基础概念：

*  @Inject Inject主要有两个作用，一个是使用在构造函数上，通过标记构造函数让Dagger2来使用（Dagger2通过Inject标记可以在需要这个类实 例的时候来找到这个构造函数并把相关实例new出来）从而提供依赖，另一个作用就是标记在需要依赖的变量让Dagger2为其提供依赖。
 *  @Provide 用Provide来标注一个方法，该方法可以在需要提供依赖时被调用，从而把预先提供好的对象当做依赖给标注了@Injection的变量赋值。provide主要用于标注Module里的方法
 *  @Module 用Module标注的类是专门用来提供依赖的。有的人可能有些疑惑，看了上面的@Inject，需要在构造函数上标记才能提供依赖，那么如果我们需要提供 的类构造函数无法修改怎么办，比如一些jar包里的类，我们无法修改源码。这时候就需要使用Module了。Module可以给不能修改源码的类提供依 赖，当然，能用Inject标注的通过Module也可以提供依赖
 *  @Component Component一般用来标注接口，被标注了Component的接口在编译时会产生相应的类的实例来作为提供依赖方和需要依赖方之间的桥梁，把相关依赖注入到其中。

现在是这样一个情况，User类是其他部门提供在一个jar里面的，我们不能修改代码加这个inject注解，这时候我们要用到@Module是和@Component配合使用。  
新增ActivityModule 类，用Module注解修饰，他来提供User实例，代替了之前的User类中@Inject。

@Module
    public class ActivityModule {
    
       @Provides
       User provideUser() {
           return new User();
       }
    }

上面的ActivityComponent 类要修改一下：

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

可以看到标注头多了@Component(modules = ActivityMoudle.class)，表示告诉注入器如果你要注入的类没有找到构造函数，你就去ActivityMoudle.class中找。  
至此我们有两种方式可以提供依赖，一个是注解了@Inject的构造方法，一个是在Module里提供的依赖，那么Dagger2是怎么选择依赖提供的呢，规则是这样的：

*  步骤1：查找Module中是否存在创建该类的方法。
 *  步骤2：若存在创建类方法，查看该方法是否存在参数
 *  步骤2.1：若存在参数，则按从步骤1开始依次初始化每个参数
 *  步骤2.2：若不存在参数，则直接初始化该类实例，一次依赖注入到此结束
 *  步骤3：若不存在创建类方法，则查找Inject注解的构造函数，看构造函数是否存在参数
 *  步骤3.1：若存在参数，则从步骤1开始依次初始化每个参数
 *  步骤3.2：若不存在参数，则直接初始化该类实例，一次依赖注入到此结束

**学习目的**  
其实dagger跟MVP是天生一对，但是我基本不用MVP，觉得MVVM才是未来，但是dagger提供的依赖注入思想还是值得在项目中借鉴的。

参考：  
[浅析Dagger2的使用][Dagger2]  
[深入浅出，一篇文章让你学会Dagger2使用][Dagger2 1]

[Dagger2]: https://www.cnblogs.com/all88/p/5788556.html
[Dagger2 1]: https://blog.csdn.net/gg199402/article/details/78990900