在《Retrofit之請求參數(shù)》，我們討論了請求的url參數(shù)、表單編碼以及使用請求主體發(fā)送數(shù)據(jù)，但是處理API的請求我們還需要處理請求頭，來實現(xiàn)緩存、認證等操作。而在實際應用中，我們也通常會向請求頭添加平臺(Android or iOS)、app版本、操作系統(tǒng)版本、網(wǎng)絡(luò)類型等信息。
定義請求頭
Retrofit提供了兩種方式來定義HTTP請求頭：靜態(tài)和動態(tài)。
靜態(tài)請求頭
以獲取天氣的一個API接口為例，具體API詳見天氣查詢。這個接口請求要求一個apikey的請求頭以及一個citypinyi的url參數(shù)。
定義的接口如下：
public interface WeatherService {
@Headers("apikey:b86c2269fe6588bbe3b41924bb2f2da2")
@GET
Call<WeatherWrapper> weather(@Url String url, @Query("cityname") String cityName);
}
使用@Headers來定義請求頭的鍵值對，也可以同時定義多個請求頭，如下：
@Headers({
"key1:value1"，
"key2:value2"
})
動態(tài)請求頭
動態(tài)請求頭以方法參數(shù)的形式存在，示例如下：
@GET
Call<WeatherWrapper> weather(@Header("apikey") String apikey, @Url String url, @Query("cityname") String cityName);
這樣，在發(fā)送請求(調(diào)用方法)時，就可以動態(tài)的定義apikey了。當然，這只是狹義上的動態(tài)，只能改變請求頭的值，而不能動態(tài)決定發(fā)送什么請求頭。如果要動態(tài)的定義請求頭，可是使用@HeaderMap。示例如下：
@GET
Call<WeatherWrapper> weather(@HeaderMap Map<String, String> headers, @Url String url, @Query("cityname") String cityName);
在OkHttp的攔截器中管理請求頭
在上面，我們了解了如何使用Retrofit定義請求頭，回到文章開始我們所提及到的，我們通常會為每個API請求添加一些請求頭包含一些額外信息，如果在每個端點聲明都使用@Header來處理就麻煩了。如果你知道在《Retrofit之請求參數(shù)》中如何為每個請求添加相同的url參數(shù)，我會很感動的。對，還是使用OkHttp的攔截器。對OkHttp攔截器不熟悉的，可以參考《OkHttp之攔截器》。
從《OkHttp之示例》中的"訪問Header"中可以了解到，OkHttp提供了兩種方式來添加請求頭字段及值：你可以使用相同的key來重寫已存在的請求頭，或者單純添加而不管是否已有這樣的鍵值對存在。
重寫請求頭
Request.Builder中有個.header(key, value)的方法來允許我們定義請求頭。如果這里之前已經(jīng)定義了一個相同鍵的請求頭，那么之前的則會被重寫。代碼示例如下：
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()方法，就是這么簡單，根據(jù)你的情況去合理使用即可。
請求頭在項目中的應用
以我當前的項目來講，會通過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")//系統(tǒng)版本號
.header("device", "device")//設(shè)備信息
.header("screen", "screen")//屏幕大小
.header("uuid", "uuid")//設(shè)備唯一碼
.header("version", "version")//app版本
.header("apiVersion", "apiVersion")//api版本
.header("token", "token")//令牌
.header("channelId", "channelId")//渠道
.header("networkType", "networkType");//網(wǎng)絡(luò)類型
Request request = requestBuilder.build();
return chain.proceed(request);
}
});
至于你的項目，就看需求了。Ok，關(guān)于使用Retrofit定義請求頭就討論到這里。我們已經(jīng)討論了關(guān)于請求的url定義、參數(shù)以及請求頭，接下來得討論下請求的發(fā)送、取消以及復用了。
源碼地址：
https://github.com/FILWAndroid/DevJourney
關(guān)于源碼：
- 不只是本文涉及的代碼，會包含很多知識點的代碼，應該都會在我的簡書中進行介紹。
- 有可能代碼與本文中所貼出來的有差異，但應該都是我覺得更好的方式吧。
- 新浪微博相關(guān)的代碼運行顯示不出來結(jié)果，感興趣的可以參考新浪微博SDK，配置工程。
- 歡迎大家對我進行批評教育。
