Dagger2学习之配置和基础使用(一)

Dagger2个人学习记录

0x00:什么是Dagger2

Dagger2是Dagger的升级版(原来的第一代dagger是由square维护，square全家桶你值得拥有)，是一个依赖注入框架，目前由Google接手维护。

依赖注入是面向对象编程的一种设计模式，其目的是为了降低程序耦合，这个耦合就是类之间的过度依赖引起的。

1.一个坏例子

public class ClassA {
    ...
    ClassB b;
    ...
    public ClassA() {
        b = new ClassB();
    }
    public void do() {
        ...
        b.doSomething();
        ...
    }
}

上面的代码使得ClassA依赖ClassB。如果需求改变，就必须修改ClassA代码。导致扩展性极差。

2.依赖注入

为了解决以上的问题，有以下的几种方法。

通过接口注入

interface ClassBInterface {
    void setB(ClassB b);
}

public class ClassA implements ClassBInterface {
    ClassBInterface  classB;
    
    @override
    void setB(ClassBInterface  b) {
        this.classB = b;
    }
}

改进型：

// 测试类接口
interface TestClass {
	void doing();
}

// 抽象工厂,也可以写成抽象类
interface Testfactory{
	TestClass create();
}

// classA类
ClassA implements TestClass{
	public void doing(){
		System.out.println("do classA");		
	}
}

// classB类
ClassB implements TestClass{
	public void doing(){
		System.out.println("do classB");
	}
}

// classC类
ClassC implements TestClass{
	public void doing(){
		System.out.println("do classC");
	}
}

// 实体工厂类A
FactoryA implements Testfactory{
	public TestClass create(){
		return new ClassA();
	}
}

// 实体工厂类B
FactoryB implements Testfactory{
	public TestClass create(){
		return new ClassB();
	}
}

// 实体工厂类C
FactoryC implements Testfactory{
	public TestClass create(){
		return new ClassC();
	}
}

当然上面工厂类的"create"可以改为"static"静态的，更加方便调用。

通过注解注入

public class ClassA {
      //此时并不会完成注入，还需要依赖注入框架的支持，如RoboGuice,Dagger2
      @inject ClassB classB;
      ...
      public ClassA() {}

Dagger2就是采用"注解"的方式来实现的。

0x01:Dagger2在AndroidStudio中的配置

首先，在项目的根build.gradle中加上以下配置(对于gradle版本低于2.2的，高于2.2不需要)

dependencies {
    .....
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'//插件
    .....
}

在你的Module中添加如下代码

apply plugin: 'com.neenbedankt.android-apt' //Module的build.gradle的最上面加上 (对于gradle版本低于2.2的，高于2.2不需要)

以上的配置只在gradle低于2.2的时候使用。
在"dependencies{}"上加上

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

三.Dagger基础使用

1.快速入门

现在我需要把一个User类注入到MainActivity中去，最简单的流程如下：
1.首先新建User类，这个实际上是个JavaBean。代码如下：

public class User {
    public String name;
 
    @Inject //被注入点
    public User() {this.name = "hello world!";}//这里为了能显示在页面上。
}

2.建立一个"Component"，该类的作用是要将MainActivity和User联系起来：

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

3.在MainActivity中注入：

public class MainActivity extends AppCompatActivity {
    //注入
    @Inject
    User user;
  
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        text = (TextView) findViewById(R.id.text);
        inject();
        Log.v("tag", "user.name::"+user.name);
    }
  
    //注入行为.
    //该方法应该放在获取name值之前
    private void inject() {
        DaggerActivityComponent.create().inject(MainActivity.this);
    }

就这样三板斧搞定整个注入流程。

2.再度理解

看到这里估计有人已经开始迷糊了。为了能够更加清楚的理解整个过程，可以做个不恰当的比喻：
我们可以将上面的代码理解成医生打针的过程。

代码	比喻
User类	医生打针时候所需要的"药物"
Component接口	医生打针所需要的"注射器"
MainActivity	病人
MainActivity中的inject方法	医生的注射行为

这样整个Dagger2的注入过程会有一个更好的理解。

sequenceDiagram
药物->>注射器->>注射行为->>病人

对应的代码流程：

sequenceDiagram
User类->>Component->>DaggerActiviteComponent.create().inject(MainActivity.thie)->>MainActivity的User类

以上是我对于Dagger2这个框架的配置和基础使用。由于水平有限，该文章存在任何问题，欢迎指正。