（转载）更新到Retrofit2的一些技巧

更新到Retrofit2的一些技巧

 

做者 小武站台 关注

2016.02.22 22:13* 字数 1348 阅读 1621评论 0喜欢 5赞扬 1

原文连接：Tips on updating to Retrofit 2
ps：其实我老早就更新到Retrofit2了 可是不一样的beta版目前改变仍是挺大的，若是你在用的话 ，要时刻跟进并查看它的changelog.该文章仍是比较倾向于1.9升级2.0 可是就像前面说的 beta2到beta4改变也是很是大的 因此一样能够参考用于备忘

Retrofit2.0已经公开发布几个月了，可是如今依然是beta版，一些开发者已经开始从以前的版本进行升级，虽然官方已经提供了文档，文章或博客让你了解最新版的相关信息，可是在StackOverflow仍是能够看到一些提问关于在升级版本的过程当中怎么处理常见功能像logging打印日志，添加request parameter或者使用JSON对象等，因此在这篇文章中，我会告诉你关于这些问题的一些技巧。

写文章时，Retrofit的版本是v2.0.0-beta4.

新的group id

第一个你会注意到的改变是新的group id,变成了com.squareup.retrofit2，因此新的依赖声明是：

compile 'com.squareup.retrofit2:retrofit:2.0.0-beta4'

新的包名

主包名已经改为了

package retrofit2;

这意味的你须要更改全部关于Retrofit的import，此外，若是你还有其余涉及到包名的代码或任务，记得也要更新他们。

proguard 配置

由于新包名，若是你开启了混淆代码，第一件要作的事就是更新配置文件的规则，它们能够在官方网站找到：

-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepattributes Signature
-keepattributes Exceptions

okhttp

okhttp如今Retrofit2内置的默认依赖，实际上，查看Retrofit2的pom文件(maven的依赖配置文件)，会发现下面的依赖：

<dependency>
      <groupId>com.squareup.okhttp3</groupId>
      <artifactId>okhttp</artifactId>
</dependency>

若是你不须要用一个特殊版本的okhttp或者其余http client,你不用作任何事情。

生成服务接口实现

service interface implementation generation

你会当即注意到的另一件事是你的生成服务接口实现的代码无法编译了。

下面是Retrofit的典型代码：

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint("https://api.github.com")
                .build();
GitHubService service = restAdapter.create(GitHubService.class);

在Retrofit2，会变成：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com")
    .build();
GitHubService service = retrofit.create(GitHubService.class);

你能够看到，依然是build模式，可是涉及的方法和类已经变了。

logging

在开发中打印网络请求和返回结果是很是重要的，若是你在Retrofit中启用了这个功能，你会发现实现该功能的方法已经不可用了。

setLogLevel(RestAdapter.LogLevel.FULL)

那是由于你如今必须依靠okhttp提供的日志系统，HttpLoggingInterceptor.

首先声明一个新的依赖，由于它不是okhttp的一部分因此要另外添加依赖：

compile 'com.squareup.okhttp3:logging-interceptor:3.1.2'

而后，建立一个interceptor实例：

HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

再而后，添加到OkHttp client实例中：

OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(httpLoggingInterceptor).build();

最后，把client设置到service interface实现中：

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

ps:其实这个log并非很好用，最好本身参考源码本身自定义一个，分分钟就搞定了。

gson converter

By default, Retrofit can only deserialize HTTP bodies into OkHttp’s ResponseBody type and it can only accept its RequestBodytype for @Body.

这意味得用来支持其余types的converter必须在建立服务接口时进行设置

为了让JSON和Java对象相互转换，咱们须要设置一个GSON转换器

首先，须要一个新的依赖：

compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta4'

而后设置converter factory:

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .addConverterFactory(GsonConverterFactory.create())
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

完整的可用converters能够查看官方文档

interceptor

Retrofit另一个有用的功能是能够拦截http请求进行监控，重写或重试

一个典型应用场景是全部http请求须要加上api key,在Retrofit2以前，能够经过RequestInterceptor实现：

final RequestInterceptor authorizationInterceptor = new RequestInterceptor() {
        @Override
        public void intercept(RequestInterceptor.RequestFacade request) {
            request.addQueryParam(MovieDbApi.PARAM_API_KEY, "YOUR_API_KEY");
        }
    };

而后 

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint(MovieDbApi.END_POINT)
                .setRequestInterceptor(authorizationInterceptor)
                .build();
movieDbApi = restAdapter.create(MovieDbApi.class);

在Retrofit2中已经再也不有效了,由于你如今必须依靠OKHttp interceptors.

你能够直接在OKHttp client实例化时进行设置：

OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl url = request.url().newBuilder().addQueryParameter(
MovieDbApi.PARAM_API_KEY, BuildConfig.MOVIE_DB_API_KEY).build();
        request = request.newBuilder().url(url).build();
        return chain.proceed(request);
    }
}).build();

而后像前面那样设置client：

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

RxJava observable

若是你正在使用RxJava,你会注意到Retrofit2 interfaces已经不支持Observable了，实际上，Call模式被用于标准的http请求。

固然你能够用你本身的类型，提供你本身的CallAdapter实现，可是幸运的是已经有可用的了，RxJavaCallAdapterFactory.简单说，它把Call转换成Observable.

首先，添加依赖：

com.squareup.retrofit2:adapter-rxjava:2.0.0-beta4

而后，用addCallAdapterFactory进行设置：

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .addConverterFactory(GsonConverterFactory.create())
    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);