Retrofit之初体验

什么是Retrofit？

Retrofit是Android和Java上的一个类型安全的REST客户端。

Retrofit将REST API抽象成Java接口，使用注解来描述每个API地址和请求，支持URL参数替换(包括查询参数和路径参数)，以及表单编码和多部分请求功能。支持GET，POST，PUT，PATCH，DELETE等HTTP请求方法。

Retrofit的GitHub地址：
https://github.com/square/retrofit

为什么使用Retrofit？

在处理HTTP请求时，总会因为不同场景或者边界情况而难以处理。你需要考虑网络状态，需要在请求失败后重试，需要处理HTTPS问题等等，这些事情会让你很头疼，而Retrofit则可以将你从这些头疼的事情中解放出来。

当然，也有其他的库，像android-async-http和Volley，那为什么是Retrofit？首先，Retrofit功能强大而且可灵活配置，至于如何强大灵活，我们会慢慢探究。其次，Retrofit是square推出的，是Jack Wharton主导的(额......)。

Retrofit与OkHttp的关系

OkHttp是一个纯净的HTTP/SPDY客户端，负责底层网络操作，缓存，请求和响应操作等等；而Retrofit是一个基于OkHttp的更高层的REST抽象。

在Retrofit2之前，OkHttp是可选的一个客户端。而在Retrofit2中，Retrofit与OkHttp强耦合，使得更好地利用OkHttp，包括使用OkHttp来解决一些棘手的问题。

什么？不知道OkHttp是啥，请参考：
《OkHttp之简介》

使用Retrofit

冠冕堂皇的话就不多扯，还是看看如果引入以及使用Retrofit吧。

引入Retrofit

1. 既然涉及到网络操作，那必须要在清单文件中添加网络权限。好的，在AndroidManifest.xml中添加：

   <uses-permission android:name="android.permission.INTERNET"/>
   

2. 添加Retrofit依赖：

   compile 'com.squareup.retrofit2:retrofit:2.1.0'
   

3. 添加响应转换器依赖。Retrofit2默认是不集成响应转换器的，因此，我们需要添加相关的依赖。本文中使用Google的Gson来处理响应数据：

compile 'com.squareup.retrofit2:converter-gson:2.1.0'

经过上面的三步，在项目中就可以使用Retrofit，那么如何使用呢？看下文见分晓。

使用Retrofit

我们已经知道，Retrofit将API抽象成Java接口，那么首先就先定义接口，那么定义请求什么的接口呢？本文使用新浪微博开放API中的获取广场微博、好友微博及我的微博接口。具体的微博Api接口见http://open.weibo.com/wiki/2/statuses/public_timeline：

public interface WeiboService {
    @GET("statuses/public_timeline.json")
    Call<Timeline> timelineForPublic(@Query("access_token") String token);

    @GET("statuses/friends_timeline.json")
    Call<Timeline> timelineForFriend(@Query("access_token") String token);

    @GET("statuses/user_timeline.json")
    Call<Timeline> timelineForMine(@Query("access_token") String token);
}

上面我们定义了WeiboService接口，并且有三个方法timelineForPublic()、timelineForFriend()、timelineForMine()
，方法和其参数上都有注解加以说明：

• 首先@GET表示当方法调用时会执行一个GET请求。@GET后面紧跟着一个字符串，代表着API的端点url。此外，端点url可以使用占位符定义，但因不适合本例，暂且不谈。
• 方法参数中用@Query对token进行注解，则token将为以access_token为键作为请求的参数。

有了接口，还得有接口的实例才可以对其进行调用。我们创建一个ServiceGenerator来实现根据接口返回其实例的功能。

public class ServiceGenerator {

    private static final String BASE_URL = "https://api.weibo.com/2/";

    private static Retrofit.Builder retrofitBuilder =
            new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .addConverterFactory(GsonConverterFactory.create());

    private static OkHttpClient.Builder okHttpClientBuilder =
            new OkHttpClient.Builder();

    public static <T> T createService(Class<T> serviceClass) {
        retrofitBuilder.client(okHttpClientBuilder.build());
        Retrofit retrofit = retrofitBuilder.build();
        return retrofit.create(serviceClass);
    }

}

查看微博API列表可以得出其baseUrl为"https://api.weibo.com/2/"，使用Retrofit.Builder创建一个REST客户端，设置Gson来处理响应，以及OkHttp作为其client。

使用一个OkHttpClient实例可以重用已打开的套接字连接，这也是建议如此做的。这里ServiceGenerator通过用一个静态的OkHttpClientBuilder字段来实现。

至此，我们创建了一个WeiboService定义了几个方法，这些方法返回Call<TimeLine>类型。而ServiceGenerator可以创建接口的实例，之后我们通过创建的接口实例调用相应方法，就可以拿到Call<TimeLine>实例，将这个实例插入队列，就可以在回调中获取到响应了。

WeiboService weiboService = ServiceGenerator.createService(WeiboService.class);

Call<Timeline> call;
switch (mType) {
    case Constants.TYPE_TIMELINE_PUBLIC:
        call = weiboService.timelineForPublic(AccessTokenKeeper.readAccessToken(getContext()).getToken());
        break;
    case Constants.TYPE_TIMELINE_FRIEND:
        call = weiboService.timelineForFriend(AccessTokenKeeper.readAccessToken(getContext()).getToken());
        break;
    case Constants.TYPE_TIMELINE_MINE:
        call = weiboService.timelineForMine(AccessTokenKeeper.readAccessToken(getContext()).getToken());
        break;
    default:
        call = weiboService.timelineForPublic(AccessTokenKeeper.readAccessToken(getContext()).getToken());
        break;
}

call.enqueue(new Callback<Timeline>() {
    @Override
    public void onResponse(Call<Timeline> call, Response<Timeline> response) {
        if (response.isSuccessful()) {
            mAdapter.setData(response.body().getStatuses());
        } else {
            DebugLog.i(TAG, "request if failed");
        }
    }

    @Override
    public void onFailure(Call<Timeline> call, Throwable t) {
        DebugLog.i(TAG, "error:" + t.getMessage());
    }
});

在onResponse()回调中，将返回的微博列表设置到Adapter中，本文是通过RecyclerView简单地展示了每条微博的拥有者及文本内容。效果图如下：

微博列表页面

虽然很丑，但意义是使用Retrofit成功获取到了数据，哈哈。本文就介绍这么多，后续继续介绍Retrofit各方面的使用，敬请关注！

源码地址：
https://github.com/FILWAndroid/DevJourney

关于源码：

1. 不只是本文涉及的代码，会包含很多知识点的代码，应该都会在我的简书中进行介绍。
2. 有可能代码与本文中所贴出来的有差异，但应该都是我觉得更好的方式吧。
3. 新浪微博相关的代码运行显示不出来结果，感兴趣的可以参考新浪微博SDK，配置工程。
4. 欢迎大家对我进行批评教育。

参考链接：
https://github.com/square/retrofit
http://square.github.io/retrofit/
https://futurestud.io/blog/retrofit-getting-started-and-android-client
https://github.com/bkiers/retrofit-oauth