Retrofit注解

1、什么是Retrofit?

Retrofit 是一个Square开发的安卓客户端请求库。其中内部封装了okhttp库。官方的介绍是使用非常简短 Retrofit使用注解,能够极大的简化网络请求数据的代码。

Retrofit常用注解包括：@Query，@QueryMap，@Field，@FieldMap，@FormUrlEncoded，@Path，@Ur

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

GET

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

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/{资讯id}

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

或
http://102.10.10.132/api/News/1/类型1
http://102.10.10.132/api/News/{资讯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={资讯id}

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

或
http://102.10.10.132/api/News?newsId=1&type=类型1
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=类型1...
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/{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/{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（对象））

http://102.10.10.132/api/Comments/1?access_token=1234123
http://102.10.10.132/api/Comments/{newsId}?access_token={access_token}

    @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/{commentId}

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

样式2（需要补全URL，问号后加入access_token）

http://102.10.10.132/api/Comments/1?access_token=1234123
http://102.10.10.132/api/Comments/{commentId}?access_token={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(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/{accountId}

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

2、@Query，@QueryMap

@Query主要用于Get请求数据，用于拼接在拼接在Url路径后面的查询参数，一个@Query相当于拼接一个参数，多个参数中间用，隔开。

@QueryMap：主要的效果等同于多个@Query参数拼接，主要也用于Get请求网络数据。

3、@Field，@FieldMap

@Field的用法类似于@Query，就不在重复列举了，主要不同的是@Field主要用于Post请求数据。

@FieldMap的用法类似于@QueryMap。

两者主要区别是：如果请求为post实现，那么最好传递参数时使用@Field、@FieldMap和@FormUrlEncoded。因为@Query和或QueryMap都是将参数拼接在url后面的，而@Field或@FieldMap传递的参数时放在请求体的。

4、@FormUrlEncoded

我们在代码中使用是不是发现了@POST比起@GET多了一个@FromUrlEncoded的注解。

如果去掉@FromUrlEncoded在post请求中使用@Field和@FieldMap，那么程序会抛出Java.lang.IllegalArgumentException: @Field parameters can only be used with form encoding. 的错误异常。

所以如果平时公司如果是Post请求的话，千万别忘记了加这@FromUrlEncoded注解。

@FormUrlEncoded
@POST("users/user/question")Call<TnGou> getTngouPost(@Field("page") int page);

5、@Path

@Path主要用于Get请求，用于替换Url路径中的变量字符。

publicinterface csdnService {
@GET("users/{user}/question") Call<List<Repo>> getData(@Path("user") String user); 
}

该接口定义了一个getData方法，该方法通过GET请求去访问服务器的users/{user}/question路径，其中通过@Path注解会把路径中的{user}替换成参数user的具体值。比如:user的值如果是zhangsan,那么Url的路径就是users/zhangsan/question.

6、@Url

@Url是动态的Url请求数据的注解。需要注意的是使用@Path时，path对应的路径不能包含”/”，不然每个加到host Url后面的东西都会被省略掉。千万注意了

Retrofit retrofit = new Retrofit.Builder() .baseUrl("http://ms.csdn.net/") .build();
public interface csdnService {@GET Call<List<Repo>> getData(@Url String user); }