Retrofit之请求头

2016-08-16 本文已影响4454人 DoAndKeep

在《Retrofit之请求参数》，我们讨论了请求的url参数、表单编码以及使用请求主体发送数据，但是处理API的请求我们还需要处理请求头，来实现缓存、认证等操作。而在实际应用中，我们也通常会向请求头添加平台(Android or iOS)、app版本、操作系统版本、网络类型等信息。

定义请求头

Retrofit提供了两种方式来定义HTTP请求头：静态和动态。

静态请求头

以获取天气的一个API接口为例，具体API详见天气查询。这个接口请求要求一个apikey的请求头以及一个citypinyi的url参数。

定义的接口如下：

public interface WeatherService {
    @Headers("apikey:b86c2269fe6588bbe3b41924bb2f2da2")
    @GET
    Call<WeatherWrapper> weather(@Url String url, @Query("cityname") String cityName);
}

使用@Headers来定义请求头的键值对，也可以同时定义多个请求头，如下：

@Headers({
    "key1:value1"，
    "key2:value2"   
})

动态请求头

动态请求头以方法参数的形式存在，示例如下：

@GET
Call<WeatherWrapper> weather(@Header("apikey") String apikey, @Url String url, @Query("cityname") String cityName);

这样，在发送请求(调用方法)时，就可以动态的定义apikey了。当然，这只是狭义上的动态，只能改变请求头的值，而不能动态决定发送什么请求头。如果要动态的定义请求头，可是使用@HeaderMap。示例如下：

@GET
Call<WeatherWrapper> weather(@HeaderMap Map<String, String> headers, @Url String url, @Query("cityname") String cityName);

在OkHttp的拦截器中管理请求头

在上面，我们了解了如何使用Retrofit定义请求头，回到文章开始我们所提及到的，我们通常会为每个API请求添加一些请求头包含一些额外信息，如果在每个端点声明都使用@Header来处理就麻烦了。如果你知道在《Retrofit之请求参数》中如何为每个请求添加相同的url参数，我会很感动的。对，还是使用OkHttp的拦截器。对OkHttp拦截器不熟悉的，可以参考《OkHttp之拦截器》。

从《OkHttp之示例》中的"访问Header"中可以了解到，OkHttp提供了两种方式来添加请求头字段及值：你可以使用相同的key来重写已存在的请求头，或者单纯添加而不管是否已有这样的键值对存在。

重写请求头

Request.Builder中有个.header(key, value)的方法来允许我们定义请求头。如果这里之前已经定义了一个相同键的请求头，那么之前的则会被重写。代码示例如下：

okHttpClientBuilder.addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request original = chain.request();
        Request.Builder requestBuilder = original.newBuilder()
                .header("token", "xxx")
                .header("token", "yyy");
        Request request = requestBuilder.build();
        return chain.proceed(request);
    }
});

最终请求头token的值会从"xxx"重写为"yyy"。如果应用中用户登录会持有一个token，之后需要加入到请求中，当token改变时(可能是更改密码造成)，此时token就应该更新，这时候就应该使用到重写请求头的方式。

不重写请求头

如果说我们在定义请求头而不想让之前已定义的不被重写，从而两个都存在，那么可以使用addHeader()方法替代header()方法，就是这么简单，根据你的情况去合理使用即可。

请求头在项目中的应用

以我当前的项目来讲，会通过OkHttp拦截器的方式来添加请求头，具体代码示例如下：

okHttpClientBuilder.addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request original = chain.request();
        Request.Builder requestBuilder = original.newBuilder()
                .header("platform", "platform")//平台
                .header("sysVersion", "sysVersion")//系统版本号
                .header("device", "device")//设备信息
                .header("screen", "screen")//屏幕大小
                .header("uuid", "uuid")//设备唯一码
                .header("version", "version")//app版本
                .header("apiVersion", "apiVersion")//api版本
                .header("token", "token")//令牌
                .header("channelId", "channelId")//渠道
                .header("networkType", "networkType");//网络类型
        Request request = requestBuilder.build();
        return chain.proceed(request);
    }
});

至于你的项目，就看需求了。Ok，关于使用Retrofit定义请求头就讨论到这里。我们已经讨论了关于请求的url定义、参数以及请求头，接下来得讨论下请求的发送、取消以及复用了。

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

关于源码：

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