Dagger 2学习与探索(七)

上一期介绍了@Scope的含义和用法,明白了Dagger2只认这么一个标注,而且认为标注的Component为单例。那么假如我们想要实现真正的@PerActivity,即Activity范围内为单例,或者是其余的自定义范围标注,要如何做到呢?

范围标注也没有魔法,换言之不是标了@PerActivity它就自动实现Activity内单例。更确切地讲,是因为我们希望Activity内单例,而且Dagger也会帮我们实现Activity内单例,才给它标注@PerActivity

这里就不得不提Component dependencySubcomponent。它们是不同的东西,但功能非常类似,都能使Component“层次化”。“层次化”的含义是,Component出现上下级之分,下级Component依赖于上级Component的参数与提供函数,然而又可以使用不同的范围标注。(事实上,Dagger要求下级Component必须使用不同的范围标注,道理也很简单,相同范围内上级Component功能完全被下级覆盖,没有存在的必要性。

由于篇幅所限,本期只介绍Component dependency方法。

所谓Component dependency就是在上级Component内创建提供函数,让下级Component通过标注的形式来依赖上级Component(如果还有下下级,需要上级的参数,还可继承上级的接口Component,这样下下级也可以访问到上级的提供函数)。

如此一来,我们可以让Activity拥有自己的专属ComponentActivityComponent,然后每次onCreate的时候从上级AppComponent里面造一个下级ActivityComponent,这样还是只需要在初始化上级``AppComponent时提供一次构造参数(当然如果下级ActivityComponent加入了新的Module的话还是要提供新参数),同时又因为下级ActivityComponent是独立的,如果只在此Activity里面使用,就真正实现了@PerActivity`。

接下来我们将:创建AppComponent@PerApplication标注,负责注入ClassA
创建ActivityComponent@PerActivity标注,负责注入ClassBActivityComponent依赖于AppComponent

共同代码

无论如何,先定义好两个范围标注:

@Scope
@Documented
@Retention(RUNTIME)
public @interface PerApplication {}
@Scope
@Documented
@Retention(RUNTIME)
public @interface PerActivity {}

然后是ClassAClassB的代码,都在构造器内添加Log以帮助了解构造器的调用:

public class ClassA {

  private int a;
  private int b;
  private static final String TAG = "ClassA";

  public ClassA(int a, int b) {
    this.a = a;
    this.b = b;
    Log.d(TAG, "classA constructor called");
  }

  public int getA() {
    return a;
  }

  public int getB() {
    return b;
  }
}
public class ClassB {
  private static final String TAG = "ClassB";
  private ClassA classA;
  private int a;

  public ClassB(ClassA classA, int a) {
    this.classA = classA;
    this.a = a;
    Log.d(TAG, "classB constructor called");
  }

  public ClassA getClassA() {
    return classA;
  }

  public int getA() {
    return a;
  }
}

再把之前关于ClassBComponentModuleB的代码删掉。注意运行前rebuild一下,避免之前生成的代码造成影响。

Component Dependency

主体代码

使用这种方式,上级Component可以暴露自己的组件给下级Component,方法就是创建一个返回想要暴露的类型的函数,名字还是无所谓。比如这里的AppComponent是这样:

@PerApplication
@Component(modules = AppModule.class)
public interface AppComponent {

  void inject(MyApp myApp);

  ClassA getClassA();
}

对应的AppModule

@Module
public class AppModule {
  private int a;
  private int b;

  public AppModule(int a, int b) {
    this.a = a;
    this.b = b;
  }

  @Provides
  @Named("a")
  int provideIntA() {
    return a;
  }

  @Provides
  @Named("b")
  int provideIntB() {
    return b;
  }

  @PerApplication
  @Provides
  ClassA provideClassA(@Named("a") int a, @Named("b") int b) {
    return new ClassA(a, b);
  }
}

注意在AppComponent里面我们通过加入ClassA getClassA();暴露出ClassA@Provides函数给其下级,这样下级就可以从上级获取ClassA而不用自己再写一遍。
然后就是ActivityComponent

@PerActivity
@Component(dependencies = AppComponent.class, modules = ActivityModule.class)
public interface ActivityComponent {

  void inject(MainActivity mainActivity);
}

注意这种声明依赖的形式。
有时候我们会看到有些项目中,下级Component不仅在标注上声明了dependencies,还继承了上级Component的接口。其实接口继承就是单纯地继承上级中的暴露函数,往往这个Component还有下级。
如果是最下级的Component,并没有理由这么做。
然后是ActivityModule

@Module
public class ActivityModule {

  private int c;

  public ActivityModule(int c) {
    this.c = c;
  }

  @Provides
  public int provideC() {
    return this.c;
  }

  @PerActivity
  @Provides
  public ClassB provideClassB(ClassA classA, int c) {
    return new ClassB(classA, c);
  }
}

然后就是MyApp代码:

public class MyApp extends Application {

  private static MyApp appInstance = null;
  private static AppComponent appComponent = null;

  @Inject ClassA classa;

  @Override
  public void onCreate() {
    super.onCreate();

    appInstance = this;
    appComponent = DaggerAppComponent.builder().appModule(new AppModule(2, 3)).build();
    appComponent.inject(this);
  }

  public static MyApp getAppInstance() {
    return appInstance;
  }

  public static AppComponent getAppComponent() {
    return appComponent;
  }
}

MainActivity代码:

public class MainActivity extends AppCompatActivity {
  @Inject ClassB classB;

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

    DaggerActivityComponent.builder()
        .activityModule(new ActivityModule(4))
        .appComponent(MyApp.getAppComponent())
        .build().inject(this);
  }
}

重复一遍:删除之前ClassBComponentModuleB的代码,rebuild再运行。运行发现两个Log分别被打印一次。这说明了A类和B类都只实例化了一次,也就是说B类的注入确实依赖了之前注入的A类。

生成代码

现在有5个工厂类,AppModule_ProvideIntAFactoryAppModule_ProvideIntBFactoryAppModule_ProvideClassAFactoryActivityModule_ProvideCFactoryActivityModule_ProvideClassBFactory
两个注入器MyApp_MembersInjectorMainActivity_MembersInjector。这些代码都和之前的非常雷同。
我们还是把更多精力投入在两个关键类DaggerAppComponentDaggerActivityComponent

public final class DaggerAppComponent implements AppComponent {
  private Provider<Integer> provideIntAProvider;

  private Provider<Integer> provideIntBProvider;

  private Provider<ClassA> provideClassAProvider;

  private MembersInjector<MyApp> myAppMembersInjector;

  private DaggerAppComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {

    this.provideIntAProvider = AppModule_ProvideIntAFactory.create(builder.appModule);

    this.provideIntBProvider = AppModule_ProvideIntBFactory.create(builder.appModule);

    this.provideClassAProvider =
        DoubleCheck.provider(
            AppModule_ProvideClassAFactory.create(
                builder.appModule, provideIntAProvider, provideIntBProvider));

    this.myAppMembersInjector = MyApp_MembersInjector.create(provideClassAProvider);
  }

  @Override
  public void inject(MyApp myApp) {
    myAppMembersInjector.injectMembers(myApp);
  }

  @Override
  public ClassA getClassA() {
    return provideClassAProvider.get();
  }

  public static final class Builder {
    private AppModule appModule;

    private Builder() {}

    public AppComponent build() {
      if (appModule == null) {
        throw new IllegalStateException(AppModule.class.getCanonicalName() + " must be set");
      }
      return new DaggerAppComponent(this);
    }

    public Builder appModule(AppModule appModule) {
      this.appModule = Preconditions.checkNotNull(appModule);
      return this;
    }
  }
}

这个类就本身而言和上一期的差距不是很大,可以看出还是用了DoubleCheck封装,说明确实Dagger把@PerApplication也看做单例。
唯一的区别在于,多了getClassA()这个函数。这是自然的,因为这个类说到底是我们定义的AppComponent接口的实现类,自然要实现里面的抽象方法。
接下来这个就更值得仔细研究了:

public final class DaggerActivityComponent implements ActivityComponent {
  private Provider<ClassA> getClassAProvider;

  private Provider<Integer> provideCProvider;

  private Provider<ClassB> provideClassBProvider;

  private MembersInjector<MainActivity> mainActivityMembersInjector;

  private DaggerActivityComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {

    this.getClassAProvider =
        new daggerplay_com_daggerplay_components_AppComponent_getClassA(builder.appComponent);

    this.provideCProvider = ActivityModule_ProvideCFactory.create(builder.activityModule);

    this.provideClassBProvider =
        DoubleCheck.provider(
            ActivityModule_ProvideClassBFactory.create(
                builder.activityModule, getClassAProvider, provideCProvider));

    this.mainActivityMembersInjector = MainActivity_MembersInjector.create(provideClassBProvider);
  }

  @Override
  public void inject(MainActivity mainActivity) {
    mainActivityMembersInjector.injectMembers(mainActivity);
  }

  public static final class Builder {
    private ActivityModule activityModule;

    private AppComponent appComponent;

    private Builder() {}

    public ActivityComponent build() {
      if (activityModule == null) {
        throw new IllegalStateException(ActivityModule.class.getCanonicalName() + " must be set");
      }
      if (appComponent == null) {
        throw new IllegalStateException(AppComponent.class.getCanonicalName() + " must be set");
      }
      return new DaggerActivityComponent(this);
    }

    public Builder activityModule(ActivityModule activityModule) {
      this.activityModule = Preconditions.checkNotNull(activityModule);
      return this;
    }

    public Builder appComponent(AppComponent appComponent) {
      this.appComponent = Preconditions.checkNotNull(appComponent);
      return this;
    }
  }

  private static class daggerplay_com_daggerplay_components_AppComponent_getClassA
      implements Provider<ClassA> {
    private final AppComponent appComponent;

    daggerplay_com_daggerplay_components_AppComponent_getClassA(AppComponent appComponent) {
      this.appComponent = appComponent;
    }

    @Override
    public ClassA get() {
      return Preconditions.checkNotNull(
          appComponent.getClassA(), "Cannot return null from a non-@Nullable component method");
    }
  }
}

这个类创造了一个新的内部类,这里是daggerplay_com_daggerplay_components_AppComponent_getClassA。名字倒是其次,其作用就是接受AppComponent的实例,然后封装成为ClassA的工厂。我们在MainActivity里面传入的AppComponent的实例正是被如此转化成为了依赖工厂来提供ClassA实例。另外由于AppComponent也使用了@PerActivity标注,注入时还是使用上一期介绍的单例注入方法,有兴趣的同学可以自己动手尝试。

至此,我们明白了如果根据环境的结构层次来对Dagger2进行分级以及拓展,不用担心AppComponent里面注入太多Application层并用不到的东西,也不用担心在写Activity的时候还要把Application里面的东西都再重复一遍了,是不是很有用呢?

下期继续介绍Subcomponent的使用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,504评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,434评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,089评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,378评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,472评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,506评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,519评论 3 413
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,292评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,738评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,022评论 2 329
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,194评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,873评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,536评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,162评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,413评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,075评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,080评论 2 352

推荐阅读更多精彩内容