Android dagger2的基本使用

如何快速掌握dagger

想要理解一个事物，快速的掌握，都应该思考一下几个问题：
1、它是什么？
2、它有什么作用？
3、具体的用法是什么？
4、实现原理是什么？
5、如何灵活使用它？

一、什么是dagger

官方介绍：
A fast dependency injector for Java and Android.（一个用于Java和Android的快速依赖注入框架）

Dagger is a compile-time framework for dependency injection. It uses no reflection or runtime bytecode generation, does all its analysis at compile-time, and generates plain Java source code.
(Dagger是一个编译时的依赖注入框架，它不使用反射或者运行时生成字节码，而是在编译时执行分析，并且生成纯Java源码)

Dagger是通过Java注解(Annotation)来工作的。

二、dagger的作用

最大的两个作用：
1、通过依赖注入的方式，实现解耦，在项目较大的情况的，作用更加突出。
2、dagger是静态编译时产生代码，相比通过反射在运行时生成代码，可以改善很多问题。

三、怎么使用dagger

基本使用

1、导入：

 implementation 'com.google.dagger:dagger:2.13'
 annotationProcessor 'com.google.dagger:dagger-compiler:2.13'
 
 //dagger-android相关库
 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'

2、dagger的几个基本注解：

• @Inject:
  a.在A类中标记B类字段，告诉dagger要把B类实例注入到A类中
  b.在B类中标记构造方法，告诉dagger这是一个可以被注入的类，需要创建实例时，用标记的构造方法

• @Component:
  作为依赖方A和注入方B之间的桥梁。在Component中持有依赖方A的实例，当在A类中发现有被@Inject，会去查找B的构造方法，来创建B实例。

用这两个结合在一起，就可以写一个最基本的dagger例子，如下:

public class User {

    private String name;

    @Inject
    private User(){
        name = "笨鸟先飞";
        System.out.println("dagger-------------------user is created by inject" + "----name = " + name);
    }

    public String getName(){ 
        return name;
    }
}

@Component
public interface MainComponent {

    void inject(Main2Activity activity);
   
}

写完User和MainComponent之后，点击Build——>Make Project。在build文件夹下方会自动生成dagger文件DaggerxxxComponent。在activity中DaggerMainComponent.create().inject(this);

public class Main2Activity extends AppCompatActivity {


    @Inject
    User user;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main2);

        DaggerMainComponent.create().inject(this);
        System.out.println("dagger-------------------user = " + user.toString() + "-------name = " + user.getName());
    }
}

可以发现在activity中并没有new创建，但是dagger帮助我们创建了，过程如下：
Activity中发现了Inject字段---->Component去寻找要注入的类-------->调用该类被Inject的构造方法创建。
如果没有被Inject的构造方法，则会提示没有提供@Inject标注的构造方法。
如果没有Component，则会提示User空指针异常，因为没有创建实例。所以二者缺一不可。

• @Module和@Provides:
  这两个也是用来创建依赖的实例的，因为很多第三方库并没有@Inject的构造方法，当我们想要用dagger实现依赖注入时，就不能用上述的方式。@Module和@Provides就是为了解决这个问题。
  例子如下：

public class User {

    private String name;
    
    //去掉@Inject注解。就变成了了一个普通的类
    public User(){
        name = "笨鸟先飞";
        System.out.println("dagger-------------------user is created by inject" + "----name = " + name);
    }

    public String getName(){ 
        return name;
    }
}

@Module
public class UserModule {
	
	//创建Module，@Provides提供User的创建方式
    @Provides
    public User provideUser() {
        System.out.println("dagger-------------------user is created by module+provides");
        return new User();
    }
}

@Component(modules = UserModule.class)//这里要加上，Component关联Module
public interface MainComponent {

    void inject(Main2Activity activity);
}

Activity代码不变。运行结果和第一种一致。创建过程如下：
Activity有Inject字段——>Component寻找关联的Module——>通过Module中的Provides创建。

bean之间互相的依赖

public class User {

    private String name;

    @Inject
    private WorkInfo workInfo;

    public User(){
        name = "笨鸟先飞";
        DaggerMainComponent.create().inject(this);//在这里添加
        System.out.println("dagger-------------------user is created by inject" + "----name = " + name);
    }

    public String getName(){
        return name;
    }
}

public class WorkInfo {

    @Inject
    public WorkInfo(){
        System.out.println("dagger----------workInfo is created by inject");
    }
}

@Component(modules = UserModule.class)
public interface MainComponent {

    void inject(Main2Activity activity);
    void inject(User user);
}

让Component中都持有依赖方的实例。