Retrofit之請求Url

在之前的《Retrofit之初體驗》中,我們初步了解了如何使用Retrofit,沒有閱讀過的同學,建議先閱讀下。接下來,我們開始討論Retrofit的各個細節,本文介紹的是如何定義Retrofit的請求url。

base url與端點url的連接

從上文我們知道,Retrofit在Java接口方法上使用注解來描述API端點及請求的處理:

  1. 定義HTTP請求方法,GET、POST、PUT、DELETE等等,Retrofit中都有相對應的注解。
  2. 在注解上添加相對資源端點url。

于是就會有像這樣的一個接口:

public interface WeiboService {
    @GET("statuses/public_timeline.json")
    Call<Object> timelineForPublic();
}

Retrofit類定義了base url,而這里通過GET注解定義的資源url會與base url連接起來作為最終的請求url。

我們定義的base url為:

Retrofit.Builder().baseUrl("https://api.weibo.com/2/");

得到的最終的請求url為:

https://api.weibo.com/2/statuses/public_timeline.json

當然,這個最終請求url是正確的,那么如果base url中的末尾不帶"/",而在端點url的前段帶"/",是否也一樣可以呢?答案是不可以,app直接崩潰了,拋出了ExceptionInInitializerError異常,因為Retrofit要求base url必須以"/"結尾。

好的,base url是不能改了,那如果只在端點url的前面加"/"會如何呢?

此時得到的最終請求url為:

https://api.weibo.com/statuses/public_timeline.json

這又是為什么呢?

首先,明確一個概念,當端點url以"/"開頭時代表絕對路徑后綴路徑,而base url的中的"2"則為路徑參數。當端點url是絕對路徑時,在base url中包含的路徑參數會被忽略,于是就變成了最終的"https://api.weibo.com/statuses/public_timeline.json"。

base url的應用

在處理API時,通常它們都有共同的基本地址,也就是Retrofit中的base url。有時候,因為服務器的升級,可能會發生改變,例如微博的從api從版本2升級到版本3,那么base url就會變成"https://api.weibo.com/3/",而我們只需要在定義base url的地方更改即可,這樣每個端點的最終請求url也都會隨之改變。亦或者,可能有測試服務器、預發服務器以及正式服務器,API的端點url不會改變,改變的都只會是base url。

端點url的應用

在上面談base url與端點url連接時了解到,當base url以"/"開頭時,會忽略base url中的路徑參數。好了,現在假如有這樣一種情況,微博的大部分api還是版本2,但是獲取廣場微博的api從版本2升級到版本3,也就是請求url應該為:

https://api.weibo.com/3/statuses/public_timeline.json

因此,我們可以在定義API端點時,將端點url設置為"/3/statuses/public_timeline.json",這樣就可以使得獲取廣場微博調用版本3的API,而其他的還是使用版本2的API。

動態url的應用

使用base url和端點url可以應對大多數API,但是應用中總會出現另類的API。在我的示例中,現在要獲取天氣,當然我只能找到一個免費的api了,鏈接是:http://apistore.baidu.com/apiworks/servicedetail/112.html,可以看到請求的url是"http://apis.baidu.com/apistore/weatherservice/weather",此時base url就完全不可用了,這時候就到了動態url出場的時間了。

定義動態url只需要添加一個字符串參數用來表示url,并使用@Url注解:

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

代碼中的@Headers是用來添加請求頭的,這塊暫不用管,后續會有文章進行介紹。好了,關注我們的動態url,可以發現現在@GET注解后面沒有了端點url,并使用了@Url來定義請求url。

上面我們了解了base url和端點url的連接,那Retrofit又是如何處理base url和動態url的呢?

分三種情況(base url為"https://api.weibo.com/2/"):

根據使用場景,靈活使用url的定義方式,就可以處理各種url了。如果你對retrofit感興趣,同時你也覺得我的文章可以給你帶來那么一丟丟的幫助,敬請關注,后續會繼續介紹Retrofit的相關使用。

源碼地址:
https://github.com/FILWAndroid/DevJourney

關于源碼:

  1. 不只是本文涉及的代碼,會包含很多知識點的代碼,應該都會在我的簡書中進行介紹。
  2. 有可能代碼與本文中所貼出來的有差異,但應該都是我覺得更好的方式吧。
  3. 新浪微博相關的代碼運行顯示不出來結果,感興趣的可以參考新浪微博SDK,配置工程。
  4. 歡迎大家對我進行批評教育。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,622評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,716評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,746評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,991評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,706評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,036評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,029評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,203評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,725評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,451評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,677評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,161評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,857評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,266評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,606評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,407評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,643評論 2 380

推薦閱讀更多精彩內容