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

最新推荐文章于 2024-06-24 18:08:43 发布
最新推荐文章于 2024-06-24 18:08:43 发布
阅读量154 收藏
点赞数 3
分类专栏： 程序员 文章标签： retrofit
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84407942/article/details/138637897
版权

  • 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-X1fEsK12-1715272258019)]

  • 1

  • 2

注意事项:

最后

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

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

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

[外链图片转存中…(img-38XjQcOO-1715272258021)]

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

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

2401_84407942
关注
专栏目录
Android进阶之路 - Retrofit注解全析
Android、前端、小程序、后端
03-25 1653
我还记得2017年的时候就已经有同事慢慢开始使用Retrofit网络框架了，在2018年的时候也是同事封装好我直接使用的，索性2020年的时候自己写新项目，借着这个机会巩固封装了一波，只是时隔几个月才来记录，起初久久无法落笔，因为想写的有点多，最终决定分为几个部分进行记录 ~.........
retroFit的注解方法
chenyibai的博客
07-13 1983
1、什么是Retrofit框架？ 它是Square公司开发的现在非常流行的网络框架 2.为什么使用Retrofit框架 性能好，处理快，使用简单，Retrofit 是安卓上流行的HTTP Client库之一 默认使用OKHttp处理网络请求，我觉得可以看成是OKHttp的增强。 默认使用Gson解析  二、配置Retrofit2.0   //配置retrofit2.0compile 'com....
Retrofit常见注解全解析
09-06 776
​导语Android开发圈中这三者Retrofit+RxJava+MVP结合使用的频率已经相当高了，很多圈内大神也已经总结了很多有关于整合这三者的博客，已经很多了，今天写这篇文章主要就不再介绍了。不过很多人并不了解Retrofit的全部注解使用，今天的重点就是要介绍日常常用的Retrofit的注解。1、什么是Retrofit?Retrofit 是一个Square开发的安卓客户端请求库。其中内部封装了
Retrofit注解的含义及作用
millerkevin
11-30 972
Retrofit各个注解的含义及作用1. 各个注解的含义及使用1.1 Body: 作用于方法的参数 使用该注解定义的参数不可为null 当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去. 1.2 DELETE: 用于发送一个DELETE
Retrofit各个注解的含义及作用
热门推荐
qiang_xi的专栏
12-31 3万+
写在前面本篇文章基于retrofit-2.1进行分析.1. 各个注解的含义及使用1.1 Body注解: 作用于方法的参数 使用该注解定义的参数不可为null 当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去. 示例: //实体
Retrofit中的注解
Rssqzqyp的博客
11-30 959
参数method：使用http注解时必须要指定method，method如果是POST就会执行http方法执行post请求，method如果指定GET就会执行http方法执行get请求。@path注解作用于参数部分，意思是{id}里面是id会被@path中的id替换掉替换成参数path。可以看到请求的url是http://www.httpbin.org/post,使用的是post请求。@url注解作用于参数中，作用是指定完整的http地址，不像之前的注解还要自己进行拼接。@Header是用来设置请求头的。
Retrofit请求参数注解字段说明
专注Android开发
11-28 7055
@Query、@QueryMap 用于Http Get请求传递参数.如: @GET("group/users")CallListUser>> groupList(@Query("id") int groupId); 等同于: @GET("group/users?id=groupId") 即将@Query的key-value添加到url后面组成get方式的参数,
Retrofit简单使用
欢迎交流
05-02 399
Retrofit学习笔记 Retrofit基础 Retrofit 中使用注解的方式来区分请求类型,比如@GET("/record")表示一个GET请求,要以 / 开头，会拼接到基本URL后面，record为接口地址。各个格式和含义如下： 例如，GET请求(其他请求类似)： @GET("/apistore/mobilenumber/mobilenumber") Ca...
观战Retrofit开发中的哪点事
Floating Cat
09-15 7956
又是一年中秋佳节，祝各位中秋节快乐。今天我们来聊聊这个最近很火的网络请求库retrofit，在此基础上会延伸出一些列的知识点。
Android Retrofit2+Rxjava2 初学总结
qq_41556284的博客
08-23 363
Android Retrofit2+Rxjava2 初学总结 此文针对初学android开发，基础比较薄弱的同学。总结了自己在使用Retrofit2+Rxjava2框架发送请求的一些经验。 由于只是为了实现功能，所以在代码的封装以及优化上没有做什么改进。 首先，一个请求，对应的url地址我们把它分为三个部分。 以我自己申请的一个api接口为例，我申请了一个获取手机号归属地api，具体使用方法在ht...
【Retrofit】Retrofit原理解析之注解详解篇
珍心
11-22 1002
学而不思则罔，思而不学则殆 【Retrofit】Retrofit原理解析之注解详解篇
Retrofit 注解最全使用讲解
Code Issuer的博客
11-29 946
method annotation 方法注解@GET @POST @Multipart @FormUrlEncoded @Headers (@PUT/@DELETE/@PATCH/@HEAD 不经常使用所以省略） @Get ① 不可以搭配 @FormUrlEncoded 和 @Multipart ②可以搭配@Headers @POST ① @FormUrlEncoded (普通表单上传) / @P
Retrofit 常用注解及其解释
qq_45490395的博客
09-14 636
1.需要掌握的注解字段 Get Post Url Query QueryMap Field FieldMap Path Body Part MulltiPart Header Headers FormUrlEncode retrofit的简单实现： 依赖： implementation ‘com.squareup.retrofit2:retrofit:2.5.0’ implementation ‘com.squareup.retrofit2:converter-gson:2.1.0’ 1 2 权限： Re
Retrofit常见注解 最详细解析
冯旭的博客
03-20 2660
Android开发圈中这三者Retrofit+RxJava+MVP结合使用的频率已经相当高了，很多圈内大神也已经总结了很多有关于整合这三者的博客，已经很多了，今天写这篇文章主要就不再介绍了。不过很多人并不了解Retrofit的全部注解使用，今天的重点就是要介绍日常常用的Retrofit的注解。 1、什么是Retrofit? Retrofit 是一个Square开发的安卓客户端请求库。其中内部封...
Retrofit常用注解
Cricket_7的博客
04-29 369
6，常用注解 【1】@Path可以传递参数动态替换掉某端字符 * @Path("category") 和{category} 填写一致即可 //Path注解可以替换某一段动态多变的路径 @GET("test/{category}/{page}") Call<Stu> getProducts(@Path("category") String category, @Path("...
Retrofit原理浅析
u014732103的博客
09-11 3186
Retrofit是Square组织开发维护的一款网络框架。Retrofit非常适合处理RESTful风格的网络接口。Retrofit通过注解和动态代理简化了网络请求的代码工作量，与OKHttp为同一组织开发，能够很好的结合使用。 Retrofit和okhttp配合使用的优点 Retrofit其实是在okhttp的基础之上进行了封装。把网络请求都交给给了Okhttp，我们只需要通过简单的配置就能...
Retrofit2中注解
Dream
09-12 901
示例注解，场景为用户的获取 @Path 拼接url 。例如 http://localhost:8080/User/Info/小明 其中User 是后端Controller 。Info是方法。小明是请求参数 客户端： @GET("Info/{name}") Call&lt;User&gt; userInfo(@Path("name") String name); 后端...
Retrofit原理和常用注解
最新发布
m0_46268254的博客
06-24 1666
Retrofit 面试
Retrofit自定义注解实现POST请求参数
1. 创建自定义注解：定义一个新的注解，比如`@JsonParam`，用于标记POST请求中的参数。 2. 创建GsonRequestBodyConverter：编写一个转换器，它能够解析使用`@JsonParam`注解的参数，并将其转换为JSON格式的Request...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值