Android Dagger 2 - 如何使自定义范围成为本地单例

时间:2017-05-24 16:24:32

标签: android dagger-2

根据这样的教程one:在Dagger2中,我们可以使用自定义范围提供本地单例对象。

我已经有了一个全局appComponent,我的目标是创建一个允许子组件拥有本地单例提供者的活动范围。

我的问题是当我创建一个自定义范围并将我的活动注入两次时,我看到提供的对象不是同一个,即使我用自定义范围标记它。对于使用@Singleton注释的appComponent,它工作正常。 让我们来看看我是如何做到的:

以下是自定义活动范围:

@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface ActivityScope {
}

以下是我如何定义子组件:

@ActivityScope
@Subcomponent(modules = {PresenterModule.class, UseCaseModule.class})
public interface ActivitySubComponent {
    void inject(LoginActivity target);
    void inject(LoginPresenter target);
    void inject(UCGetFireBaseAccount target);
}

请注意,我已使用上面自定义的@ActivityScope注释标记了此子组件。 现在让我们看一下作为父组件的appComponent和全局:

@Singleton
@Component(modules = {AppModule.class, NetworkModule.class, RepositoryModule.class})
public interface AppComponent {
    void inject(myappCloudRepo target);
    void inject (FireBaseCloudRepo target);
    ActivitySubComponent plus(PresenterModule presenterModule, UseCaseModule useCaseModule);
}

注意ActivitySubComponent在此定义为子组件。

最后让我们看一下presenterModule类,看看我想以单身形式提供什么:

@Module
public class PresenterModule {

        @Provides
        @ActivityScope
        LoginPresenter provideLoginPresenter(Context context) {
        return new LoginPresenter(context);
    }
 }

现在,当我实际使用它时,我在我的应用程序类中进行了设置:

public class MyApplication extends Application {

    private AppComponent appComponent;

    @Override
    public void onCreate() {
        super.onCreate();
        appComponent = initDagger(this);
    }

    public AppComponent getAppComponent() {
       return appComponent;
    }

    protected AppComponent initDagger(MyApplication application) {
        return DaggerAppComponent.builder()
                .appModule(new AppModule(application))
                .build();
    }

    public ActivitySubComponent getActivityComponent() {
       return appComponent.plus(new PresenterModule(),new UseCaseModule());
    }
}

最后,在任何活动中,我这样做:

public class LoginActivity extends AppCompatActivity{

    ActivitySubComponent activityComponent;

    //this loginpresenter is from the activitysubcomponent
    @Inject
    LoginPresenter loginPresenter;

    //this retrofit object is from the appcomponent
    @Inject
    Retrofit retrofit;

   @Override
   protected void onCreate(@Nullable Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       activityComponent= ((MyApplication)getApplication()).getActivityComponent();
       activityComponent.inject(this);

       Log.d("j2emanue",loginPresenter.toString());
       Log.d("j2emanue",retrofit.toString());


      activityComponent= ((MyApplication)getApplication()).getActivityComponent();
      activityComponent.inject(this);

      Log.d("j2emanue2",loginPresenter.toString());
      Log.d("j2emanue2",retrofit.toString());
    }
}

当我在注入TWICE后查看日志时,我希望所有对象都是相同的,但是loginPresenter是另一个实例,但改造是相同的,所以这是有效的。 这是日志:

05-23 23:33:35.617 31298-31298/com.myapp.mobile.myappfashion D/j2emanue: com.myapp.mobile.myappfashion.UI.Presenters.LoginPresenter@1c27a460
05-23 23:33:35.617 31298-31298/com.myapp.mobile.myappfashion D/j2emanue: retrofit2.Retrofit@13366d19
05-23 23:33:35.617 31298-31298/com.myapp.mobile.myappfashion D/j2emanue2: com.myapp.mobile.myappfashion.UI.Presenters.LoginPresenter@3dc041de
05-23 23:33:35.617 31298-31298/com.myapp.mobile.myappfashion D/j2emanue2: retrofit2.Retrofit@13366d19

请注意,loginpresenter是另一个对象,所以它不会为我创建一个本地单例,只有当我取消引用activitysubcomponent时才会销毁它。 我在这里失踪了什么?我希望它成为本地单例的原因是配置更改。这样,可以在配置更改期间维护演示者。

1 个答案:

答案 0 :(得分:4)

在您的应用程序类中,您创建并返回 new 子组件。

public ActivitySubComponent getActivityComponent() {
   return appComponent.plus(new PresenterModule(),new UseCaseModule());
}

现在范围意味着范围内的 对象只存在一次。但在您的情况下,您创建了2个不同的组件。这两个组件将共享其父组件中的所有内容(它们是子组件),但其范围内的任何内容都将被重新创建,但对于范围是唯一的。
组件中的任何内容都将使用相同的@ActivityScope带注释的对象,但如果您创建2个组件,则将拥有2个副本。

如果以@Singleton为例,并不意味着该对象将是一个实际的Singleton。它是您应该为根组件创建的范围的名称,该组件只应在创建一次并在应用程序的生命周期内保留。
如果您要创建2个@Singleton的AppComponents,您可以观察到相同的行为 - 对象的两个不同实例。

在您的示例中Retrofit是相同的,因为您同时使用相同的AppComponent,但LoginPresenter会与您创建的每个ActivitySubComponent一起重新创建。

使用Dagger,您应该尝试将组件的生命周期与其范围相同,因此您的应用应该包含AppComponent,并且每个活动都应该拥有自己的ActivityComponent(将组件保留为成员变量!)。当您创建一个新的Activity时,您应该创建一个新的@ActivityScope范围的组件,但不会更频繁。

您应该从应用程序中删除getActivityComponent()并保留对ActivitySubComponent的引用,因为使用相同的组件注入带范围的依赖项将为您提供相同的对象。< / p>

activityComponent.inject(this);
activityComponent.inject(this);
// call it as many times as you'd like.
activityComponent.inject(this);

只是不要重新创建你的组件。