[译]MVP实践(Android)-Part3:使用Retrofit调用API

如果你已经阅读了本文的第一部分和第二部分，那么你应该对本项目的modules以及结构都比较清楚，同时对怎么使用Dagger连接MVP的各层也已比较清楚。现在我们继续。。。

一起来看一下网络数据和API

几乎所有的移动应用都会通过网络和它们的服务端进行交互。Retrofit是一个完美的库，它由Jake Wharton提供。使用Retrofit可以帮助你在Android应用中非常方便的进行网络开发。

长话短说，在本项目我们使用Retrofit来访问MarvelApi，代码如下：

package com.mirhoseini.marvel.domain.client;

import com.mirhoseini.marvel.domain.model.CharactersResponse;

import retrofit2.http.GET;
import retrofit2.http.Query;
import rx.Observable;

public interface MarvelApi {

    String NAME = "name";
    String API_KEY = "apikey";
    String HASH = "hash";
    String TIMESTAMP = "ts";

    // http://gateway.marvel.com:80/v1/public/characters?name=Iron%20Man&apikey=PUBLIC_API_KEY&hash=HASH&ts=TIMESTAMP
    @GET("v1/public/characters")
    Observable getCharacters(
            @Query(NAME) String query,
            @Query(API_KEY) String publicKey,
            @Query(HASH) String hash,
            @Query(TIMESTAMP) long timestamp);
}

使用Retrofit真的非常简单，你可以在http://gateway.marvel.com/v1/public/characters这里找到这个RESTful API，这个api需要你传入一些参数来检索你所想要的内容，也就是通过姓名检索人物信息。

一个好的开发者应该经常阅读API文档，你可以在这里查阅更多Marvel 的API。

MarvelApi应该放在MVP中的哪一层呢？

所有联网请求及数据相关事情都发生在Model层。这层只进行和数据及业务逻辑有关的工作，表现层知道怎样为View层准备数据。

请不要在Model层操作数据，将数据完整的传递给表现层，它知道该做什么。。。

SOLID原则。。。

根据SOLID原则中的“单一责任”以及“一个厨师不能经营整个餐厅”，Model和Presentation有着完全独立的任务。

可以很漂亮的打印出网络请求和API返回的数据吗？为什么不可以！

Retrofit内部使用了OkHttp库，这是一个非常强大的库。通过拦截器可以产生各种魔力般的效果。我将逐一介绍，最终向你展示怎么应用到你的OKHttpClient。

通过很少的配置，你就可以要求okhttp为你在logcat中打印出适宜的log：

@Singleton
@Provides
public HttpLoggingInterceptor provideHttpLoggingInterceptor() {
    HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
    logging.setLevel(HttpLoggingInterceptor.Level.BODY);
    return logging;

}

但是请注意不要忘记在release版本中关闭这一log！你可以使用在应用编译过程中生成的BuildConfig.DEBUG来控制这一开关。

缓存API的结果怎么会导致不再使用数据库！！！

我第一次这么做是在一个阅读应用中，整个的团队成员快被所有的数据库记录更新和查询搞死。

使用OkHttp的缓存功能，你可以处理http header中的缓存信息，并缓存一个离线文件，有时这可能是数据库痛点的完美解决方案。

@Provides
@Singleton
public Cache provideCache(@Named("cacheDir") File cacheDir, @Named("cacheSize") long cacheSize) {
    Cache cache = null;

    try {
        cache = new Cache(new File(cacheDir.getPath(), HTTP_CACHE_PATH), cacheSize);
    } catch (Exception e) {
        e.printStackTrace();
    }

    return cache;
}

@Singleton
@Provides
@Named("cacheInterceptor")
public Interceptor provideCacheInterceptor(@Named("cacheMaxAge") int maxAgeMin) {
    return chain -> {
        Response response = chain.proceed(chain.request());

        CacheControl cacheControl = new CacheControl.Builder()
                .maxAge(maxAgeMin, TimeUnit.MINUTES)
                .build();

        return response.newBuilder()
                .header(CACHE_CONTROL, cacheControl.toString())
                .build();
    };
}

@Singleton
@Provides
@Named("offlineInterceptor")
public Interceptor provideOfflineCacheInterceptor(StateManager stateManager, @Named("cacheMaxStale") int maxStaleDay) {
    return chain -> {
        Request request = chain.request();

        if (!stateManager.isConnect()) {
            CacheControl cacheControl = new CacheControl.Builder()
                    .maxStale(maxStaleDay, TimeUnit.DAYS)
                    .build();

            request = request.newBuilder()
                    .cacheControl(cacheControl)
                    .build();
        }

        return chain.proceed(request);
    };
}

在这个例子中使用了两个缓存拦截器：

• 一个缓存拦截器更改API响应的header以获得2分钟（maxAgeMin）的缓存，这意味着以接下来的两分钟内用户再次请求相同的数据时不会访问网络API。
• 另外一个是离线拦截器，这个拦截器将API返回的数据文件在缓存目录（这个目录通过appmodule的Dagger提供）保存7天（maxStableDay）。

如果觉得这些都是新东西，你不必惊慌，通过一些示例工程你就学会怎么使用拦截器。

在API调用失败后，你是否信任网络条件？ 不，请重试！

在实际应用中，网络连接经常会断开，甚至出现服务掉线几秒钟，这将给应用带来极大的麻烦，所以在告知用户之前请再试一下！

我查找使用RxJava的重试策略，但没有一个能够与Retrofit配合，但拦截器可以：

@Singleton
@Provides
@Named("retryInterceptor")
public Interceptor provideRetryInterceptor(@Named("retryCount") int retryCount) {
    return chain -> {
        Request request = chain.request();
        Response response = null;
        IOException exception = null;

        int tryCount = 0;
        while (tryCount < retryCount && (null == response || !response.isSuccessful())) {
            // retry the request
            try {
                response = chain.proceed(request);
            } catch (IOException e) {
                exception = e;
            } finally {
                tryCount++;
            }
        }

        // throw last exception
        if (null == response && null != exception)
            throw exception;

        // otherwise just pass the original response on
        return response;
    };
}

你完全可以根据自己的需求来定制更多的重试次数，或者更多的条件来决定是否重试，不过我觉得这个已经可以了。:)

好了，怎么把所有的拦截器和附加到OkHttp client？

所有的拦截器都由ClientModule提供，同时也由ClientModule添加到OkHttpClient：

package com.mirhoseini.stylight.domain;

/*...*/

@Module
public class ClientModule {
    /*...*/

    @Singleton
    @Provides
    public OkHttpClient provideOkHttpClient(HttpLoggingInterceptor loggingInterceptor,
                                            @Named("networkTimeoutInSeconds") int networkTimeoutInSeconds,
                                            @Named("isDebug") boolean isDebug,
                                            Cache cache,
                                            @Named("cacheInterceptor") Interceptor cacheInterceptor,
                                            @Named("offlineInterceptor") Interceptor offlineCacheInterceptor,
                                            @Named("retryInterceptor") Interceptor retryInterceptor) {

        OkHttpClient.Builder okHttpClient = new OkHttpClient.Builder()
                .addNetworkInterceptor(cacheInterceptor)
                .addInterceptor(offlineCacheInterceptor)
                .addInterceptor(retryInterceptor)
                .cache(cache)
                .connectTimeout(networkTimeoutInSeconds, TimeUnit.SECONDS);

        //show logs if app is in Debug mode
        if (isDebug)
            okHttpClient.addInterceptor(loggingInterceptor);

        return okHttpClient.build();
    }
    
    /*...*/
    
}

请注意if(isDebug)语句，它返回的是BuildConfig.DEBUG的结果。
这里同时还设置了网络Timeout，告诉OkHttp用于等待API响应的时间。

。。。Retrofit在哪里！

Ok，最后的步骤就是写下这些代码。。。在ApiModule中我们使用OKHttpClient来创建Retrofit实例，并用这个Retrofit实例来创建MarvelApi。

package com.mirhoseini.marvel.domain;

/*...*/

@Module
public class ApiModule {

    @Provides
    @Singleton
    public MarvelApi provideMarvelApi(Retrofit retrofit) {
        return retrofit.create(MarvelApi.class);
    }

    @Provides
    @Singleton
    public Retrofit provideRetrofit(HttpUrl baseUrl, Converter.Factory converterFactory, CallAdapter.Factory callAdapterFactory, OkHttpClient okHttpClient) {
        return new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(converterFactory)
                .addCallAdapterFactory(callAdapterFactory)
                .client(okHttpClient)
                .build();
    }

    @Provides
    @Singleton
    public Converter.Factory provideGsonConverterFactory(Gson gson) {
        return GsonConverterFactory.create(gson);
    }

    @Singleton
    @Provides
    public Gson provideGson() {
        return new Gson();
    }

    @Provides
    @Singleton
    public CallAdapter.Factory provideRxJavaCallAdapterFactory() {
        return RxJavaCallAdapterFactory.create();
    }

}

在这里你必须提供BaseURL，它通常是你服务端API地址开头不变的部分，本例中就是“http://gateway.marvel.com:80/”。 （请不要忘记最后的‘/’,Retrofit需要这一部分，否则可能会出现异常）

这样提供出来的Api会被SearchInteractorImpl.java使用，它和service进行交互。Retrofit知道如何使用RxJava进行响应，你可以轻松地捕获结果并使用Gson解析，并使用它与其他RxJava操作符（如，map，flatmap，filter等）来操作和准备响应，并将其传递给View层最终展现给用户。

就这么多吧。。。

请从github上clone一份代码并熟悉一下，因为从下一部分我将更多的介绍RxJava和RxAndroid，以及它们怎么将API响应从core传递到View层。

我期待您的意见和帮助以便更好的改进这篇文章。

原文链接：Yet another MVP article — Part 3: Calling APIs using Retrofit