五 Dagger2的Dependency和SubComponent

概述:传统方式,Dagger2的依赖注入如下:

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

意思是MainModule模块提供实例对象,注入到MainActivity中。
除此之外,还有另外两种方式,让Component可以通过其他的Component完成依赖注入,可以划分为:依赖方式 和 继承方式。

  • 依赖方式
    即通过依赖方式实现时,需要在Component中指定它所依赖的Component名字,使用方式如下:
@Component(modules = MainModule.class,dependencies = DependencyComponent.class)
public interface MainComponent {
    void inject(MainActivity activity);
}

这段代码的意思是,可以通过MainModule模块提供实例对象,也可以依赖DependencyComponent提供。
那么先看看DependencyComponent这个类:

@Component(modules = DependencyModule.class)
public interface DependencyComponent {
       Teacher getTeacher();
}

@Module
public class DependencyModule {
    @Provides
    static Teacher provideTeacher() {
        return new Teacher();
    }
}

这里将@Module和@Component写在一块了,是为了方便查看。首先看DependencyComponent ,意思是它由DependencyModule来提供实例对象。而DependencyModule 可以提供Teacher这个实例对象。有人可能会发现,为什么DependencyComponent 没有inject方法。你看那个MainComponent都有。
这是因为作为依赖的DependencyComponent 不需要写Inject,只需要指明,这个DependencyComponent 能提供什么类型的对象即可。这里面的getTeacher()的意思是可以提供Teacher这个类的对象。

最后我们再回头看最开始的MainComponent

@Component(modules = MainModule.class,dependencies = DependencyComponent.class)
public interface MainComponent {
    void inject(MainActivity activity);
}

这里面MainModule只提供了Student对象,而DependencyComponent中的DependencyModule模块,可以提供Teacher对象。我们可以在MainActivity中进行验证:

public class MainActivity extends AppCompatActivity {


    @Inject
    Student student;

   @Inject
    Teacher teacher;

可以打印下这个Teacher对象,如果不为NULL,说明依赖成功

D/teacher: com.example.learndragger.Teacher@59344c4

可以看到这个Teacher是有值的,以上这种方式就是通过依赖别的Component来实现对象注入。上面说过,除了这个依赖方式,还有一种叫做继承的方式,下面就看下继承方式。

  • 继承方式
    继承方式,概括的说就是:通过另一个Component继承一个已有的Component,就可以使用这个已有的Component中的实例对象。和JAVA继承的概念特别相像。
    具体的使用如下:
@Subcomponent
public interface SubMainComponent {
    void inject(MainActivity activity);
}

首先定义一个SubMainComponent,用@Subcomponent注解,这里面不需要添加任何@Module模块,因为它作为一个子Component,待会可以继承MainComponent 来获取实例对象。

@Component(modules = MainModule.class,dependencies = DependencyComponent.class)
public interface MainComponent {
    void inject(MainActivity activity);


    SubMainComponent getSubComponent();
}

然后在MainComponent 里面定义一个方法getSubComponent,表示SubMainComponent 继承MainComponent

public class MainActivity extends AppCompatActivity {


    @Inject
    Student student;
    @Inject
    Teacher teacher;


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

        DependencyComponent dependencyComponent = DaggerDependencyComponent.create();
        //在这里完成手动注入
        MainComponent mainComponent = DaggerMainComponent
                .builder()
                .dependencyComponent(dependencyComponent)
                .build();
//                .inject(this);

//        mainComponent.inject(this);

        SubMainComponent subConponent = mainComponent.getSubConponent();
        subConponent.inject(this);

这里是把实例对象注入到MainActivity中,但是呢,不是直接注入,而是通过SubMainComponent 来注入。这是为了验证子Component能获取到父Component的实例对象。
可以注意看下注释掉的这行

//  mainComponent.inject(this);

这个的意思是用MainComponent来注入的,注释掉之后,我们获取到SubMainComponent ,这个是子Component,它继承MainComponent ,用它来注入依旧可以实现同样的效果。

总结
除了默认的注入方法以外,我们还可以通过依赖和继承两种方式来实现同样的效果。在实际项目中,可以极大的扩展我们的使用形式。可以实现一个Component在多处使用。

你可能感兴趣的:(五 Dagger2的Dependency和SubComponent)