SpringBoot项目整合Retrofit最佳实践,这才是最优雅的HTTP客户端工具!
作者:六点半起床
juejin.im/post/6854573211426750472
大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上,square公司还开源了基于okhttp进一步封装的retrofit工具,用来支持通过接口的方式发起http请求。
如果你的项目中还在直接使用RestTemplate或者okhttp,或者基于它们封装的HttpUtils,那么你可以尝试使用Retrofit。
retrofit-spring-boot-starter
实现了Retrofit与spring-boot框架快速整合,并且支持了部分功能增强,从而极大的简化spring-boot项目下http接口调用开发。接下来我们直接通过retrofit-spring-boot-starter
,来看看spring-boot项目发送http请求有多简单。
retrofit官方并没有提供与spring-boot快速整合的starter。retrofit-spring-boot-starter
是笔者封装的,已在生产环境使用,非常稳定。喜欢的话给个star。
https://github.com/LianjiaTech/retrofit-spring-boot-starter
引入依赖
<dependency><groupId>com.github.lianjiatech</groupId><artifactId>retrofit-spring-boot-starter</artifactId><version>2.0.2</version>
</dependency>
配置@RetrofitScan注解
你可以给带有 @Configuration 的类配置@RetrofitScan,或者直接配置到spring-boot的启动类上,如下:
@SpringBootApplication
@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
public class RetrofitTestApplication {public static void main(String[] args) {SpringApplication.run(RetrofitTestApplication.class, args);}
}
定义http接口
接口必须使用@RetrofitClient注解标记!推荐:一百期面试题汇总
http相关注解可参考官方文档:
https://square.github.io/retrofit/
@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {@GET("person")Result<Person> getPerson(@Query("id") Long id);
}
注入使用
将接口注入到其它Service中即可使用。
@Service
public class TestService {@Autowiredprivate HttpApi httpApi;public void test() {// 通过httpApi发起http请求}
}
只要通过上述几个步骤,就能实现通过接口发送http请求了,真的很简单。如果你在spring-boot项目里面使用过mybatis,相信你对这种使用方式会更加熟悉。
接下来我们继续介绍一下retrofit-spring-boot-starter
更高级一点的功能。
注解式拦截器
很多时候,我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。这个时候可以使用注解式拦截器。使用的步骤主要分为2步:
继承BasePathMatchInterceptor编写拦截处理器;
接口上使用@Intercept进行标注。
下面以给指定请求的url后面拼接timestamp时间戳为例,介绍下如何使用注解式拦截器。
继承BasePathMatchInterceptor编写拦截处理器
@Component
public class TimeStampInterceptor extends BasePathMatchInterceptor {@Overridepublic Response doIntercept(Chain chain) throws IOException {Request request = chain.request();HttpUrl url = request.url();long timestamp = System.currentTimeMillis();HttpUrl newUrl = url.newBuilder().addQueryParameter("timestamp", String.valueOf(timestamp)).build();Request newRequest = request.newBuilder().url(newUrl).build();return chain.proceed(newRequest);}
}
接口上使用@Intercept进行标注
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {@GET("person")Result<Person> getPerson(@Query("id") Long id);@POST("savePerson")Result<Person> savePerson(@Body Person person);
}
上面的@Intercept配置表示:拦截HttpApi接口下/api/**
路径下(排除/api/test/savePerson)的请求,拦截处理器使用TimeStampInterceptor。推荐:一百期面试题汇总
扩展注解式拦截器
有的时候,我们需要在拦截注解动态传入一些参数,然后再执行拦截的时候需要使用这个参数。这种时候,我们可以扩展实现自定义拦截注解。
自定义拦截注解必须使用@InterceptMark标记,并且注解中必须包括include()、exclude()、handler()属性信息。使用的步骤主要分为3步:
自定义拦截注解
继承BasePathMatchInterceptor编写拦截处理器
接口上使用自定义拦截注解;
例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求,这个时候可以自定义一个加签拦截器注解@Sign来实现。下面以自定义@Sign拦截注解为例进行说明。
自定义@Sign注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {/*** 密钥key* 支持占位符形式配置。** @return*/String accessKeyId();/*** 密钥* 支持占位符形式配置。** @return*/String accessKeySecret();/*** 拦截器匹配路径** @return*/String[] include() default {"/**"};/*** 拦截器排除匹配,排除指定路径拦截** @return*/String[] exclude() default {};/*** 处理该注解的拦截器类* 优先从spring容器获取对应的Bean,如果获取不到,则使用反射创建一个!** @return*/Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}
扩展自定义拦截注解有以下2点需要注意:
自定义拦截注解必须使用@InterceptMark标记。
注解中必须包括include()、exclude()、handler()属性信息。
实现SignInterceptor
@Component
public class SignInterceptor extends BasePathMatchInterceptor {private String accessKeyId;private String accessKeySecret;public void setAccessKeyId(String accessKeyId) {this.accessKeyId = accessKeyId;}public void setAccessKeySecret(String accessKeySecret) {this.accessKeySecret = accessKeySecret;}@Overridepublic Response doIntercept(Chain chain) throws IOException {Request request = chain.request();Request newReq = request.newBuilder().addHeader("accessKeyId", accessKeyId).addHeader("accessKeySecret", accessKeySecret).build();return chain.proceed(newReq);}
}
上述accessKeyId和accessKeySecret字段值会依据@Sign注解的accessKeyId()和accessKeySecret()值自动注入,如果@Sign指定的是占位符形式的字符串,则会取配置属性值进行注入。
另外,accessKeyId和accessKeySecret字段必须提供setter方法。Java知音公众号内回复“后端面试”,送你一份Java面试题宝典
接口上使用@Sign
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {@GET("person")Result<Person> getPerson(@Query("id") Long id);@POST("savePerson")Result<Person> savePerson(@Body Person person);
}
这样就能在指定url的请求上,自动加上签名信息了。
连接池管理
默认情况下,所有通过Retrofit发送的http请求都会使用max-idle-connections=5 keep-alive-second=300
的默认连接池。
当然,我们也可以在配置文件中配置多个自定义的连接池,然后通过@RetrofitClient的poolName属性来指定使用。比如我们要让某个接口下的请求全部使用poolName=test1的连接池,代码实现如下:
1.配置连接池。
retrofit:# 连接池配置pool:test1:max-idle-connections: 3keep-alive-second: 100test2:max-idle-connections: 5keep-alive-second: 50
2.通过@RetrofitClient的poolName属性来指定使用的连接池。
@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {@GET("person")Result<Person> getPerson(@Query("id") Long id);
}
日志打印
很多情况下,我们希望将http请求日志记录下来。通过@RetrofitClient的logLevel和logStrategy属性,您可以指定每个接口的日志打印级别以及日志打印策略。
retrofit-spring-boot-starter支持了5种日志打印级别(ERROR, WARN, INFO, DEBUG, TRACE),默认INFO;支持了4种日志打印策略(NONE, BASIC, HEADERS, BODY),默认BASIC。
4种日志打印策略含义如下:
NONE:No logs.
BASIC:Logs request and response lines.
HEADERS:Logs request and response lines and their respective headers.
BODY:Logs request and response lines and their respective headers and bodies (if present).
retrofit-spring-boot-starter默认使用了DefaultLoggingInterceptor执行真正的日志打印功能,其底层就是okhttp原生的HttpLoggingInterceptor。
当然,你也可以自定义实现自己的日志打印拦截器,只需要继承BaseLoggingInterceptor(具体可以参考DefaultLoggingInterceptor的实现),然后在配置文件中进行相关配置即可。
retrofit:# 日志打印拦截器logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
Http异常信息格式化器
当出现http请求异常时,原始的异常信息可能阅读起来并不友好,因此retrofit-spring-boot-starter提供了Http异常信息格式化器,用来美化输出http请求参数,默认使用DefaultHttpExceptionMessageFormatter进行请求数据格式化。Java知音公众号内回复“后端面试”,送你一份Java面试题宝典
你也可以进行自定义,只需要继承BaseHttpExceptionMessageFormatter,再进行相关配置即可。
retrofit:# Http异常信息格式化器http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter
调用适配器 CallAdapter
Retrofit可以通过调用适配器CallAdapterFactory将Call<T>
对象适配成接口方法的返回值类型。retrofit-spring-boot-starter扩展2种CallAdapterFactory实现:
BodyCallAdapterFactory
默认启用,可通过配置retrofit.enable-body-call-adapter=false关闭
同步执行http请求,将响应体内容适配成接口方法的返回值类型实例。
除了
Retrofit.Call<T>
、Retrofit.Response<T>
、java.util.concurrent.CompletableFuture<T>
之外,其它返回类型都可以使用该适配器。
ResponseCallAdapterFactory
默认启用,可通过配置
retrofit.enable-response-call-adapter=false
关闭同步执行http请求,将响应体内容适配成
Retrofit.Response<T>
返回。如果方法的返回值类型为
Retrofit.Response<T>
,则可以使用该适配器。
Retrofit自动根据方法返回值类型选用对应的CallAdapterFactory执行适配处理!加上Retrofit默认的CallAdapterFactory,可支持多种形式的方法返回值类型:
Call<T>
: 不执行适配处理,直接返回Call<T>
对象CompletableFuture<T>
: 将响应体内容适配成CompletableFuture<T>
对象返回Void: 不关注返回类型可以使用Void。如果http状态码不是2xx,直接抛错!
Response<T>
: 将响应内容适配成Response<T>
对象返回其他任意Java类型:将响应体内容适配成一个对应的Java类型对象返回,如果http状态码不是2xx,直接抛错!
/*** Call<T>* 不执行适配处理,直接返回Call<T>对象* @param id* @return*/@GET("person")Call<Result<Person>> getPersonCall(@Query("id") Long id);/*** CompletableFuture<T>* 将响应体内容适配成CompletableFuture<T>对象返回* @param id* @return*/@GET("person")CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);/*** Void* 不关注返回类型可以使用Void。如果http状态码不是2xx,直接抛错!* @param id* @return*/@GET("person")Void getPersonVoid(@Query("id") Long id);/*** Response<T>* 将响应内容适配成Response<T>对象返回* @param id* @return*/@GET("person")Response<Result<Person>> getPersonResponse(@Query("id") Long id);/*** 其他任意Java类型* 将响应体内容适配成一个对应的Java类型对象返回,如果http状态码不是2xx,直接抛错!* @param id* @return*/@GET("person")Result<Person> getPerson(@Query("id") Long id);
我们也可以通过继承CallAdapter.Factory扩展实现自己的CallAdapter;然后将自定义的CallAdapterFactory配置成spring的bean!
自定义配置的CallAdapter.Factory优先级更高!
数据转码器 Converter
Retrofi使用Converter将@Body注解标注的对象转换成请求体,将响应体数据转换成一个Java对象,可以选用以下几种Converter:
Gson: com.squareup.Retrofit:converter-gson
Jackson: com.squareup.Retrofit:converter-jackson
Moshi: com.squareup.Retrofit:converter-moshi
Protobuf: com.squareup.Retrofit:converter-protobuf
Wire: com.squareup.Retrofit:converter-wire
Simple XML: com.squareup.Retrofit:converter-simplexml
retrofit-spring-boot-starter默认使用的是jackson进行序列化转换!如果需要使用其它序列化方式,在项目中引入对应的依赖,再把对应的ConverterFactory配置成spring的bean即可。
我们也可以通过继承Converter.Factory扩展实现自己的Converter;然后将自定义的Converter.Factory配置成spring的bean!
自定义配置的Converter.Factory优先级更高!
全局拦截器 BaseGlobalInterceptor
如果我们需要对整个系统的的http请求执行统一的拦截处理,可以自定义实现全局拦截器BaseGlobalInterceptor, 并配置成spring中的bean!例如我们需要在整个系统发起的http请求,都带上来源信息。
@Component
public class SourceInterceptor extends BaseGlobalInterceptor {@Overridepublic Response doIntercept(Chain chain) throws IOException {Request request = chain.request();Request newReq = request.newBuilder().addHeader("source", "test").build();return chain.proceed(newReq);}
}
结语
至此,spring-boot项目下最优雅的http客户端工具介绍就结束了,更多详细信息可以参考官方文档:retrofit以及retrofit-spring-boot-starter。
https://github.com/LianjiaTech/retrofit-spring-boot-starter
另
琐碎时间想看一些技术文章,可以去公众号菜单栏翻一翻我分类好的内容,应该对部分童鞋有帮助。同时看的过程中发现问题欢迎留言指出,不胜感谢~。另外,有想多了解哪些方面内容的可以留言(什么时候,哪篇文章下留言都行),附菜单栏截图(PS:很多人不知道公众号菜单栏是什么)
END
我知道你 “在看”
SpringBoot项目整合Retrofit最佳实践,这才是最优雅的HTTP客户端工具!相关推荐
- Spring Boot项目整合Retrofit最佳实践,最优雅的HTTP客户端工具!
点击上方 好好学java ,选择 星标 公众号 重磅资讯.干货,第一时间送达今日推荐:2020年7月程序员工资统计,平均14357元,又跌了,扎心个人原创100W+访问量博客:点击前往,查看更多 转自 ...
- Swagger - SpringBoot整合Swagger最佳实践
总结 Swagger UI部分有两种,一种是官方提供的名为swagger-ui,访问路径为/swagger-ui.html,一种是萧明同学提供的swagger-bootstrap-ui,访问路径为/d ...
- 【信息系统项目管理师】项目管理者的最佳实践
[信息系统项目管理师]项目管理者的最佳实践 1.管理者就是有能力对他人的工作结果负责的人,只能对自己的工作负责的人,水平再高也只能称为专家. 2.末流的管理者认为一切都没有问题,三流的管理者能发现问题 ...
- linux部署vue项目_Vue项目部署的最佳实践
点击上方"前端教程",选择"星标" 每天前端开发干货第一时间送达! 作者:沉末_ juejin.im/post/5eb2243e51882555d8457833 ...
- angular项目打包_vue项目部署的最佳实践
前言 使用vue.react.angular等技术开发过程中,我们都会遇到以下问题: 首屏加载慢 每一次更新都需要清除浏览器缓存才能看到效果(经常被测试吐槽) 这两个问题可以从很多方面进行优化,今天我 ...
- 云效飞流Flow项目版本管理的最佳实践
简介:飞流Flow的最佳实践(使用阿里云云效)为了更好地使用飞流Flow,接下来将结合阿里云云效来讲解飞流Flow的最佳实践 目录 一.分支规约 二.版本号规约 2.1 主版本号(首位版本号) 2.2 ...
- 项目版本管理的最佳实践:云效飞流Flow篇
简介: 飞流Flow的最佳实践(使用阿里云云效)为了更好地使用飞流Flow,接下来将结合阿里云云效来讲解飞流Flow的最佳实践 目录 一.分支规约 二.版本号规约 2.1 主版本号(首位版本号) 2. ...
- Docker 部署 SpringBoot 项目整合 Redis 镜像做访问计数Demo
Docker 部署SpringBoot项目整合 Redis 镜像做访问计数Demo 最终效果如下 大概就几个步骤 1.安装 Docker CE 2.运行 Redis 镜像 3.Java 环境准备 4. ...
- springboot项目整合mybatis
SpringBoot项目整合mybatis 本章内容 使用 idea创建 SpringBoot项目 SpringBoot项目中配制 mybatis 框架 1 创建 SpringBoot项目 1.1 在 ...
最新文章
- 面向对象模型的四种核心技术
- 2021河北省高考成绩查询步骤,河北省2021年普通高校招生考试和录取工作实施方案解读...
- java实现短信验证码发送(架子是springboot 服务平台选择腾讯云短信服务)
- 【.Net】C#实现多线程的方式:使用Parallel类
- cygwin不支持__malloc_hook
- 如何确定C语言中数组的大小?
- CentOS6.5 调整 /home 挂载 分区大小
- STM32串口printf调试输出(SSCOM V5.13.1)
- 红米note7android10,红米Note7 Pro 安卓10.0原生刷机包(最新固件升级包lineage17.1)
- 计算机如何通过手机连接网络打印机,手机连接电脑打印机怎么设置
- 计算机专业找工作面试面经总结
- 【Android】面试宝典
- PHP叫号系统,排队叫号系统
- 解锁图案-九宫格有多少种组合?安全吗?用程序来解答
- oobar, foo, bar, baz和qux搅屎棍的含义
- 小学生心算CAI系统
- 转载新闻 你应该知道的一些 Linux 技巧
- python 词库 匹配_python从一段文本中找出存在于词库的词语
- php 截取逗号前字符串,php如何截取逗号之前的字符
- 论文参考文献中括号+数字转上标
热门文章
- 停机断网也能充话费了!微信和三大运营商打造绿色通道:太方便了!
- 苹果CEO库克改名字了?都是因为他...
- 阿里影业正式成为阿里集团子公司 俞永福辞任执行董事
- 疑似华为P30 Pro样张曝光:10倍变焦依然清晰
- 常用的sql语句用法
- 英语发音表及读法_用英语给孩子讲绘本:果酱英语的Good Morning
- Framework学习(一)深入Android 系统架构
- python 实例 cadu_【示例详解】AutoCAD处理控件Aspose.CAD 8月新更!支持加载大型DWG文件...
- 传感器为什么在低量程偏差大_传感器作业
- 【java】Thread.start 它是怎么让线程启动的呢