Retrofit各个注解的含义及作用

于 2024-05-15 17:03:13 发布
阅读量396 收藏 8
点赞数 5
分类专栏： 程序员 文章标签： retrofit
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84901866/article/details/138915225
版权

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

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=张三.

示例:

//普通参数 @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

  • 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

最后

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

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

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

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
list(@QueryMap(encoded=true) Map<String, String> filters);`

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

[外链图片转存中…(img-KNN6tl8N-1715763734467)]

  • 1

  • 2

  • 3

最后

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

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

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

[外链图片转存中…(img-MuWlj4rR-1715763734467)]

[外链图片转存中…(img-KutVqDuw-1715763734469)]

[外链图片转存中…(img-mdftiX4Y-1715763734470)]

[外链图片转存中…(img-fq91c304-1715763734471)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

2401_84901866
关注
  • 5
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Retrofit注解的含义及作用
millerkevin
11-30 917
Retrofit各个注解的含义及作用1. 各个注解的含义及使用1.1 Body: 作用于方法的参数 使用该注解定义的参数不可为null 当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去. 1.2 DELETE: 用于发送一个DELETE
Retrofit实例讲解，让你醍醐灌顶
11-14
讲解五种注解的形式包含@Get，@Post，@Path，@Query ，@QueryMap的实例，帮助更好的理解应用。详细博客讲解https://blog.csdn.net/lou_liang/article/details/84069006
Retrofit原理浅析
u014732103的博客
09-11 3156
Retrofit是Square组织开发维护的一款网络框架。Retrofit非常适合处理RESTful风格的网络接口。Retrofit通过注解和动态代理简化了网络请求的代码工作量，与OKHttp为同一组织开发，能够很好的结合使用。 Retrofit和okhttp配合使用的优点 Retrofit其实是在okhttp的基础之上进行了封装。把网络请求都交给给了Okhttp，我们只需要通过简单的配置就能...
Retrofit注解的底层原理
冯旭的博客
03-20 719
https://www.jianshu.com/p/75f56f4d790ahttps://www.jianshu.com/p/f1a8356c615f
Retrofit 原理简析
ganyao939543405的博客
07-20 1013
简介   Retrofit 所做的事情简单来说就是将你的 Http 业务 API --> Http 请求实现，类似于 Spring MVC 中的 Controller，它的主要任务是解析你的业务接口，从接口上获取你的 Http 接口协议，然后组装 Http 请求，进行异步 Request。   Retrofit 整合了多个组件，包括 JSON/XML 的 ORM 映射，用于解析返回值；Http
Retrofit自定义请求参数注解的实现思路
08-26
Retrofit 自定义请求参数注解的实现思路 Retrofit 是一个流行的网络请求库，提供了强大的网络请求功能。但是，在实际开发中，我们经常需要自定义请求参数，以满足不同的业务需求。在这篇文章中，我们将探索 ...
Retrofit基本使用
01-03
文章目录Retrofit基本使用简介Retrofit注解方法注解标记注解请求头注解参数注解简单使用引入Retrofit依赖及添加权限创建Retrofit实例初步封装定义API接口创建代理对象接口调用 – 简介 Retrofit文档 Retrofit Github...
手写Retrofit
09-25
除了Retrofit自带的注解，你还可以自定义注解来实现更复杂的功能，例如添加请求头、参数等： ```java @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface CustomGet { String ...
Retrofit实例
06-10
这里，`@GET`是Retrofit的注解，用于指定HTTP方法，`{id}`是一个动态参数，`@Path`注解用来绑定参数。 2. **配置Retrofit实例**：接下来，我们需要创建一个Retrofit实例，配置基础URL和其他设置。这通常在应用的...
Retrofit中的注解
Rssqzqyp的博客
11-30 798
参数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简单原理分析
LYRIC_315的专栏
09-30 3296
Retrofit原理分析之前学习了怎么使用Retrofit，现在来学习它的原理。Retrofit使用接口+注解的形式来定义一个网络请求，在通过OkHttp来执行网络请求。现在有很多开源使用了注解Annotation，如Dagger2、ButterKnife等，以及Retrofit。所不同的是他们利用注解干的事却不一样。Dagger2、ButterKnife他们在编译期间就处理注解生成代码，提供依赖注
@RetrofitClient配合自定义拦截注解@Sign完成加签加密
最新发布
看天空x的博客
12-22 370
使用@RetrofitClient及其Http相关请求注解，为快速开发API接口提供便利，剥离加签加密过程，只用关注业务代码的开发。
Retrofit的注解使用
阿甘正传
06-13 375
Retrofit请求参数注解字段说明 Retrofit使用详解
Retrofit网络请求框架中总共23个@注解大大大全---这么多吓得藕说都不会话了
m0_37271466的博客
12-19 1386
注解大全（实例代码结合RxJava） 实例全展示：建立一个接口服务，将所有注解进行实例展示(持续更新中^_^) public interface ILoginApi { //假设的服务器地址： http://192.168.11.112/api/ //--------------------------------------------------------------...
Retrofit 注解参数详解
赵彦军
10-28 1093
文章目录GET@Path@Query@QueryMapPOST@Bodyform表单1：@FormUrlEncodedform表单2：FormBody@Multipart上传文件 对Retrofit已经使用了一点时间了，是时候归纳一下各种网络请求的service了。 下面分为GET、POST、DELETE还有PUT的请求，说明@Path、@Query、@QueryMap、@Body、@Field的用法。 添加依赖 implementation 'com.squareup.retrofit2:retrofit
推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架，快来试试它!
伍六七
11-24 1623
在SpringBoot项目直接使用okhttp、httpClient或者RestTemplate发起HTTP请求，既繁琐又不方便统一管理。因此，在这里推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架retrofit-spring-boot-starter，使用非常简单方便，同时又提供诸多功能增强。目前项目已经更新至2.2.2版本，并且会持续进行迭代优化。 项目地址：https://github.com/LianjiaTech/retrofit-spring-boot-starter 前言
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 {
Retrofit 中的注解以及如何自定义接口方法注解
wangjiang
07-10 3870
前言 Retrofit 是一个网络请求框架，它在Android领域已经被使用很长一段时间了。我们知道它的特点就是用注解来描述 HTTP 请求： 支持 URL 参数替换和查询参数 将对象转换为请求主体（例如，JSON、协议缓冲区） 多部分请求正文和文件上传 这些注解主要用来标识接口方法和接口方法参数，并预示着一个请求将会被如何处理。 ...
Retrofit API注解application/json或者application/x-www-form-urlencoded数据
09-22
在使用Retrofit进行API请求时，可以通过注解来指定请求体的数据格式。对于发送application/json格式的数据，可以使用@Body注解，而对于发送application/x-www-form-urlencoded格式的数据，可以使用@Field或@FieldMap...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值