android - 如何使用 Dagger 2 在 Android 服务中注入(inject)单例

Question

我正在尝试将单例管理器添加到 Android 服务中。
问题是注入(inject)的管理器与 ViewModel 中的管理器不同。

Dagger 组件

@Singleton
@Component(modules = {ApplicationModule.class, AppScreenModule.class, ServiceModule.class})
public interface AppComponent {

    void inject(App application);

    void inject(OpportunisticService opportunisticService);

    @Component.Builder
    interface Builder {
        AppComponent build();

        Builder applicationModule(ApplicationModule applicationModule);
    }
}

模块

@Module
class ApplicationModule {    
    private final App mApp;

    ApplicationModule(App app) {
        mApp = app;
    }

    @Provides
    @Named("ApplicationContext")
    Context provideContext() {
        return mApp.getApplicationContext();
    }

    @Provides
    App provideApplication() {
        return mApp;
    }

    @Provides
    PeersManager providePeersManager() {
        return new PeersManager();
    }
}

@Module
abstract class ServiceModule {

    @ContributesAndroidInjector
    abstract OpportunisticService bindOpportunisticService();
}

初始化

public class Components {
    private static AppComponent sComponent;

    public static void initialize(App app) {
        // Initialize the AppComponent
        Preconditions.checkState(sComponent == null, "AppComponent already initialized");
        sComponent = DaggerAppComponent.builder()
                                       .applicationModule(new ApplicationModule(app))
                                       .build();
    }

    public static AppComponent app() {
        if (BuildConfig.DEBUG)
            Preconditions.checkState(sComponent == null, "AppComponent not initialized");
        return sComponent;
    }
}

public class App extends Application implements HasActivityInjector, HasServiceInjector {
    @Inject
    DispatchingAndroidInjector<Activity> mActivityDispatchingAndroidInjector;

    @Inject
    DispatchingAndroidInjector<Service> mServiceDispatchingAndroidInjector;

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

        // Initialize the AppComponent
        Components.initialize(this);
        Components.app().inject(this);
    }

    @Override
    public AndroidInjector<Activity> activityInjector() {
        return mActivityDispatchingAndroidInjector;
    }

    @Override
    public AndroidInjector<Service> serviceInjector() {
        return mServiceDispatchingAndroidInjector;
    }
}

声明 PeerManager :

@Singleton
public class PeersManager {

    @Inject
    public PeersManager() {
    }
}

使用 PeersManager :

public class ViewModel {
    private final PeersManager mPeersManager;

    @Inject
    public ViewModel (PeersManager peersManager) {
        mPeersManager = peersManager;
    }
}

public class OpportunisticService extends Service {
    @Inject
    PeersManager mPeersManager;

    @Override
    public void onCreate() {
        super.onCreate();
        AndroidInjection.inject(this);
    }
}

问题是 ViewModel.mPeersManager不同于 OpportunisticService.mPeersManager ，我希望它们是相同的，因为 PeersManager被标记为单例。

我预计会发生这种情况，因为 AndroidInjector 不同。代表 Activity/ Fragment对于 Service .

Answer 1

您已将类(class)注释为 @Singleton作为类级别的注解，但 Dagger 忽略了该注解，支持更明确的 @Provides bundle 。如果使用得当，这将允许您覆盖来自类本身的任何范围，因为 Dagger 假定无论类附带的“默认值”如何，您都明确列出了组件上的模块和绑定(bind)。 Dagger 看不到@Provides里面方法本身，所以它不知道实例是来自构造函数、静态方法返回值、Module 实例字段还是其他一些更复杂的逻辑。在这里，Dagger 看到一个未作用域的 @Provides使用未知的实现并信任您自己管理范围，而不管任何范围注释或 @Inject构造函数注解。
因此，您可以选择以下两个选项之一:

马克 @Singleton在您的 @Provides PeersManager providePeersManager() 上AppModule 中的方法。这允许您在此处显式调用 PeersManager 构造函数。此时，您可以选择删除 @Singleton PeersManager 类本身的注释，因为 Dagger 不会读取它:它显式地推迟到您的 Module 的范围配置。

删除您的 @Provides PeersManager完全方法并添加 @Inject -PeersManager 的注释构造函数。此时，Dagger 负责创建 PeersManager，因此它会观察到 @Singleton PeersManager 类上的范围注释。
如果你有一个接口(interface)实现拆分，例如接口(interface) PeersManager 和实现类 DefaultPeersManager，那么你可以将其表示为 @Binds绑定(bind)到 abstract @Module abstract @Binds PeersManager providePeersManager(DefaultPeersManager impl) 的类(class).在这种情况下，Dagger 会看到您正在将 PeersManager 重定向到 DefaultPeersManager，但 Dagger 知道如何为 DefaultPeersManager 提供其@Inject。构造函数和 @Singleton注解。