在SpringBoot项目直接使用okhttp、httpClient或者RestTemplate发起HTTP请求,既繁琐又不方便统一管理。因此,在这里推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架retrofit-spring-boot-starter,使用非常简单方便,同时又提供诸多功能增强。目前项目已经更新至2.2.2版本,并且会持续进行迭代优化。
github项目地址:github.com/LianjiaTech…
gitee项目地址:gitee.com/lianjiatech…
前言
Retrofit是适用于Android和Java且类型安全的HTTP客户端,其最大的特性的是支持通过接口的方式发起HTTP请求。而spring-boot是使用最广泛的Java开发框架,但是Retrofit官方没有支持与spring-boot框架快速整合,因此我们开发了retrofit-spring-boot-starter。
retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合,并且支持了诸多功能增强,极大简化开发。
🚀项目持续优化迭代,欢迎大家提ISSUE和PR!麻烦大家能给一颗star✨,您的star是我们持续更新的动力!
功能特性
自定义注入OkHttpClient
注解式拦截器
连接池管理
日志打印
请求重试
错误解码器
全局拦截器
熔断降级
微服务之间的HTTP调用
调用适配器
数据转换器
快速使用
引入依赖
定义http接口
接口必须使用@RetrofitClient注解标记!http相关注解可参考官方文档:retrofit官方文档。
注入使用
将接口注入到其它Service中即可使用!
HTTP请求相关注解
HTTP
请求相关注解,全部使用了retrofit
原生注解。详细信息可参考官方文档:retrofit官方文档,以下是一个简单说明。
配置项说明
retrofit-spring-boot-starter
支持了多个可配置的属性,用来应对不同的业务场景。您可以视情况进行修改,具体说明如下:
yml配置方式:
高级功能
自定义注入OkHttpClient
通常情况下,通过@RetrofitClient注解属性动态创建OkHttpClient对象能够满足大部分使用场景。但是在某些情况下,用户可能需要自定义OkHttpClient,这个时候,可以在接口上定义返回类型是OkHttpClient.Builder的静态方法来实现。代码示例如下:
方法必须使用@OkHttpClientBuilder注解标记!
注解式拦截器
很多时候,我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。为了支持这个功能,retrofit-spring-boot-starter提供了注解式拦截器,做到了基于url路径的匹配拦截。使用的步骤主要分为2步:
1.继承BasePathMatchInterceptor编写拦截处理器;
2.接口上使用@Intercept进行标注。如需配置多个拦截器,在接口上标注多个@Intercept注解即可!
下面以给指定请求的url后面拼接timestamp时间戳为例,介绍下如何使用注解式拦截器。
继承BasePathMatchInterceptor编写拦截处理器
接口上使用@Intercept进行标注
上面的@Intercept配置表示:拦截HttpApi接口下/api/**路径下(排除/api/test/savePerson)的请求,拦截处理器使用TimeStampInterceptor。
扩展注解式拦截器
有的时候,我们需要在拦截注解动态传入一些参数,然后再执行拦截的时候需要使用这个参数。这种时候,我们可以扩展实现自定义拦截注解。自定义拦截注解必须使用@InterceptMark标记,并且注解中必须包括include()、exclude()、handler()属性信息。使用的步骤主要分为3步:
- 自定义拦截注解
- 继承BasePathMatchInterceptor编写拦截处理器
- 接口上使用自定义拦截注解;
例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求,这个时候可以自定义一个加签拦截器注解@Sign来实现。下面以自定义@Sign拦截注解为例进行说明。
自定义@Sign注解
扩展自定义拦截注解有以下2点需要注意:
- 自定义拦截注解必须使用@InterceptMark标记。
- 注解中必须包括include()、exclude()、handler()属性信息。
实现SignInterceptor
上述accessKeyId和accessKeySecret字段值会依据@Sign注解的accessKeyId()和accessKeySecret()值自动注入,如果@Sign指定的是占位符形式的字符串,则会取配置属性值进行注入。另外,accessKeyId和accessKeySecret字段必须提供setter方法。
接口上使用@Sign
这样就能在指定url的请求上,自动加上签名信息了。