Retrofit各个注解的含义及作用,细数Android开发者的艰辛历程

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

1.3 Field注解:

  • 作用于方法的参数

  • 用于发送一个表单请求

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

示例:

//普通参数 @FormUrlEncoded @POST("/") Call<ResponseBody> example(@Field("name") String name,@Field("occupation") String occupation); //固定或可变数组 @FormUrlEncoded @POST("/list") Call<ResponseBody> example(@Field("name") String... names);

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

  • 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

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数初中级安卓工程师,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年最新Android移动开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
img
img
img
img

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频
如果你觉得这些内容对你有帮助,可以添加下面V无偿领取!(备注Android)
img

这里我就分享一份资料,希望可以帮助到大家提升进阶。

内容包含:Android学习PDF+架构视频+面试文档+源码笔记高级架构技术进阶脑图、Android开发面试专题资料,高级进阶架构资料 这几块的内容。分享给大家,非常适合近期有面试和想在技术道路上继续精进的朋友。

如果你有需要的话,可以点击Android学习PDF+架构视频+面试文档+源码笔记获取免费领取方式

喜欢本文的话,不妨给我点个小赞、评论区留言或者转发支持一下呗~

漫长,而且极易碰到天花板技术停滞不前!**

因此收集整理了一份《2024年最新Android移动开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
[外链图片转存中…(img-P0YANL30-1710672148902)]
[外链图片转存中…(img-b5IXluLW-1710672148902)]
[外链图片转存中…(img-Vt24Yhqs-1710672148902)]
[外链图片转存中…(img-WQP0qq93-1710672148903)]

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频
如果你觉得这些内容对你有帮助,可以添加下面V无偿领取!(备注Android)
[外链图片转存中…(img-PYFkW7Gn-1710672148903)]

这里我就分享一份资料,希望可以帮助到大家提升进阶。

内容包含:Android学习PDF+架构视频+面试文档+源码笔记高级架构技术进阶脑图、Android开发面试专题资料,高级进阶架构资料 这几块的内容。分享给大家,非常适合近期有面试和想在技术道路上继续精进的朋友。

如果你有需要的话,可以点击Android学习PDF+架构视频+面试文档+源码笔记获取免费领取方式

喜欢本文的话,不妨给我点个小赞、评论区留言或者转发支持一下呗~

img

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值