Android-Dagger2Android 文章

Dagger2使用

2019-07-18  本文已影响0人  hanxianshe_9530

Dagger2使用

命名规约


简单的说,就是一个工厂模式,由Dagger负责创建工厂,帮忙生产instance。遵从Java规范JSR 330,可以使用这些注解。现在不研究Dagger2是如何根据注解去生成工厂的,先来看看工厂是什么东西,理解为什么可以实现了DI(Dependency Injection),如何创建IoC(Inverse of Control)容器。


Dagger2是怎么选择依赖提供的呢,规则是这样的:

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

总结:

使用@Inject可以让IoC容器负责生成instance,如果没有这个注解,dagger将不认识,当做普通类,无法代理

@Module
public class AModule {

    @Provides
    public Gson provideGson(){
        return new Gson();
    }
}

Component需要引用到目标类的实例,Component会查找目标类中用Inject注解标注的属性,查找到相应的属性后会接着查找该属性对应的用Inject标注的构造函数(这时候就发生联系了),剩下的工作就是初始化该属性的实例并把实例进行赋值。因此我们也可以给Component叫另外一个名字注入器(Injector)

Component注解的类,再编译之后,会生产一个以Dagger+类名的一个类,如下面的MainComponent会生成类DaggerMainComponent(补充一点,Kotlinkapt编译生成类的位置:\build\generated\source\kapt\debug),我们需要在目标类MainActivity中加入下面代码

DaggerMainComponent.builder()
                .build()
                .inject(this)

DaggerMainComponent使用了建造者设计模式,inject方法是我们MainComponent中定义的,这样目标类就和Component建立了联系.Component会去遍历使用@Inject注解的常量,然后去查找对应的类是否有@Inject注解的构造方法,如果没有就会报异常.

@Component {modules = {HeaterModule.class, PumperModule.class}}
public interface MachineComponent {
  void inject(CoffeeMachine machine);
}

dagger中Component就是最顶级的入口,dagger为之生成了工厂类 DaggerMachineComponent,目标是构建CoffeeMachine, 在CoffeeMachine中使用了Injection,那么依赖要由工厂类来提供。工厂类是根据modules的参数来找依赖绑定的。

本例中,指向了HeaterModule, PumperModule,意思是CoffeeMachine的依赖要从这些module里找。

工厂名称生成规则

/**
 * View层,负责界面的展示
 */
public class TestActivity extends AppCompatActivity implements IView{
//当一个成员变量被@Inject注解修饰,并且它的类型构造函数也被@Inject注解修饰,dagger2就会自动实例化该成员类型,并注入到该成员变量
    @Inject
    TestPresent mPresent;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
        DaggerTestComponent.builder().testModule(new TestModule(this)).build().inject(this);//@Component负责连接起@Inject和@Module注解
        mPresent.updateUI();
    }
    @Override
    public void updateUI(String text) {
        ((TextView)findViewById(R.id.textview)).setText(text);
    }
}
/**
 * Present类,调用Model层的业务方法,更新View层的界面展示
 */
public class TestPresent {
    IView mView;
    @Inject
    TestModel mModel;//Dagger2遇到@Inject标记的成员属性,就会去查看该成员类的构造函数,如果构造函数也被@Inject标记,则会自动初始化,完成依赖注入。
    //TestPresent的构造函数也被@Inject注解修饰
    @Inject
    public TestPresent(IView view){
        this.mView=view;
    }
    public void updateUI(){
        mView.updateUI(mModel.getText());
    }
}
/**
 * Model类,实现具体的业务逻辑
 */
public class TestModel {
    //构造函数用@Inject修饰
    @Inject
    public TestModel(){
    }
    public String getText(){
        return "Dagger2应用实践...";
    }
}
/**
 * Module类提供那些没有构造函数的类的依赖,如第三方类库,系统类,接口类
 */
@Module
public class TestModule {
    private IView mView;
    public TestModule(IView iView){
        this.mView=iView;
    }
    //@Provides注解的方法,提供IView类的依赖。
    @Provides
    public IView provideIView(){
        return this.mView;
    }
}
/**
 *Component必须是一个接口类或者抽象
 */
@Component(modules = TestModule.class)
public interface TestComponent {
    void inject(TestActivity testActivity);
}
上一篇下一篇

猜你喜欢

热点阅读