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

Question

背景

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

我以前做过什么

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

问题

我正在尝试使用DI而不是Service Locator来获取我的RestAdapter(以及API接口).我的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和AP​​I接口时,如何确保注入正确的依赖项？(provideMyRestAdapter()要求GSON返回provideGsonForMyAPI()并provideMyAPI()要求从中返回RestAdapter provideMyRestAdapter().)

2. 我怎样才能确保在应用程序的生命周期中只创建了两个RestAdapter实例(一个用于我的api,另一个用于第三方api),因为创建RestAdapter被认为是昂贵的.我正在使用@Named返回RestAdapters的方法的属性.例如,当直接向字段注入依赖关系时:@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的两个实例,请注释提供RestAdapter的方法,@Singleton就像使用其他方法一样.至于你的另一个问题,Dagger 2是否会在每次注入它时创建RestAdapter的新实例,我认为它确实如此,但我不确定这一点.

希望这可以帮助!