【Android】Retrofit网络请求参数注解，@Path、@Query、@QueryMap.

爱被打了一巴掌 2023-06-01 03:22 4阅读 0赞

对Retrofit已经使用了一点时间了，是时候归纳一下各种网络请求的service了。

下面分为GET、POST、DELETE还有PUT的请求，说明@Path、@Query、@QueryMap、@Body、@Field的用法。

##### 初始化Retrofit #####

String BASE_URL = "http://102.10.10.132/api/"; Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .build();

## GET ##

#### 样式1（一个简单的get请求） ####

[http://102.10.10.132/api/News][http_102.10.10.132_api_News]

@GET("News") Call<NewsBean> getItem();

#### 样式2（URL中有参数） ####

[http://102.10.10.132/api/News/1][http_102.10.10.132_api_News_1]  
[http://102.10.10.132/api/News/][http_102.10.10.132_api_News 1]\{资讯id\}

@GET("News/{newsId}") Call<NewsBean> getItem(@Path("newsId") String newsId);

或  
[http://102.10.10.132/api/News/1/][http_102.10.10.132_api_News_1 1]类型1  
[http://102.10.10.132/api/News/][http_102.10.10.132_api_News 1]\{资讯id\}/\{类型\}

@GET("News/{newsId}/{type}") Call<NewsBean> getItem(@Path("newsId") String newsId， @Path("type") String type);

#### 样式3（参数在URL问号之后） ####

[http://102.10.10.132/api/News?newsId=1][http_102.10.10.132_api_News_newsId_1]  
[http://102.10.10.132/api/News?newsId=][http_102.10.10.132_api_News_newsId]\{资讯id\}

@GET("News") Call<NewsBean> getItem(@Query("newsId") String newsId);

或  
[http://102.10.10.132/api/News?newsId=1&type=][http_102.10.10.132_api_News_newsId_1_type]类型1  
[http://102.10.10.132/api/News?newsId=][http_102.10.10.132_api_News_newsId]\{资讯id\}&type=\{类型\}

@GET("News") Call<NewsBean> getItem(@Query("newsId") String newsId， @Query("type") String type);

#### 样式4（多个参数在URL问号之后，且个数不确定） ####

[http://102.10.10.132/api/News?newsId=1&type=][http_102.10.10.132_api_News_newsId_1_type]类型1...  
[http://102.10.10.132/api/News?newsId=][http_102.10.10.132_api_News_newsId]\{资讯id\}&type=\{类型\}...

@GET("News") Call<NewsBean> getItem(@QueryMap Map<String, String> map);

也可以

@GET("News") Call<NewsBean> getItem( @Query("newsId") String newsId， @QueryMap Map<String, String> map);

### POST ###

#### 样式1（需要补全URL，post的数据只有一条reason） ####

[http://102.10.10.132/api/Comments/1][http_102.10.10.132_api_Comments_1]  
[http://102.10.10.132/api/Comments/][http_102.10.10.132_api_Comments]\{newsId\}

@FormUrlEncoded @POST("Comments/{newsId}") Call<Comment> reportComment( @Path("newsId") String commentId, @Field("reason") String reason);

#### 样式2（需要补全URL，问号后加入access\_token，post的数据只有一条reason） ####

[http://102.10.10.132/api/Comments/1?access\_token=1234123][http_102.10.10.132_api_Comments_1_access_token_1234123]  
[http://102.10.10.132/api/Comments/][http_102.10.10.132_api_Comments]\{newsId\}?access\_token=\{access\_token\}

@FormUrlEncoded @POST("Comments/{newsId}") Call<Comment> reportComment( @Path("newsId") String commentId, @Query("access_token") String access_token, @Field("reason") String reason);

#### 样式3（需要补全URL，问号后加入access\_token，post一个body（对象）） ####

@POST("Comments/{newsId}") Call<Comment> reportComment( @Path("newsId") String commentId, @Query("access_token") String access_token, @Body CommentBean bean);

## DELETE ##

#### 样式1（需要补全URL） ####

[http://102.10.10.132/api/Comments/1][http_102.10.10.132_api_Comments_1]  
[http://102.10.10.132/api/Comments/][http_102.10.10.132_api_Comments]\{commentId\}

@DELETE("Comments/{commentId}") Call<ResponseBody> deleteNewsCommentFromAccount( @Path("commentId") String commentId);

#### 样式2（需要补全URL，问号后加入access\_token） ####

@DELETE("Comments/{commentId}") Call<ResponseBody> deleteNewsCommentFromAccount( @Path("commentId") String commentId， @Query("access_token") String access_token);

#### 样式3（带有body） ####

[http://102.10.10.132/api/Comments][http_102.10.10.132_api_Comments 1]

@HTTP(method = "DELETE",path = "Comments",hasBody = true) Call<ResponseBody> deleteCommont( @Body CommentBody body );

`CommentBody`：需要提交的内容，与`Post`中的`Body`相同

## PUT（这个请求很少用到，例子就写一个） ##

[http://102.10.10.132/api/Accounts/1][http_102.10.10.132_api_Accounts_1]  
[http://102.10.10.132/api/Accounts/][http_102.10.10.132_api_Accounts]\{accountId\}

@PUT("Accounts/{accountId}") Call<ExtrasBean> updateExtras( @Path("accountId") String accountId, @Query("access_token") String access_token, @Body ExtrasBean bean);

## 总结 ##

@Path：所有在网址中的参数（URL的问号前面），如：  
[http://102.10.10.132/api/Accounts/][http_102.10.10.132_api_Accounts]\{accountId\}  
@Query：URL问号后面的参数，如：  
[http://102.10.10.132/api/Comments?access\_token=][http_102.10.10.132_api_Comments_access_token]\{access\_token\}  
@QueryMap：相当于多个@Query  
@Field：用于POST请求，提交单个数据  
@Body：相当于多个@Field，以对象的形式提交  
**Tips**

*  Tips1  
    使用@Field时记得添加@FormUrlEncoded
 *  Tips2  
    若需要重新定义接口地址，可以使用@Url，将地址以参数的形式传入即可。如

@GET Call<List<Activity>> getActivityList( @Url String url, @QueryMap Map<String, String> map);

Call<List<Activity>> call = service.getActivityList( "http://115.159.198.162:3001/api/ActivitySubjects", map);

作者：带心情去旅行  
链接：https://www.jianshu.com/p/7687365aa946  
来源：简书  
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

转载于:https://www.cnblogs.com/Jeely/p/11304500.html

[http_102.10.10.132_api_News]: https://link.jianshu.com?t=http://102.10.10.132/api/News
[http_102.10.10.132_api_News_1]: https://link.jianshu.com?t=http://102.10.10.132/api/News/1
[http_102.10.10.132_api_News 1]: https://link.jianshu.com?t=http://102.10.10.132/api/News/
[http_102.10.10.132_api_News_1 1]: https://link.jianshu.com?t=http://102.10.10.132/api/News/1/
[http_102.10.10.132_api_News_newsId_1]: https://link.jianshu.com?t=http://102.10.10.132/api/News?newsId=1
[http_102.10.10.132_api_News_newsId]: https://link.jianshu.com?t=http://102.10.10.132/api/News?newsId=
[http_102.10.10.132_api_News_newsId_1_type]: https://link.jianshu.com?t=http://102.10.10.132/api/News?newsId=1&type=
[http_102.10.10.132_api_Comments_1]: https://link.jianshu.com?t=http://102.10.10.132/api/Comments/1
[http_102.10.10.132_api_Comments]: https://link.jianshu.com?t=http://102.10.10.132/api/Comments/
[http_102.10.10.132_api_Comments_1_access_token_1234123]: https://link.jianshu.com?t=http://102.10.10.132/api/Comments/1?access_token=1234123
[http_102.10.10.132_api_Comments 1]: https://link.jianshu.com?t=http://102.10.10.132/api/Comments
[http_102.10.10.132_api_Accounts_1]: https://link.jianshu.com?t=http://102.10.10.132/api/Accounts/1
[http_102.10.10.132_api_Accounts]: https://link.jianshu.com?t=http://102.10.10.132/api/Accounts/
[http_102.10.10.132_api_Comments_access_token]: https://link.jianshu.com?t=http://102.10.10.132/api/Comments?access_token=