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

于 2024-05-16 22:02:46 发布
阅读量217 收藏
点赞数 2
分类专栏： 程序员 文章标签： retrofit
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84408337/article/details/138976678
版权

  • 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学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！

2401_84408337
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Retrofit注解的含义及作用
millerkevin
11-30 915
Retrofit各个注解的含义及作用1. 各个注解的含义及使用1.1 Body: 作用于方法的参数 使用该注解定义的参数不可为null 当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去. 1.2 DELETE: 用于发送一个DELETE
Retrofit动态设置baseUrl和@url的使用
热门推荐
liuxiaopang520的博客
01-13 1万+
一. Retrofit动态设置baseUrl有四种方式: 配置多个retrofit对象：即不同的 BaseUrl 使用不同的 Retrofit 对象来创建 ApiService 进行请求,这样只要新增一个不同的 BaseUrl ,那就需要重新创建一个新的 Retrofit 对象。 缺点：代码冗余，浪费资源，ApiService太多，不好管理。 @Get , @Post 全路径：这些标注到每个接口方法上的注解不仅可以传相对路径,还可以传全路径,这样我们就可以做到不同的接口使用不同的 BaseUrl ,使用全
@RetrofitClient配合自定义拦截注解@Sign完成加签加密
看天空x的博客
12-22 366
使用@RetrofitClient及其Http相关请求注解，为快速开发API接口提供便利，剥离加签加密过程，只用关注业务代码的开发。
Retrofit使用及解析(一)
qq_37321098的博客
11-12 1034
目录          1.设置请求头 1）方法头部定义 2）拦截器配置 3）动态配置 2.get请求参数@Query/@QueryMap/@Path 1）不变参数配置 2）@Query注解 3）@QueryMap 4) key字段同，value有多个 5) @query参数非必填 6) 占位请求参数@Path 3.post请求参数@Body 1）@Body 2）@Fo...
Retrofit2.0 注解含义总结
qq_41096887的博客
09-17 682
Retrofit2.0 注解含义总结 1. 注解类型 retrofit提供三种注解类型，分别为网络请求方法注解，标记注解，和网络请求参数注解 网络请求方法注解：@GET @POST @PUT @DELETE @PATH @HEAD @OPTIONS @HTTP 前七种对应http1.1规定的其中的请求方式，注解应该指定一个请求的URL，也可以不指定，交给HTTP注解去处理，http注解可以替换之前的七个注解并且定制更多的功能扩展 标记注解：@FormUrlEncoded @Multipart @Stream
retrofit 官方动态Url请求
倒骑驴走着瞧的博客
04-20 2509
开发中经常会遇到一个app中会有多个请求url，这样就涉及到不同的baseurl；解决办法 官方通过@Url传递全量url进行请求，如下 Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/") .build() public interface GitHubService {...
Retrofit自定义请求参数注解的实现思路
08-26
Retrofit 自定义请求参数注解的实现思路 Retrofit 是一个流行的网络请求库，提供了强大的网络请求功能。但是，在实际开发中，我们经常需要自定义请求参数，以满足不同的业务需求。在这篇文章中，我们将探索 ...
Retrofit基本使用
01-03
文章目录Retrofit基本使用简介Retrofit注解方法注解标记注解请求头注解参数注解简单使用引入Retrofit依赖及添加权限创建Retrofit实例初步封装定义API接口创建代理对象接口调用 – 简介 Retrofit文档 Retrofit Github...
retrofit大致1.pdf
12-02
对Retrofit源码进行了分析,并且绘制了其内部流程结构图,结合源码理解非常容易
Latihan1Retrofit
03-19
【标题】"Latihan1Retrofit" 是一个与 Kotlin 相关的项目，它涉及到 Android 开发中的网络请求库 Retrofit 的使用。Retrofit 是由 Square 公司开发的一个流行的 Java 和 Kotlin 库，用于简化 Android 和 Java 应用...
android 网络框架-Retrofit(二)
安卓兼职framework和app工程师的博客
12-25 175
Xml格式配置 你好,我是kpioneer 你好,我是Jeason 你好,我是Cook 注意：@Root：注解代表Xml根节点（需要在类上面使用） 例如： @Element：注解代表根节点中下面子节点 例如：<user></user> @Attribute：注解代表标签页中的属性 例如：userid = '1' @Te...
Retrofit 网络请求参数注解@Path @Field @Query 等使用
小牧在一直在学习,在前进的道路上大家一起学习，进步。
11-21 7906
请求参数呢大致如下，到个别人的图， 下面就说下这些内容使用 其中@Path、@Query、@QueryMap 使用 Get 请求 ， 加入使用了Post 请求注解使用@Path 一般都会是项目崩溃的， 所以这里我总结了一下自己使用的经验 1 @Path 会是url 中带有参数一般配合{} 一起 @GET("toutiao/index/{type}/{key}") Ob...
Retrofit 快速学习 注解详解
weixin_33843947的博客
09-06 503
为什么80%的码农都做不了架构师？>>> ...
Android网络请求框架Retrofit配合注解使用
吕氏春秋i
03-09 339
依赖github搜索Retrofitimplementation 'com.squareup.retrofit2:retrofit:2.3.0'配置 Retrofitretrofit = new Retrofit.Builder() .baseUrl(&amp;quot;http://192.168.18.249:8080/&amp;quot;) .build();定义数据接口public interface DataServer {
推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架，快来试试它!
伍六七
11-24 1622
在SpringBoot项目直接使用okhttp、httpClient或者RestTemplate发起HTTP请求，既繁琐又不方便统一管理。因此，在这里推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架retrofit-spring-boot-starter，使用非常简单方便，同时又提供诸多功能增强。目前项目已经更新至2.2.2版本，并且会持续进行迭代优化。 项目地址：https://github.com/LianjiaTech/retrofit-spring-boot-starter 前言
Springboot使用Retrofit实现远程接口调用
青春不散场的专栏
08-22 1311
RetrofitClient(baseUrl = “${test.baseUrl}”) 指定RetrofitClient客户端类，baseUrl指定base地址@HTTP/@GET/@POST 常用提交数据和获取数据@Header/@Headers 添加请求头@URL/@PATH URL缺省值设置@Filed/@FieldMap 用于表单传入键值对 POST请求@Part/@PartMap 用户文件上传的表单字体。
Retrofit2的POST请求MultiPart与FormUrlEncoded
weixin_41633457的博客
03-31 1万+
前言 最近在项目里使用了Retrofit2 + Rxjava框架封装网络请求，照着网上的教程一步步搭建起来，顺利地完成了网络请求模块的工作，同时通过okhttp3提供的logging拦截器打印出的请求与服务器回复日志，也是正常的参数与数据，但不知为何日志显示得很长很详细，如下图（还没截完），通过抓包工具看到的参数key也是很长很详细的key，这就令人疑惑了，究竟是为什么呢？ 解决疑问 通过向同事...
Retrofit各个注解的含义及作用，细数Android开发者的艰辛历程
最新发布
m0_61549591的博客
03-17 452
这里我就分享一份资料，希望可以帮助到大家提升进阶。
使用Retrofit进行GET请求时需要用到哪些注解？并简述每个注解的作用
03-28
使用Retrofit进行GET请求需要用到以下注解： 1. @GET：用于定义HTTP GET请求的注解。 2. @Query：用于添加查询参数的注解。可以添加多个@Query注解，每个注解对应一个参数。例如：@Query("id") int id 3. @Path：用于替换URL中的占位符的注解。例如：@Path("id") int id 4. @Header：用于添加HTTP请求头的注解。例如：@Header("Authorization") String token 5. @Headers：用于添加多个HTTP请求头的注解。例如：@Headers({"Content-Type: application/json", "Accept: application/json"}) 6. @Url：用于指定完整的请求URL的注解。例如：@Url String url 这些注解的作用如上所述，可以方便地配置HTTP请求的参数、请求头和URL等信息，使得开发人员可以更加灵活地使用Retrofit进行网络请求。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值