Retrofit各个注解的含义及作用(1)

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

1.4 FieldMap注解:

• 作用于方法的参数

• 用于发送一个表单请求

• map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常

示例:

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

• 1

• 2

• 3

• 1

• 2

• 3

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

• 2

• 1

• 2

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");

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 1

• 2

• 3

• 4

• 5

• 6

• 7

2.0 Headers注解:

• 作用于方法,用于添加一个或多个请求头

• 具有相同名称的请求头不会相互覆盖,而是会照样添加到请求头中

示例:

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

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

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); }

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

2.2 Multipart注解:

• 作用于方法

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

2.3 Part注解:

• 作用于方法的参数,用于定义Multipart请求的每个part

• 使用该注解定义的参数,参数值可以为空,为空时,则忽略

• 使用该注解定义的参数类型有以下3种方式可选:

1, 如果类型是okhttp3.MultipartBody.Part，内容将被直接使用。 省略part中的名称,即 @Part MultipartBody.Part part

2, 如果类型是RequestBody，那么该值将直接与其内容类型一起使用。 在注释中提供part名称（例如，@Part（“foo”）RequestBody foo）。

3, 其他对象类型将通过使用转换器转换为适当的格式。 在注释中提供part名称（例如，@Part（“foo”）Image photo）。

示例:

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

• 1

• 2

• 3

• 4

• 5

• 1

• 2

• 3

• 4

• 5

2.4 PartMap注解:

• 作用于方法的参数,以map的方式定义Multipart请求的每个part

• map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常

• 使用该注解定义的参数类型有以下2种方式可选:

1, 如果类型是RequestBody，那么该值将直接与其内容类型一起使用。

2, 其他对象类型将通过使用转换器转换为适当的格式。

示例:

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

• 1

• 2

• 3

• 4

• 5

• 1

• 2

• 3

• 4

• 5

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);

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

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);

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

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);

• 1

• 2

• 3

• 4

• 5

• 6

• 1

• 2

• 3

• 4

• 5

• 6

3.2 Streaming注解:

• 作用于方法

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

3.3 Url注解:

• 作用于方法参数

• 用于添加请求的接口地址

示例:

@GET Call<ResponseBody> list(@Url String url);

• 1

• 2

• 1

• 2

注意事项:

最后

感谢您的阅读，在文末给大家准备一个福利。本人从事Android开发已经有十余年，算是一名资深的移动开发架构师了吧。根据我的观察发现，对于很多初中级Android工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。

所以在此将我十年载，从萌新小白一步步成长为Android移动开发架构师的学习笔记，从Android四大组件到手写实现一个架构设计，我都有一一的对应笔记为你讲解。

当然我也为你们整理好了百度、阿里、腾讯、字节跳动等等互联网超级大厂的历年面试真题集锦。这也是我这些年来养成的习惯，一定要学会把好的东西，归纳整理，然后系统的消化吸收，这样才能极大的提高学习效率和成长进阶。碎片、零散化的东西，我觉得最没有价值的。就好比你给我一张扑克牌，我只会觉得它是一张废纸，但如果你给我一副扑克牌，它便有了它的价值。这和我们收集资料就要收集那些系统化的，是一个道理。

最后，赠与大家一句诗，共勉！

不驰于空想，不骛于虚声。不忘初心，方得始终。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
ls/76503850)示例:

@GET Call<ResponseBody> list(@Url String url);

• 1

• 2

[外链图片转存中…(img-ZME5eo6p-1715868153005)]

• 1

• 2

注意事项:

最后

感谢您的阅读，在文末给大家准备一个福利。本人从事Android开发已经有十余年，算是一名资深的移动开发架构师了吧。根据我的观察发现，对于很多初中级Android工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。

所以在此将我十年载，从萌新小白一步步成长为Android移动开发架构师的学习笔记，从Android四大组件到手写实现一个架构设计，我都有一一的对应笔记为你讲解。

当然我也为你们整理好了百度、阿里、腾讯、字节跳动等等互联网超级大厂的历年面试真题集锦。这也是我这些年来养成的习惯，一定要学会把好的东西，归纳整理，然后系统的消化吸收，这样才能极大的提高学习效率和成长进阶。碎片、零散化的东西，我觉得最没有价值的。就好比你给我一张扑克牌，我只会觉得它是一张废纸，但如果你给我一副扑克牌，它便有了它的价值。这和我们收集资料就要收集那些系统化的，是一个道理。

[外链图片转存中…(img-HAmWb3t1-1715868153005)]

最后，赠与大家一句诗，共勉！

不驰于空想，不骛于虚声。不忘初心，方得始终。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！