android - Dagger 2注入(inject)相同对象类型的多个实例

标签 android retrofit dagger-2

背景

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

我之前做过的事情

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

问题

我正在尝试使用 DI 而不是 Service Locator 来获取我的 RestAdapter(和 API 接口(interface))。我的 NetModule 类设置如下

@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 具有返回两个 Gson 对象和两个 RestAdapter 对象的方法。我的问题是;

  1. 如何确保在创建特定的 RestAdapter 和 API 接口(interface)时注入(inject)正确的依赖项? (provideMyRestAdapter() 需要从 provideGsonForMyAPI() 返回的 GSON,而 provideMyAPI() 需要从 provideMyRestAdapter() 返回的 RestAdapter .)

  2. 我如何确保在应用程序的生命周期内只创建两个 RestAdapter 实例(一个用于我的 api,另一个用于第三方 api),因为创建 RestAdapter 被认为是昂贵的。我在返回 RestAdapters 的方法上使用 @Named 属性。例如,当将依赖项直接注入(inject)这样的字段时: @Inject("myApiRestAdapter") RestAdapter myRestaadapter; 是 Dagger 2 每次都会创建新的 RestAdapter 还是会使用之前创建的一个(比如@Singleton 但针对特定对象)?

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

最佳答案

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

@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 是否会在每次注入(inject)时创建 RestAdapter 的新实例,我认为它确实做到了这一点,但我不确定。

希望这会有所帮助!

关于android - Dagger 2注入(inject)相同对象类型的多个实例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/35883655/

相关文章:

java - 通过 XML API 改造阅读列表<Item>

android - Dagger 2 : Injecting to Activities from multiple subcomponents

android - Illegalstateexception fragment 必须是公共(public)静态类才能从实例状态正确地重新创建

Android Webview 视频问题。视频正在 youtube iframe 中被裁剪。

android - 使用复杂的 JSON 改造 POST 请求

android - 如何使用依赖注入(inject)在 ViewModel 中注入(inject)构造函数

android - 0 Dagger 2 : MVVM unable to scope a module

Android 谷歌地图当前位置方位

android - 在 Activity onResume() 上显示 Admob 插页式广告

android - 在 3G 网络中使用 Retrofit 时流被重置为 : PROTOCOL_ERROR,