Dagger 2 注入相同对象类型的多个实例

Question

背景

我正在将我的应用程序转换为 MVP 架构，并发现 Dagger 2 可用于在需要时注入依赖项。我的应用程序需要与两个网络 api 进行通信（我自己的和第三方 api）。有时可能会同时触发对我自己的 api 和第三方 api 的请求。我正在使用 Retrofit 与这些 api 进行通信，并使用 GSON 进行序列化/反序列化。

我之前做了什么

我创建了两个 Retrofit RestAdapter 并使用服务定位器模式在需要时获取它们。打算用于我自己的 api 的 RestAdapter 包括带有一些自定义 TypeAdapter 的 GSONConverter，因为我不希望 1:1 JSON 反序列化我在应用程序中的响应。另一个用于第三方的 RestAdapter api 并使用另一个具有特定字段命名策略的 GSONConverter。

问题

我正在尝试使用 DI 而不是服务定位器来获取我的 RestAdapter（和 API 接口）。我的 NetModule class 设置如下

@Module
public class NetModule {

    private static final String MY_API_URL = "my_api_url";
    private static final String THIRD_PARTY_API_URL = "third_party_api_url";

    @Provides
    @Singleton
    Cache provideOkHttpCache(Application application) {
        int cacheSize = 10 * 1024 * 1024; // 10 MiB
        return new Cache(application.getCacheDir(), cacheSize);
    }

    @Provides
    @Singleton
    OkHttpClient provideOkHttpClient(Cache cache) {
        OkHttpClient client = new OkHttpClient();
        client.setCache(cache);
        return client;
    }

    @Provides
    @Singleton
    TypeAdapter<MyClass> provideMyAPITypeAdapter() {
        return new TypeAdapter<MyClass>() {
            // implementation ignored
        };
    }

    @Provides
    @Named("myApiGson")
    Gson provideGsonForMyAPI(TypeAdapter<MyClass> adapter) {
        return new GsonBuilder()
                .registerTypeAdapter(MyClass.class, adapter)
                .setDateFormat("yyyy-MM-dd HH:mm:ss")
                .create();
    }

    @Provides
    @Named("thirdPartyApiGson")
    Gson provideGsonForThirdPartyAPI() {
        return new GsonBuilder()
                .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
                .create();
    }

    @Provides
    @Named("myApiRestAdapter")
    RestAdapter provideMyRestAdapter(Gson gson, OkHttpClient okHttpClient) {
       return new RestAdapter.Builder()
                .setEndpoint(MY_API_URL)
                .setConverter(new GsonConverter(gson))
                .setClient(new OkClient(okHttpClient))
                .build();
    }

    @Provides
    @Named("thirdPartyApiRestAdapter")
    RestAdapter provideThirdPartyRestAdapter(Gson gson, OkHttpClient okHttpClient) {
       return new RestAdapter.Builder()
                .setEndpoint(THIRD_PARTY_API_URL)
                .setConverter(new GsonConverter(gson))
                .setClient(new OkClient(okHttpClient))
                .build();
    }

    @Provides
    @Singleton
    MyAPI provideMyAPI(RestAdapter adapter){
        return adapter.create(MyAPI.class);
    }

    @Provides
    @Singleton
    ThirdPartyAPI provideThirdPartyAPI(RestAdapter adapter){
        return adapter.create(ThirdPartyAPI.class);
    }
}

正如您在上面的代码中看到的，NetModule 具有 return 两个 Gson 对象和两个 RestAdapter 对象的方法。我的问题是；

如何确保在创建特定的 RestAdapter 和 API 接口时注入正确的依赖项？（provideMyRestAdapter() 需要来自 provideGsonForMyAPI() 的 GSON return，provideMyAPI() 需要来自 provideMyRestAdapter() 的 RestAdapter return。）
如何确保在应用程序的生命周期内只创建两个 RestAdapter 实例（一个用于我的 api，另一个用于第三方 api）因为创建 RestAdapter 被认为是昂贵的。我在方法 returning RestAdapters 上使用 @Named 属性。例如，当像这样将依赖项直接注入字段时：@Inject("myApiRestAdapter") RestAdapter myRestadapter; 是 Dagger 2 每次都会创建新的 RestAdapter 还是会使用之前创建的一个（如 @Singleton 但针对特定对象）？

我刚刚开始使用 Dagger 2，我对如何使用它的理解可能仍然不正确。如果我在这里做错了什么，请纠正我。感谢您提出这么长的问题。

Answer 1

您已经完成了一半的解决方案。要完成解决方案，请尝试执行以下操作：

@Provides
@Named("myApiRestAdapter")
RestAdapter provideMyRestAdapter(@Named("myApiGson") Gson gson, OkHttpClient okHttpClient) {
   return new RestAdapter.Builder()
            .setEndpoint(MY_API_URL)
            .setConverter(new GsonConverter(gson))
            .setClient(new OkClient(okHttpClient))
            .build();
}

@Provides
@Named("thirdPartyApiRestAdapter")
RestAdapter provideThirdPartyRestAdapter(@Named("thirdPartyApiGson") Gson gson, OkHttpClient okHttpClient) {
   return new RestAdapter.Builder()
            .setEndpoint(THIRD_PARTY_API_URL)
            .setConverter(new GsonConverter(gson))
            .setClient(new OkClient(okHttpClient))
            .build();
}

为了确保在应用程序的生命周期内只创建两个 RestAdapter 实例，请像对其他方法所做的那样，用 @Singleton 注释提供 RestAdapter 的两个方法。至于你的另一个问题 Dagger 2 是否会在每次必须注入它时创建 RestAdapter 的新实例，我认为它确实是这样做的，但我不确定这一点。

希望对您有所帮助！

Answer 2

我在发布我对类似问题的回答后看到了这个帖子。我想提供一个 link，因为我认为根据您的情况，相同的方法可能会有用。对于这个确切的问题可能有点矫枉过正，但我想分享一下，以防它对其他人有帮助。

简而言之，您可以为每个命名对象（例如 MyApiGson 和 ThirdPartyApiGson）创建唯一的接口/classes，然后为它们创建 @Provides 而不是通用的 Gson class。通过这种方式，您可以通过 class/interface 而不是您需要查找或记住的神奇字符串名称来注入实例。它需要做更多的工作，但是当你有一堆独立的模块提供相同 Class.

的不同实例时，它会有所帮助

Dagger 2 注入相同对象类型的多个实例

Dagger 2 injecting multiple instances of same object type

android

retrofit

dagger-2