Android Dagger 2 - 如何使自定义范围成为本地单例
Android Dagger 2 - how to make custom scope be a local singleton
根据这样的教程one:在 Dagger2 中,我们能够使用自定义作用域提供本地单例对象。
我已经有一个全局 appComponent,我的目标是创建一个 activity 范围,允许子组件具有本地单例提供程序。
我的问题是当我创建一个自定义范围并注入我的 activity 两次时,我发现提供的对象不是同一个对象,即使我用自定义范围标记了它。对于使用 @Singleton 注释的 appComponent,它工作正常。
让我们看看我是如何做到的:
这是自定义 activity 范围:
@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 class 以了解我希望作为单例提供的内容:
@Module
public class PresenterModule {
@Provides
@ActivityScope
LoginPresenter provideLoginPresenter(Context context) {
return new LoginPresenter(context);
}
}
现在当我实际使用它时,我在我的应用程序中设置它 class 像这样:
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());
}
}
然后最后在任何 activity 我这样做:
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 是另一个对象,因此它不会为我创建一个本地单例,只有在我取消引用 activity 子组件时才会被销毁。
我在这里错过了什么?我希望它成为本地单例的原因是为了更改配置。这样可以在配置更改期间维护演示者。
在您的应用程序中 class 您创建并 return 一个 new 子组件。
public ActivitySubComponent getActivityComponent() {
return appComponent.plus(new PresenterModule(),new UseCaseModule());
}
现在范围意味着在一个范围内一个对象只存在一次。但在您的情况下,您创建了 2 个不同的组件。这 2 个组件将共享其父组件(它们是子组件)中的所有内容,但它们范围内的任何内容都将被重新创建,但对 它们的 范围是唯一的。
组件中的任何内容都将使用相同的 @ActivityScope
注释对象,但如果您创建 2 个组件,您将拥有所有内容的 2 个副本。
如果以@Singleton
为例,并不意味着该对象将是一个实际的Singleton。它是您的根组件应该具有的范围的名称,它应该只创建 一次 并在应用程序的生命周期内保留。
如果您要创建 2 个 @Singleton
的 AppComponents,您可以观察到相同的行为 - 您的对象的两个不同实例。
在您的示例中,Retrofit
是相同的,因为您两次都使用相同的 AppComponent
,但是 LoginPresenter
会与您创建的每个 ActivitySubComponent
一起重新创建。
对于 Dagger,您应该尝试让您的组件遵循与其作用域相同的生命周期,因此您的应用程序应该拥有一个 AppComponent
,并且每个 Activity 都应该有自己的 ActivityComponent
(将组件保留为成员变量!)。当您创建一个新的 Activity 时,您应该创建一个新的 @ActivityScope
范围内的组件,但不要太频繁。
您应该从应用程序中删除 getActivityComponent()
并保留对 ActivitySubComponent
的引用,因为使用相同的组件 注入作用域依赖项 会给您相同的对象。
activityComponent.inject(this);
activityComponent.inject(this);
// call it as many times as you'd like.
activityComponent.inject(this);
只是不要重新创建您的组件。
根据这样的教程one:在 Dagger2 中,我们能够使用自定义作用域提供本地单例对象。
我已经有一个全局 appComponent,我的目标是创建一个 activity 范围,允许子组件具有本地单例提供程序。
我的问题是当我创建一个自定义范围并注入我的 activity 两次时,我发现提供的对象不是同一个对象,即使我用自定义范围标记了它。对于使用 @Singleton 注释的 appComponent,它工作正常。 让我们看看我是如何做到的:
这是自定义 activity 范围:
@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 class 以了解我希望作为单例提供的内容:
@Module
public class PresenterModule {
@Provides
@ActivityScope
LoginPresenter provideLoginPresenter(Context context) {
return new LoginPresenter(context);
}
}
现在当我实际使用它时,我在我的应用程序中设置它 class 像这样:
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());
}
}
然后最后在任何 activity 我这样做:
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 是另一个对象,因此它不会为我创建一个本地单例,只有在我取消引用 activity 子组件时才会被销毁。 我在这里错过了什么?我希望它成为本地单例的原因是为了更改配置。这样可以在配置更改期间维护演示者。
在您的应用程序中 class 您创建并 return 一个 new 子组件。
public ActivitySubComponent getActivityComponent() {
return appComponent.plus(new PresenterModule(),new UseCaseModule());
}
现在范围意味着在一个范围内一个对象只存在一次。但在您的情况下,您创建了 2 个不同的组件。这 2 个组件将共享其父组件(它们是子组件)中的所有内容,但它们范围内的任何内容都将被重新创建,但对 它们的 范围是唯一的。
组件中的任何内容都将使用相同的 @ActivityScope
注释对象,但如果您创建 2 个组件,您将拥有所有内容的 2 个副本。
如果以@Singleton
为例,并不意味着该对象将是一个实际的Singleton。它是您的根组件应该具有的范围的名称,它应该只创建 一次 并在应用程序的生命周期内保留。
如果您要创建 2 个 @Singleton
的 AppComponents,您可以观察到相同的行为 - 您的对象的两个不同实例。
在您的示例中,Retrofit
是相同的,因为您两次都使用相同的 AppComponent
,但是 LoginPresenter
会与您创建的每个 ActivitySubComponent
一起重新创建。
对于 Dagger,您应该尝试让您的组件遵循与其作用域相同的生命周期,因此您的应用程序应该拥有一个 AppComponent
,并且每个 Activity 都应该有自己的 ActivityComponent
(将组件保留为成员变量!)。当您创建一个新的 Activity 时,您应该创建一个新的 @ActivityScope
范围内的组件,但不要太频繁。
您应该从应用程序中删除 getActivityComponent()
并保留对 ActivitySubComponent
的引用,因为使用相同的组件 注入作用域依赖项 会给您相同的对象。
activityComponent.inject(this);
activityComponent.inject(this);
// call it as many times as you'd like.
activityComponent.inject(this);
只是不要重新创建您的组件。