Spring Boot 中的 RestTemplate不好用?试试 Retrofit !
点击上方“方志朋”,选择“设为星标”
回复”666“获取新整理的面试文章
作者 | 六点半起床
来源 | 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
热门内容:为什么建议大家使用 Linux 开发?爽(外加七个感叹号)
如何保证缓存与数据库的双写一致性?永远不要在代码中使用「User」这个单词!
丢弃掉那些BeanUtils工具类吧,MapStruct真香!!!
一款直击痛点的优秀http框架,让我超高效率完成了和第三方接口的对接总在说SpringBoot内置了tomcat启动,那它的原理你说的清楚吗?最近面试BAT,整理一份面试资料《Java面试BAT通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
明天见(。・ω・。)ノ
Spring Boot 中的 RestTemplate不好用?试试 Retrofit !相关推荐
- Spring Boot 中的 RestTemplate 不好用?试试 Retrofit!
大家都知道okhttp是一款由square公司开源的java版本http客户端工具.实际上,square公司还开源了基于okhttp进一步封装的retrofit工具,用来支持通过接口的方式发起http ...
- 【spring boot】使用RestTemplate调用微信code2Session接口
前言 spring boot 2.1.1.RELEASE 使用RestTemplate调用微信code2Session接口 spring boot中使用RestTemplate,参考这里. 调用方法 ...
- 【spring boot】使用RestTemplate调用百度坐标转换服务
前言 spring boot 2.0.0.RELEASE http://api.map.baidu.com/geoconv/v1/?coords=114.21892734521,29.57542977 ...
- Spring Boot中使用时序数据库InfluxDB
除了最常用的关系数据库和缓存之外,之前我们已经介绍了在Spring Boot中如何配置和使用MongoDB.LDAP这些存储的案例.接下来,我们继续介绍另一种特殊的数据库:时序数据库InfluxDB在 ...
- Spring Boot中使用MongoDB数据库
MongoDB简介 MongoDB是一个基于分布式文件存储的数据库,它是一个介于关系数据库和非关系数据库之间的产品,其主要目标是在键/值存储方式(提供了高性能和高度伸缩性)和传统的RDBMS系统(具有 ...
- Spring Boot中使用Swagger CodeGen生成REST client
文章目录 什么是Open API规范定义文件呢? 生成Rest Client 在Spring Boot中使用 API Client 配置 使用Maven plugin 在线生成API Spring B ...
- 使用Spring Security在Spring Boot中进行缓存
在这篇文章中,我想分享一下O&B的一个团队的经验教训. 他们正在使用带有Spring Security的Spring Boot. 默认情况下,Spring Security保护的所有内容都将通 ...
- 在Spring Boot中实现相关ID(用于SOA /微服务中的分布式跟踪)
上周参加了在Geecon上Sam Newman的微服务讨论后,我开始思考更多有关用于监视,报告和诊断的面向服务/微服务平台最可能的基本功能:相关ID. 关联ID允许在面向服务的复杂平台中进行分布式跟踪 ...
- Spring Boot中使用MyBatis注解配置详解
之前在Spring Boot中整合MyBatis时,采用了注解的配置方式,相信很多人还是比较喜欢这种优雅的方式的,也收到不少读者朋友的反馈和问题,主要集中于针对各种场景下注解如何使用,下面就对几种常见 ...
最新文章
- U3D 动态创建Prefab的多个实例
- HashCode和equal方法
- Jerry带您了解Restful ABAP Programming模型系列之二:Action和Validation的实现
- 如何撰写较受欢迎的技术文章
- python捕获异常装饰器_python异常装饰器--比较全的版本了
- 关键字 : this /self / parent
- Alibaba内网内部资料真香 -Spring手册太全了,
- Sentry 前端日志上报使用
- Python喜马拉雅有声小说音频文件爬虫
- linux-rm -f如何恢复
- 服务器IMM2实战介绍
- 2021面试第二弹来袭
- 【若泽大数据】MySQL参数详解
- wifi 无线网一会存在,一会消失,安装驱动也没用(笔记本)
- 【Android 开发】SufaceView自定义相机拍照
- 优秀班组长分享:生产车间管理技巧
- 漏洞复现-Redis
- 用通俗易懂的方式讲解:CatBoost 算法原理及案例
- Android URL Scheme的学习和使用
- Kinect V1结构光激光散斑原理及样式
热门文章
- 第十八章 MySQL Workbench5.2使用(待续)
- 事件流--事件冒泡现象及阻止
- Browser Security-超文本标记语言(HTML)
- java学习之匿名内部类与包装类
- 【转载】全面理解javascript的caller,callee,call,apply概念(修改版)
- 7. Query Expressions(查询表达式)
- 刻意练习:LeetCode实战 -- Task13. 罗马数字转整数
- 鼠标按键获取感兴趣区域 2
- GitHub怎样fork别人代码到自己仓库并进行贡献
- 【Codeforces】158B-Taxi(贪心,怎么贪咧)