Retrofit中的注解

@Query,@QueryMap,@Field,@FieldMap,@FormUrlEncoded,@Path,@Url

這七種注解應(yīng)該是最常用的了。

下邊列舉各種應(yīng)用場(chǎng)景。

一、get方式請(qǐng)求靜態(tài)url地址

Retrofit retrofit =newRetrofit.Builder()

.baseUrl("https://api.github.com/")

.build();publicinterfaceGitHubService {//無參數(shù)@GET("users/stven0king/repos")

Call>listRepos();//少數(shù)參數(shù)@GET("users/stven0king/repos")

Call> listRepos(@Query("time")longtime);//參數(shù)較多@GET("users/stven0king/repos")

Call> listRepos(@QueryMap Mapparams);

}

@Query和@QueryMap也可以結(jié)合在一起使用。

要是對(duì)應(yīng)的url在服務(wù)端支持get/post兩種類型的請(qǐng)求的話,那么上面的@GET變?yōu)锧POST也可以執(zhí)行,只不過post請(qǐng)求時(shí)所帶的參數(shù)也會(huì)像get方式一樣已?key=value&key1=vaule2…的形式拼接在url的后邊。

二、post方式請(qǐng)求靜態(tài)url地址

Retrofit retrofit =newRetrofit.Builder()

.baseUrl("https://api.github.com/")

.build()publicinterfaceGitHubService {//無參數(shù)@POST("users/stven0king/repos")

Call>listRepos();//少數(shù)參數(shù)@FormUrlEncoded

@POST("users/stven0king/repos")

Call> listRepos(@Field("time")longtime);//參數(shù)較多@FormUrlEncoded

@POST("users/stven0king/repos")

Call> listRepos(@FieldMap Mapparams);

}

@Field和@FieldMap可以結(jié)合在一起使用。

另外是不是發(fā)現(xiàn)了比起@GET多了一個(gè)@FromUrlEncoded的注解。如果去掉@FromUrlEncoded在post請(qǐng)求中使用@Field和@FieldMap,那么程序會(huì)拋出java.lang.IllegalArgumentException: @Field parameters can only be used with form encoding. (parameter #1)的錯(cuò)誤異常。如果將@FromUrlEncoded添加在@GET上面呢,同樣的也會(huì)拋出java.lang.IllegalArgumentException:FormUrlEncoded can only be specified on HTTP methods with request body (e.g., @POST).的錯(cuò)誤異常

三、半靜態(tài)的url地址請(qǐng)求

Retrofit retrofit =newRetrofit.Builder()

.baseUrl("https://api.github.com/")

.build()publicinterfaceGitHubService {

@GET("users/{user}/repos")

Call> listRepos(@Path("user") String user);

}

四、動(dòng)態(tài)的url地址請(qǐng)求

Retrofit retrofit =newRetrofit.Builder()

.baseUrl("https://api.github.com/")

.build()publicinterfaceGitHubService {

@GET

Call>listRepos(@Url String user);

}

五、總結(jié)小細(xì)節(jié)

當(dāng)@GET或@POST注解的url為全路徑時(shí)(可能和baseUrl不是一個(gè)域),會(huì)直接使用注解的url的域。

如果請(qǐng)求為post實(shí)現(xiàn),那么最好傳遞參數(shù)時(shí)使用@Field、@FieldMap和@FormUrlEncoded。因?yàn)锧Query和或QueryMap都是將參數(shù)拼接在url后面的,而@Field或@FieldMap傳遞的參數(shù)時(shí)放在請(qǐng)求體的。

使用@Path時(shí),path對(duì)應(yīng)的路徑不能包含”/”,否則會(huì)將其轉(zhuǎn)化為%2F。在遇到想動(dòng)態(tài)的拼接多節(jié)url時(shí),還是使用@Url吧。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,533評(píng)論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,055評(píng)論 3 414
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,365評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,561評(píng)論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,346評(píng)論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,889評(píng)論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,978評(píng)論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,118評(píng)論 0 286
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,637評(píng)論 1 333
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,558評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,739評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,246評(píng)論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 43,980評(píng)論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,619評(píng)論 1 280
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,347評(píng)論 3 390
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,702評(píng)論 2 370

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,776評(píng)論 18 139
  • 安卓開發(fā)領(lǐng)域中,很多重要的問題都有很好的開源解決方案,例如Square公司提供網(wǎng)絡(luò)請(qǐng)求 OkHttp , Retr...
    aaron688閱讀 1,925評(píng)論 1 20
  • 開源框架地址:https://github.com/square/retrofit 英文文檔官網(wǎng):http://s...
    于加澤閱讀 507評(píng)論 0 0
  • Retrofit--相信大家都或多或少的聽過和用過了,不知道是什么的證明你已經(jīng)out了~我使用和研究Retrofi...
    zyyoona7閱讀 3,602評(píng)論 9 36
  • 年輕人人都有,或許會(huì)經(jīng)歷一些青澀不完美的愛情,當(dāng)回過頭去品味時(shí),它那樣單純像沒著色的畫,如同記憶里的黑白照片,承載...
    相信彩虹閱讀 673評(píng)論 3 5