Retrofit注解的含义及作用

Retrofit各个注解的含义及作用

1. 各个注解的含义及使用

1.1 Body:

• 作用于方法的参数
• 使用该注解定义的参数不可为null
• 当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去.

1.2 DELETE:

• 用于发送一个DELETE请求
• DELETE注解一般必须添加相对路径或绝对路径或者全路径,如果不想在DELETE注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

1.3 Field:

• 作用于方法的参数
• 用于发送一个表单请求
• 用String.valueOf()把参数值转换为String,然后进行URL编码,当参数值为null值时,会自动忽略,如果传入的是一个List或array,则为每一个非空的item拼接一个键值对,每一个键值对中的键是相同的,值就是非空item的值,如: name=张三&name=李四&name=王五,另外,如果item的值有空格,在拼接时会自动忽略,例如某个item的值为:张 三,则拼接后为name=张三.

1.4 FieldMap:

• 作用于方法的参数
• 用于发送一个表单请求
• map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常

   @FormUrlEncoded   @POST("/things")   Call<ResponseBody> things(@FieldMap Map<String, String> fields);

1.5 FormUrlEncoded:

• 用于修饰Field注解和FieldMap注解
• 使用该注解,表示请求正文将使用表单网址编码。字段应该声明为参数，并用@Field注释或FieldMap注释。使用FormUrlEncoded注解的请求将具”application / x-www-form-urlencoded” MIME类型。字段名称和值将先进行UTF-8进行编码,再根据RFC-3986进行URI编码.

1.6 GET

• 用于发送一个get请求
• GET注解一般必须添加相对路径或绝对路径或者全路径,如果不想在GET注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

1.7 HEAD

• 用于发送一个HEAD请求
• HEAD注解一般必须添加相对路径或绝对路径或者全路径,如果不想在HEAD注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

1.8 Header:

• 作用于方法的参数,用于添加请求头
• 使用该注解定义的请求头可以为空,当为空时,会自动忽略,当传入一个List或array时,为拼接每个非空的item的值到请求头中.
  具有相同名称的请求头不会相互覆盖,而是会照样添加到请求头中

示例:

   @GET("/")Call<ResponseBody> foo(@Header("Accept-Language") String lang);

1.9 HeaderMap:

• 作用于方法的参数,用于添加请求头
• 以map的方式添加多个请求头,map中的key为请求头的名称,value为请求头的值,且value使用String.valueOf()统一转换为String类型,
  map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常

示例:

   @GET("/search")   void list(@HeaderMap Map<String, String> headers);   //map   Map<String,String> headers = new HashMap()<>;   headers.put("Accept","text/plain");   headers.put("Accept-Charset", "utf-8");

2.0 Headers:

• 作用于方法,用于添加一个或多个请求头
• 具有相同名称的请求头不会相互覆盖,而是会照样添加到请求头中

示例:

//添加一个请求头 @Headers("Cache-Control: max-age=640000") @GET("/") ...//添加多个请求头@Headers({ "X-Foo: Bar",           "X-Ping: Pong"        })   @GET("/")   ...

2.1 HTTP:

• 作用于方法,用于发送一个自定义的HTTP请求

示例:

//自定义HTTP请求的标准样式interface Service {     @HTTP(method = "CUSTOM", path = "custom/endpoint/")     Call<ResponseBody> customEndpoint();   }//发送一个DELETE请求interface Service {     @HTTP(method = "DELETE", path = "remove/", hasBody = true)     Call<ResponseBody> deleteObject(@Body RequestBody object);   }

2.2 Multipart:

• 作用于方法
• 使用该注解,表示请求体是多部分的。 每一部分作为一个参数,且用Part注解声明

2.3 Part:

• 作用于方法的参数,用于定义Multipart请求的每个part
• 使用该注解定义的参数,参数值可以为空,为空时,则忽略
• 使用该注解定义的参数类型有以下3种方式可选:
  
  • 如果类型是okhttp3.MultipartBody.Part，内容将被直接使用。 省略part中的名称,即 @Part MultipartBody.Part part
  • 如果类型是RequestBody，那么该值将直接与其内容类型一起使用。 在注释中提供part名称（例如，@Part（“foo”）RequestBody foo）。
  • 其他对象类型将通过使用转换器转换为适当的格式。 在注释中提供part名称（例如，@Part（“foo”）Image photo）。

示例:

@Multipart@POST("/")Call<ResponseBody> example(       @Part("description") String description,       @Part(value = "image", encoding = "8-bit") RequestBody image);

2.4 PartMap:

• 作用于方法的参数,以map的方式定义Multipart请求的每个part
• map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常
• 使用该注解定义的参数类型有以下2种方式可选:
  
  • 如果类型是RequestBody，那么该值将直接与其内容类型一起使用。
  • 其他对象类型将通过使用转换器转换为适当的格式。

示例:

@Multipart@POST("/upload")Call<ResponseBody> upload(       @Part("file") RequestBody file,       @PartMap Map<String, RequestBody> params);

2.5 OPTIONS:

• 用于发送一个OPTIONS请求
• OPTIONS注解一般必须添加相对路径或绝对路径或者全路径,如果不想在OPTIONS注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

2.6 PATCH:

• 用于发送一个PATCH请求
• PATCH注解一般必须添加相对路径或绝对路径或者全路径,如果不想在PATCH注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

2.7 Path:

• 作用于方法的参数
• 在URL路径段中替换指定的参数值。使用String.valueOf()和URL编码将值转换为字符串。
  使用该注解定义的参数的值不可为空
  参数值默认使用URL编码

示例:

//标准使用方式,默认使用URL编码@GET("/image/{id}")Call<ResponseBody> example(@Path("id") int id);//默认使用URL编码@GET("/user/{name}")Call<ResponseBody> encoded(@Path("name") String name);//不使用URL编码@GET("/user/{name}")Call<ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);

2.8 POST:

• 用于发送一个POST请求
• POST注解一般必须添加相对路径或绝对路径或者全路径,如果不想在POST注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

2.9 PUT:

• 用于发送一个PUT请求
• PUT注解一般必须添加相对路径或绝对路径或者全路径,如果不想在PUT注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径

3.0 Query:

• 作用于方法的参数
• 用于添加查询参数,即请求参数
• 参数值通过String.valueOf()转换为String并进行URL编码
• 使用该注解定义的参数,参数值可以为空,为空时,忽略该值,当传入一个List或array时,为每个非空item拼接请求键值对,所有的键是统一的,如: name=张三&name=李四&name=王五.
  示例:

@GET("/list")Call<ResponseBody> list(@Query("page") int page);@GET("/list")Call<ResponseBody> list(@Query("category") String category);//传入一个数组@GET("/list")Call<ResponseBody> list(@Query("category") String... categories);//不进行URL编码@GET("/search")Call<ResponseBody> list(@Query(value="foo", encoded=true) String foo);

3.1 QueryMap:

• 作用于方法的参数
• 以map的形式添加查询参数,即请求参数
• 参数的键和值都通过String.valueOf()转换为String格式
• map的键和值默认进行URL编码
• map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常

示例:

//使用默认URL编码@GET("/search")Call<ResponseBody> list(@QueryMap Map<String, String> filters);//不使用默认URL编码@GET("/search")Call<ResponseBody> list(@QueryMap(encoded=true) Map<String, String> filters);

3.2 Streaming:

• 作用于方法
• 处理返回Response的方法的响应体，即没有将body（）转换为byte []。

3.3 Url:

• 作用于方法参数
• 用于添加请求的接口地址

示例:

@GETCall<ResponseBody> list(@Url String url);

!注意事项:

1. 以上部分注解真正的实现在ParameterHandler类中,,每个注解的真正实现都是ParameterHandler类中的一个final类型的内部类,每个内部类都对各个注解的使用要求做了限制,比如参数是否可空,键和值是否可空等.
2. FormUrlEncoded注解和Multipart注解不能同时使用,否则会抛出methodError(“Only one encoding annotation is allowed.”);可在ServiceMethod类中parseMethodAnnotation()方法中找到不能同时使用的具体原因.

3. Path注解与Url注解不能同时使用,否则会抛出parameterError(p, “@Path parameters may not be used with @Url.”),可在ServiceMethod类中parseParameterAnnotation()方法中找到不能同时使用的具体代码.其实原因也很好理解: Path注解用于替换url路径中的参数,这就要求在使用path注解时,必须已经存在请求路径,不然没法替换路径中指定的参数啊,而Url注解是在参数中指定的请求路径的,这个时候指定请求路径已经晚了,path注解找不到请求路径,更别提更换请求路径中的参数了.

4. 对于FiledMap,HeaderMap,PartMap,QueryMap这四种作用于方法的注解,其参数类型必须为Map的实例,且key的类型必须为String类型,否则抛出异常(以PartMap注解为例):parameterError(p, “@PartMap keys must be of type String: ” + keyType);

5. 使用Body注解的参数不能使用form 或multi-part编码,即如果为方法使用了FormUrlEncoded或Multipart注解,则方法的参数中不能使用Body注解,否则抛出异常parameterError(p, “@Body parameters cannot be used with form or multi-part encoding.”);

总结:

• @Path：所有在网址中的参数（URL的问号前面）；
• @Query：URL问号后面的参数；
• @QueryMap：相当于多个@Query ；
• @Field：用于POST请求，提交单个数据 ；（使用@Field时记得添加@FormUrlEncoded）
• @Body：相当于多个@Field，以对象的形式提交

若需要重新定义接口地址，可以使用@Url，将地址以参数的形式传入即可, @Url: 不要以/开头。如：

@GETCall<User> getUser(@Url String url);