背景

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

之前我做了什么

我创建了两个Retrofit RestAdapters,并使用Service Locator模式在需要时获取它们。打算用于我自己的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对象的方法。我的问题是;
  • 在创建特定的RestAdapter和AP​​I接口(interface)时,如何确保注入(inject)正确的依赖项? (provideMyRestAdapter()要求从provideGsonForMyAPI()返回GSON,而provideMyAPI()要求从provideMyRestAdapter()返回RestAdapter。)
  • 如何确保在应用程序的生命周期内仅创建两个RestAdapter实例(一个用于我的api,另一个用于第三方api),因为创建RestAdapter被认为是昂贵的。我在返回RestAdapters的方法上使用@Named属性。例如,当像这样直接将依赖项注入(inject)到字段中时:@Inject("myApiRestAdapter") RestAdapter myRestadapter;是Dagger 2每次都要创建新的RestAdapter还是要使用以前创建的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实例,请像使用其他方法一样,为两个提供给RestAdapter的方法添加@Singleton注释。至于您的其他问题,Dagger 2是否在每次必须注入(inject)它时都会创建RestAdapter的新实例,我认为它确实做到了这一点,但是我不确定。

    希望这可以帮助!

    09-11 18:11