【Retrofit】网络请求参数@Path、@Query、@QueryMap、@Body、@Field、@FieldMap用法

最近开始在项目中使用Retrofit,在这里总结一下Retrofit网络请求参数@Path、@Query、@QueryMap、@Body、@Field、@FieldMap用法

初始化Retrofit

Retrofit retrofit =newRetrofit.Builder()

.baseUrl("https://fanyi-api.baidu.com/")

.addConverterFactory(GsonConverterFactory.create())

.build();

GET

样式1(一个简单的get请求)

http://192.168.1.1/api/News

@GET("News")

Call  getItem();

样式2(URL中有参数)

http://192.168.1.1/api/News/1

http://192.168.1.1/api/News/{资讯id}

@GET("News/{newsId}")

Call getItem(@Path("newsId")String newsId);


http://192.168.1.1/api/News/1/类型1

http://192.168.1.1/api/News/{资讯id}/{类型}

@GET("News/{newsId}/{type}")

Call getItem(@Path("newsId")String newsId, @Path("type")String type);

样式3(参数在URL问号之后)

http://192.168.1.1/api/News?newsId=1

http://192.168.1.1/api/News?newsId={资讯id}

@GET("News")

Call getItem(@Query("newsId") String newsId);

http://192.168.1.1/api/News?newsId=1&type=类型1

http://192.168.1.1/api/News?newsId={资讯id}&type={类型}

@GET("News")

Call getItem(@Query("newsId") String newsId, @Query("type") String type);

样式4(多个参数在URL问号之后,且个数不确定)

http://192.168.1.1/api/News?newsId=1&type=类型1...

http://192.168.1.1/api/News?newsId={资讯id}&type={类型}...

@GET("News")

Call getItem(@QueryMap Map map);

也可以

@GET("News")

Call getItem(@Query("newsId")String newsId,@QueryMap Map map);

POST

样式1(需要补全URL,post的数据只有一条reason)

http://192.168.1.1/api/Comments/1

http://192.168.1.1/api/Comments/{newsId}

@FormUrlEncoded

@POST("Comments/{newsId}")

Call reportComment(@Path("newsId") String commentId,@Field("reason") String reason);

样式2(需要补全URL,问号后加入access_token,post的数据只有一条reason)

http://192.168.1.1/api/Comments/1?access_token=1234123

http://192.168.1.1/api/Comments/{newsId}?access_token={access_token}

@FormUrlEncoded

@POST("Comments/{newsId}")

Call reportComment(@Path("newsId") String commentId,@Query("access_token") String access_token,@Field("reason") String reason);

样式3(需要补全URL,问号后加入access_token,post一个body(对象))

http://192.168.1.1/api/Comments/1?access_token=1234123

http://192.168.1.1/api/Comments/{newsId}?access_token={access_token}

@POST("Comments/{newsId}")

Call reportComment(@Path("newsId") String commentId, @Query("access_token") String access_token,@Body CommentBean bean);

DELETE

样式1(需要补全URL)

http://192.168.1.1/api/Comments/1

http://192.168.1.1/api/Comments/{newsId}

{access_token}

@DELETE("Comments/{commentId}")

Call deleteNewsCommentFromAccount(@Path("commentId") String commentId);

样式2(需要补全URL,问号后加入access_token)

http://192.168.1.1/api/Comments/1?access_token=1234123

http://192.168.1.1/api/Comments/{newsId}?access_token={access_token}

@DELETE("Comments/{commentId}")

Call deleteNewsCommentFromAccount(@Path("accountId")String accountId,        @Query("access_token")String access_token);

PUT(这个请求很少用到,例子就写一个)

http://192.168.1.1/api/Accounts/1

http://192.168.1.1/api/Accounts/{accountId}

@PUT("Accounts/{accountId}")

Call updateExtras(@Path("accountId")String accountId,        @Query("access_token")String access_token, @Body ExtrasBean bean);

总结

@Path:所有在网址中的参数(URL的问号前面),如:

http://192.168.1.1/api/Accounts/{accountId}

@Query:URL问号后面的参数,如:

http://192.168.1.1/api/Comments?access_token={access_token}

@QueryMap:相当于多个@Query

@Field:用于POST请求,提交单个数据

@FieldMap:以map形式提交多个Field(Retrofit2.0之后添加)

@Body:相当于多个@Field,以对象的形式提交

TIps

Tip1

使用@Field时记得添加@FormUrlEncoded

Tip2

若需要重新定义接口地址,可以使用@Url,将地址以参数的形式传入即可。

Tip3

@Path 和@Query的区别

相同点:都是请求头中的带有的数据

不同点:前者是请求头中问号之前用于替换URL中变量的字段,后者是请求头问号之后用于查询数据的字段,作用和应用场景都不同

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

推荐阅读更多精彩内容