背景
我正在将我的应用程序转换为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对象的方法。我的问题是;
如何在创建特定的RestAdapter&amp ;;时确保注入正确的依赖项。 API接口? (provideMyRestAdapter()
要求从provideGsonForMyAPI()
返回GSON,provideMyAPI()
要求从provideMyRestAdapter()
返回RestAdapter。)
我如何确保在应用程序的生命周期中只创建了两个RestAdapter实例(一个用于我的api,另一个用于第三方api),因为创建RestAdapter被认为是昂贵的。我在返回RestAdapters的方法上使用@Named
属性。例如,当将依赖项直接注入到字段时:@Inject("myApiRestAdapter") RestAdapter myRestadapter;
是Dagger 2每次都要创建新的RestAdapter,还是要使用之前创建的(如@Singleton
但对于特定对象)?< / p>
我刚刚开始使用Dagger 2,我对如何使用它的理解可能仍然不正确。如果我在这里做错了,请纠正我。感谢您提出这个长期的问题。
答案 0 :(得分:28)
您已经解决了这个问题的一半。要完成解决方案,请尝试执行以下操作:
@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的新实例,我认为它确实如此,但我不确定。
希望这有帮助!
答案 1 :(得分:0)
在发布对类似问题的答案后,我看到了该主题。我想提供一个链接,因为我认为根据您的情况,相同的方法可能会有用。对于这个确切的问题可能有些大材小用,但我想分享一下,以防其他人帮助。
https://stackoverflow.com/a/52348744/5046784
简而言之,您可以为每个命名对象(例如MyApiGson和ThirdPartyApiGson)创建唯一的接口/类,然后为这些对象而不是通用Gson类创建@Provides。这样,您可以按类/接口而不是查询或记住的魔术字符串名称注入实例。它的工作量还多一些,但是当您有许多提供相同类的不同实例的独立模块时,它会有所帮助。