2016-03-09 44 views
13

背景匕首2注入相同的对象类型

我我的应用程序转换为MVP架构,发现匕首2在需要时是有用的注入依赖的多个实例。我的应用需要与两个网络apis(我自己和第三方api)进行通信。有些时候,我自己的api和第三方api的请求可能会同时触发。我正在使用Retrofit与这些apis进行通信,并使用GSON进行序列化/反序列化。

我做什么之前

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

问题

我想使用DI,而不是服务定位器来获得我的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 & API接口时,正确的依赖注入? (provideMyRestAdapter()需要GSON从provideGsonForMyAPI()回来,provideMyAPI()需要RestAdapter从provideMyRestAdapter()返回。)

  2. 我怎样才能确保(一个用于我的API和其他第三方API)RestAdapter的只有两个实例的生命周期过程中所创造因为创建RestAdapter的应用程序被认为是昂贵的。我在返回RestAdapters的方法上使用@Named属性。比如说,当像这样直接向字段注入依赖关系时:@Inject("myApiRestAdapter") RestAdapter myRestadapter;是Dagger 2每次都要创建新的RestAdapter,还是要使用之前创建的(比如@Singleton,但是用于特定对象)?

我刚开始用匕首2和我的如何使用它理解可能仍然是不正确的。如果我在这里做错了,请纠正我。感谢您支持这个长期的问题。

回答

22

您已经完成了解决方案的一半。为完善解决方案尽量做到以下几点:

@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(); 
} 

为了确保只有两个你RestAdapters实例的应用程序生命周期过程中创建,注释都提供RestAdapter与@Singleton的方法,如你有做你的其他方法。至于你的其他问题,Dagger 2是否会在每次注入时都创建RestAdapter的新实例,我认为它完全是这样做的,但我不确定这一点。

希望这会有所帮助!

+0

谢谢@pratt我会试试看。我有一个问题,是不是'@ Singleton'应该只为给定的类类型创建一个对象?在这种情况下,如果我将其余的适配器注释为@ @ Singleton(RestAdapter类型),幕后会发生什么? –

+1

除了将您的方法注释为'@ Singleton',您还可以使用'@ Named'注释对其进行注释,该注释将告诉匕首为每个名称创建RestAdapter的两个不同实例。请确保通过使用'@ Named'来引用您需要的RestAdapter,就像我在上面的答案中所显示的那样。 – Harry

+0

这很有道理,谢谢。我今晚会尝试这个,回到你身边! –