Retrofit 2.0：有史以来最大的改进

原文：Retrofit 2.0: The biggest update yet on the best HTTP Client Library for Android

不熟悉Retrofit的同学可以先参考这篇文章： Retrofit – Java(Android) 的REST 接口封装类库 ，很适合入门。

 

因为其简单与出色的性能，Retrofit 是安卓上最流行的HTTP Client库之一。

不过它的缺点是在Retrofit 1.x中没有直接取消正在进行中任务的方法。如果你想做这件事必须手动杀死，而这并不好实现。

Square几年前曾许诺这个功能将在Retrofit 2.0实现，但是几年过去了仍然没有在这个问题上有所更新。

直到上周，Retrofit 2.0 才从候选发布阶段变成Beta 1 ，并且公开给所有人。在尝试了之后，我不得不说自己对新的模式和新的功能印象深刻。有许多改进，本文将讨论它们。让我们开始吧！

包还是那个包只是换了新版本

如果你想在自己的项目中导入Retrofit 2.0，那么在build.gradle的依赖一节里面添加这行代码：

1.  compile 'com.squareup.retrofit:retrofit:2.0.0-beta1'

Sync gradle 文件之后你就可以使用Retrofit 2.0了。

新的Service定义方式，不再有同步和异步之分

关于在Retrofit 1.9中service 接口的定义，如果你想定义一个同步的函数，你应该这样定义：

1. /* Synchronous in Retrofit 1.9 */
2.  
3. public interface APIService {
4.  
5.     @POST("/list")
6.     Repo loadRepo();
7.  
8. }

而定义一个异步的则是这样：

1. /* Asynchronous in Retrofit 1.9 */
2.  
3. public interface APIService {
4.  
5.     @POST("/list")
6.     void loadRepo(Callback<Repo> cb);
7.  
8. }

但是在Retrofit 2.0上，只能定义一个模式，因此要简单得多。

1. import retrofit.Call;
2.  
3. /* Retrofit 2.0 */
4.  
5. public interface APIService {
6.  
7.     @POST("/list")
8.     Call<Repo> loadRepo();
9.  
10. }

而创建service 的方法也变得和OkHttp的模式一模一样。如果要调用同步请求，只需调用execute；而发起一个异步请求则是调用enqueue。

同步请求

1. // Synchronous Call in Retrofit 2.0
2.  
3. Call<Repo> call = service.loadRepo();
4. Repo repo = call.execute();

以上的代码会阻塞线程，因此你不能在安卓的主线程中调用，不然会面临NetworkOnMainThreadException。如果你想调用execute方法，请在后台线程执行。

异步请求

1. // Synchronous Call in Retrofit 2.0
2.  
3. Call<Repo> call = service.loadRepo();
4. call.enqueue(new Callback<Repo>() {
5.     @Override
6.     public void onResponse(Response<Repo> response) {
7.         // Get result Repo from response.body()
8.     }
9.  
10.     @Override
11.     public void onFailure(Throwable t) {
12.  
13.     }
14. });

以上代码发起了一个在后台线程的请求并从response 的response.body()方法中获取一个结果对象。注意这里的onResponse和onFailure方法是在主线程中调用的。

我建议你使用enqueue，它最符合 Android OS的习惯。

取消正在进行中的业务

service 的模式变成Call的形式的原因是为了让正在进行的事务可以被取消。要做到这点，你只需调用call.cancel()。

1.  call.cancel();

事务将会在之后立即被取消。好简单嘿嘿！

Converter现在从Retrofit中删除

在Retrofit 1.9中，GsonConverter 包含在了package 中而且自动在RestAdapter创建的时候被初始化。这样来自服务器的son结果会自动解析成定义好了的Data Access Object（DAO）

但是在Retrofit 2.0中，Converter 不再包含在package 中了。你需要自己插入一个Converter 不然的话Retrofit 只能接收字符串结果。同样的，Retrofit 2.0也不再依赖于Gson 。

如果你想接收json 结果并解析成DAO，你必须把Gson Converter 作为一个独立的依赖添加进来。

1. compile 'com.squareup.retrofit:converter-gson:2.0.0-beta1'

然后使用addConverterFactory把它添加进来。注意RestAdapter的别名仍然为Retrofit。

1. Retrofit retrofit = new Retrofit.Builder()
2.         .baseUrl("http://api.nuuneoi.com/base/")
3.         .addConverterFactory(GsonConverterFactory.create())
4.         .build();
5.  
6. service = retrofit.create(APIService.class);

这里是Square提供的官方Converter modules列表。选择一个最满足你需求的。

Gson: com.squareup.retrofit:converter-gson

Jackson: com.squareup.retrofit:converter-jackson

Moshi: com.squareup.retrofit:converter-moshi

Protobuf: com.squareup.retrofit:converter-protobuf

Wire: com.squareup.retrofit:converter-wire

Simple XML: com.squareup.retrofit:converter-simplexml

你也可以通过实现Converter.Factory接口来创建一个自定义的converter 。

我比较赞同这种新的模式。它让Retrofit对自己要做的事情看起来更清晰。

自定义Gson对象

为了以防你需要调整json里面的一些格式，比如，Date Format。你可以创建一个Gson 对象并把它传递给GsonConverterFactory.create()。

1. Gson gson = new GsonBuilder()
2.         .setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ")
3.         .create();
4.  
5. Retrofit retrofit = new Retrofit.Builder()
6.         .baseUrl("http://api.nuuneoi.com/base/")
7.         .addConverterFactory(GsonConverterFactory.create(gson))
8.         .build();
9.  
10. service = retrofit.create(APIService.class);

完成。

新的URL定义方式

Retrofit 2.0使用了新的URL定义方式。Base URL与@Url 不是简单的组合在一起而是和<a href="...">的处理方式一致。用下面的几个例子阐明。

ps：貌似第二个才符合习惯。

对于 Retrofit 2.0中新的URL定义方式，这里是我的建议：

- Base URL: 总是以 /结尾

- @Url: 不要以 / 开头

比如

1. public interface APIService {
2.  
3.     @POST("user/list")
4.     Call<Users> loadUsers();
5.  
6. }
7.  
8. public void doSomething() {
9.     Retrofit retrofit = new Retrofit.Builder()
10.             .baseUrl("http://api.nuuneoi.com/base/")
11.             .addConverterFactory(GsonConverterFactory.create())
12.             .build();
13.  
14.     APIService service = retrofit.create(APIService.class);
15. }

以上代码中的loadUsers会从 http://api.nuuneoi.com/base/user/list获取数据。

而且在Retrofit 2.0中我们还可以在@Url里面定义完整的URL：

1. public interface APIService {
2.  
3.     @POST("http://api.nuuneoi.com/special/user/list")
4.     Call<Users> loadSpecialUsers();
5.  
6. }

这种情况下Base URL会被忽略。

可以看到在URL的处理方式上发生了很大变化。它和前面的版本完全不同。如果你想把代码迁移到Retrofit 2.0，别忘了修正URL部分的代码。

现在需要OkHttp的支持

OkHttp 在Retrofit 1.9里是可选的。如果你想让Retrofit 使用OkHttp 作为HTTP 连接接口，你需要手动包含okhttp 依赖。

但是在Retrofit 2.0中，OkHttp 是必须的，并且自动设置为了依赖。下面的代码是从Retrofit 2.0的pom文件中抓取的。你不需要再做任何事情了。

1. <dependencies>
2.   <dependency>
3.     <groupId>com.squareup.okhttp</groupId>
4.     <artifactId>okhttp</artifactId>
5.   </dependency>
6.  
7.   ...
8. </dependencies>

为了让OkHttp 的Call模式成为可能，在Retrofit 2.0中OkHttp 自动被用作HTTP 接口。

即使response存在问题onResponse依然被调用

在Retrofit 1.9中，如果获取的 response 不能背解析成定义好的对象，则会调用failure。但是在Retrofit 2.0中，不管 response 是否能被解析。onResponse总是会被调用。但是在结果不能被解析的情况下，response.body()会返回null。别忘了处理这种情况。

如果response存在什么问题，比如404什么的，onResponse也会被调用。你可以从response.errorBody().string()中获取错误信息的主体。

Response/Failure 逻辑和Retrofit 1.9差别很大。如果你决定迁移到Retrofit 2.0，注意小心谨慎的处理这些情况。

缺少INTERNET权限会导致SecurityException异常

在Retrofit 1.9中，如果你忘记在AndroidManifest.xml文件中添加INTERNET权限。异步请求会直接进入failure回调方法，得到PERMISSION DENIED 错误消息。没有任何异常被抛出。

但是在Retrofit 2.0中，当你调用call.enqueue或者call.execute，将立即抛出SecurityException，如果你不使用try-catch会导致崩溃。

这类似于在手动调用HttpURLConnection时候的行为。不过这不是什么大问题，因为当INTERNET权限添加到了 AndroidManifest.xml中就没有什么需要考虑的了。

Use an Interceptor from OkHttp

在Retrofit 1.9中，你可以使用RequestInterceptor来拦截一个请求，但是它已经从Retrofit 2.0 移除了，因为HTTP连接层已经转为OkHttp。

结果就是，现在我们必须转而使用OkHttp里面的Interceptor。首先你需要使用Interceptor创建一个OkHttpClient对象，如下：

1. OkHttpClient client = new OkHttpClient();
2. client.interceptors().add(new Interceptor() {
3.     @Override
4.     public Response intercept(Chain chain) throws IOException {
5.         Response response = chain.proceed(chain.request());
6.  
7.         // Do anything with response here
8.  
9.         return response;
10.     }
11. });

然后传递创建的client到Retrofit的Builder链中。

1. Retrofit retrofit = new Retrofit.Builder()
2.         .baseUrl("http://api.nuuneoi.com/base/")
3.         .addConverterFactory(GsonConverterFactory.create())
4.         .client(client)
5.         .build();

以上为全部内容。

学习关于OkHttp Interceptor的知识，请到OkHttp Interceptors。

RxJava Integration with CallAdapter

除了使用Call模式来定义接口，我们也可以定义自己的type，比如MyCall。。我们把Retrofit 2.0的这个机制称为CallAdapter。

Retrofit团队有已经准备好了的CallAdapter module。其中最著名的module可能是为RxJava准备的CallAdapter，它将作为Observable返回。要使用它，你的项目依赖中必须包含两个modules。

1. compile 'com.squareup.retrofit:adapter-rxjava:2.0.0-beta1'
2. compile 'io.reactivex:rxandroid:1.0.1'

Sync Gradle并在Retrofit Builder链表中如下调用addCallAdapterFactory：

1. Retrofit retrofit = new Retrofit.Builder()
2.         .baseUrl("http://api.nuuneoi.com/base/")
3.         .addConverterFactory(GsonConverterFactory.create())
4.         .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
5.         .build();

你的Service接口现在可以作为Observable返回了！

1. Retrofit retrofit = new Retrofit.Builder()
2.         .baseUrl("http://api.nuuneoi.com/base/")
3.         .addConverterFactory(GsonConverterFactory.create())
4.         .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
5.         .build();

你可以完全像RxJava那样使用它，如果你想让subscribe部分的代码在主线程被调用，需要把observeOn(AndroidSchedulers.mainThread())添加到链表中。

1. Observable<DessertItemCollectionDao> observable = service.loadDessertListRx();
2.  
3. observable.observeOn(AndroidSchedulers.mainThread())
4.     .subscribe(new Subscriber<DessertItemCollectionDao>() {
5.         @Override
6.         public void onCompleted() {
7.             Toast.makeText(getApplicationContext(),
8.                     "Completed",
9.                     Toast.LENGTH_SHORT)
10.                 .show();
11.         }
12.  
13.         @Override
14.         public void onError(Throwable e) {
15.             Toast.makeText(getApplicationContext(),
16.                     e.getMessage(),
17.                     Toast.LENGTH_SHORT)
18.                 .show();
19.         }
20.  
21.         @Override
22.         public void onNext(DessertItemCollectionDao dessertItemCollectionDao) {
23.             Toast.makeText(getApplicationContext(),
24.                     dessertItemCollectionDao.getData().get(0).getName(),
25.                     Toast.LENGTH_SHORT)
26.                 .show();
27.         }
28.     });

完成！我相信RxJava的粉丝对这个变化相当满意。

总结

还有许多其他变化，你可以在官方的Change Log 中获取更多详情。不过，我相信我已经在本文涵盖了主要的issues。

你可能会好奇现在是否是切换到Retrofit 2.0 的时机？考虑到它仍然是beta阶段，你可能会希望继续停留在1.9除非你跟我一样是一个喜欢尝鲜的人。 Retrofit 2.0用起来很好据我的经验来看还没有发现bug。

注意Retrofit 1.9 的官方文档现在已经从Square的github主页删除。我建议你现在就开始学习Retrofit 2.0，尽快使用最新版本。