Android:Retrofit请求头的应用

定义请求头

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

关于源码:

  1. 不只是本文涉及的代码,会包含很多知识点的代码,应该都会在我的简书中进行介绍。
  2. 有可能代码与本文中所贴出来的有差异,但应该都是我觉得更好的方式吧。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容