因此#xff0c;在这里推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架retrofit-spring-boot-starter#xff0c;使用非常简单方便#xff0c;同时又提供…

在SpringBoot项目直接使用okhttp、httpClient或者RestTemplate发起HTTP请求既繁琐又不方便统一管理。

因此在这里推荐一个适用于SpringBoot项目的轻量级HTTP客户端框架retrofit-spring-boot-starter使用非常简单方便同时又提供诸多功能增强

Retrofit是适用于Android和Java且类型安全的HTTP客户端其最大的特性的是支持通过接口的方式发起HTTP请求

。

而spring-boot是使用最广泛的Java开发框架但是Retrofit官方没有支持与spring-boot框架快速整合因此我们开发了retrofit-spring-boot-starter。

retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合并且支持了诸多功能增强极大简化开发

功能特性

自定义注入OkHttpClient注解式拦截器连接池管理日志打印请求重试错误解码器全局拦截器熔断降级微服务之间的HTTP调用调用适配器数据转换器

快速使用

dependencygroupIdcom.github.lianjiatech/groupIdartifactIdretrofit-spring-boot-starter/artifactIdversion2.2.2/version

/dependency定义http接口

http相关注解可参考官方文档retrofit官方文档https://square.github.io/retrofit/

${test.baseUrl})

HTTP请求相关注解全部使用了retrofit原生注解。

详细信息可参考官方文档retrofit官方文档

注解分类

QueryNamepath参数Pathform-encoded参数Field

FieldMap

retrofit-spring-boot-starter支持了多个可配置的属性用来应对不同的业务场景。

您可以视情况进行修改具体说明如下

默认值

retrofit:enable-response-call-adapter:

true#

连接池配置pool:test1:max-idle-connections:

3keep-alive-second:

禁用void返回值类型disable-void-return-type:

false#

com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor#

com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor#

全局转换器工厂global-converter-factories:-

retrofit2.converter.jackson.JacksonConverterFactory#

全局调用适配器工厂global-call-adapter-factories:-

com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory-

com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory#

true#

com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser高级功能

自定义注入OkHttpClient

通常情况下通过RetrofitClient注解属性动态创建OkHttpClient对象能够满足大部分使用场景。

但是在某些情况下用户可能需要自定义OkHttpClient这个时候可以在接口上定义返回类型是OkHttpClient.Builder的静态方法来实现。

代码示例如下

http://ke.com)

OkHttpClient.Builder().connectTimeout(1,

TimeUnit.SECONDS).readTimeout(1,

TimeUnit.SECONDS).writeTimeout(1,

TimeUnit.SECONDS);}GETResultPerson

getPerson(Url

很多时候我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。

为了支持这个功能retrofit-spring-boot-starter提供了注解式拦截器

1.继承BasePathMatchInterceptor编写拦截处理器

2.接口上使用Intercept进行标注。

如需配置多个拦截器在接口上标注多个Intercept注解即可

下面以给指定请求的url后面拼接timestamp时间戳为例介绍下如何使用注解式拦截器。

继承BasePathMatchInterceptor编写拦截处理器

Component

System.currentTimeMillis();HttpUrl

newUrl

url.newBuilder().addQueryParameter(timestamp,

String.valueOf(timestamp)).build();Request

newRequest

request.newBuilder().url(newUrl).build();return

}接口上使用Intercept进行标注

id);POST(savePerson)ResultPerson

savePerson(Body

}上面的Intercept配置表示拦截HttpApi接口下/api/**路径下排除/api/test/savePerson的请求拦截处理器使用TimeStampInterceptor。

扩展注解式拦截器

动态传入一些参数然后再执行拦截的时候需要使用这个参数。

这种时候我们可以扩展实现自定义拦截注解

。

自定义拦截注解必须使用InterceptMark标记并且注解中必须包括include()、exclude()、handler()属性信息

自定义拦截注解继承BasePathMatchInterceptor编写拦截处理器接口上使用自定义拦截注解

例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求

自定义Sign注解

Retention(RetentionPolicy.RUNTIME)

Documented

优先从spring容器获取对应的Bean如果获取不到则使用反射创建一个**

return*/Class?

自定义拦截注解必须使用InterceptMark标记注解中必须包括include()、exclude()、handler()属性信息。

实现SignInterceptor

accessKeySecret;}Overridepublic

Response

request.newBuilder().addHeader(accessKeyId,

accessKeyId).addHeader(accessKeySecret,

accessKeySecret).build();return

}上述accessKeyId和accessKeySecret字段值会依据Sign注解的accessKeyId()和accessKeySecret()值自动注入如果Sign指定的是占位符形式的字符串则会取配置属性值进行注入

。

另外accessKeyId和accessKeySecret字段必须提供setter方法

接口上使用Sign

id);POST(savePerson)ResultPerson

savePerson(Body

默认情况下所有通过Retrofit发送的http请求都会使用max-idle-connections5

keep-alive-second300的默认连接池。

当然我们也可以在配置文件中配置多个自定义的连接池然后通过RetrofitClient的poolName属性来指定使用。

比如我们要让某个接口下的请求全部使用poolNametest1的连接池代码实现如下

retrofit:#

连接池配置pool:test1:max-idle-connections:

3keep-alive-second:

502、通过RetrofitClient的poolName属性来指定使用的连接池。

${test.baseUrl},

很多情况下我们希望将http请求日志记录下来。

通过retrofit.enableLog配置可以全局控制日志是否开启。

针对每个接口可以通过RetrofitClient的enableLog控制是否开启通过logLevel和logStrategy可以指定每个接口的日志打印级别以及日志打印策略。

retrofit-spring-boot-starter支持了5种日志打印级别(ERROR,

WARN,

retrofit-spring-boot-starter默认使用了DefaultLoggingInterceptor执行真正的日志打印功能其底层就是okhttp原生的HttpLoggingInterceptor。

当然你也可以自定义实现自己的日志打印拦截器只需要继承BaseLoggingInterceptor具体可以参考DefaultLoggingInterceptor的实现然后在配置文件中进行相关配置即可。

retrofit:#

com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor请求重试

retrofit-spring-boot-starter支持请求重试功能只需要在接口或者方法上加上Retry注解即可。

Retry支持重试次数maxRetries、重试时间间隔intervalMs以及重试规则retryRules配置

RESPONSE_STATUS_NOT_2XX响应状态码不是2xx时执行重试OCCUR_IO_EXCEPTION发生IO异常时执行重试OCCUR_EXCEPTION发生任意异常时执行重试

默认响应状态码不是2xx或者发生IO异常时自动进行重试。

需要的话你也可以继承BaseRetryInterceptor实现自己的请求重试拦截器然后将其配置上去。

retrofit:#

com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor错误解码器

在HTTP发生请求错误(包括发生异常或者响应数据不符合预期)的时候错误解码器可将HTTP相关信息解码到自定义异常中。

你可以在RetrofitClient注解的errorDecoder()指定当前接口的错误解码器自定义错误解码器需要实现ErrorDecoder接口

/***

当请求发生异常或者收到无效响应结果的时候将HTTP相关信息解码到异常中无效响应由业务自己判断**

When

当无效响应的时候将HTTP信息解码到异常中无效响应由业务自行判断。

*

When

RetrofitException.errorStatus(request,

response);}return

RetrofitException.errorExecuting(request,

cause);}/***

当请求发生除IO异常之外的其它异常时将HTTP信息解码到异常中。

*

When

RetrofitException.errorUnknown(request,

cause);}}全局拦截器

如果我们需要对整个系统的的http请求执行统一的拦截处理可以自定义实现全局拦截器BaseGlobalInterceptor,

并配置成spring容器中的bean例如我们需要在整个系统发起的http请求都带上来源信息。

Component

request.newBuilder().addHeader(source,

test).build();return

如果我们需要对整个系统的的http请求执行统一的拦截处理可以自定义实现全局拦截器BaseGlobalInterceptor,

并配置成spring容器中的bean例如我们需要在整个系统发起的http请求都带上来源信息。

Component

request.newBuilder().addHeader(source,

test).build();return

并配置成spring容器中的bean就支持自动织入全局网络拦截器。

熔断降级

在分布式服务架构中对不稳定的外部服务进行熔断降级是保证服务高可用的重要措施之一。

由于外部服务的稳定性是不能保证的当外部服务不稳定时响应时间会变长。

相应地调用方的响应时间也会变长线程会产生堆积最终可能耗尽调用方的线程池导致整个服务不可用。

因此我们需要对不稳定的弱依赖服务调用进行熔断降级暂时切断不稳定调用避免局部不稳定导致整体服务雪崩。

retrofit-spring-boot-starter支持熔断降级功能底层基于Sentinel实现。

具体来说支持了熔断资源自发现

和注解式降级规则配置

默认情况下熔断降级功能是关闭的需要设置相应的配置项来开启熔断降级功能

retrofit:#

熔断降级实现方式(目前仅支持Sentinel)degrade-type:

sentinel#

com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser资源名称解析器用于实现用户自定义资源名称默认配置是DefaultResourceNameParser对应的资源名称格式为HTTP_OUT:GET:http://localhost:8080/api/degrade/test。

用户可以继承BaseResourceNameParser类实现自己的资源名称解析器。

另外由于熔断降级功能是可选的因此启用熔断降级需要用户自行引入Sentinel依赖

dependencygroupIdcom.alibaba.csp/groupIdartifactIdsentinel-core/artifactIdversion1.6.3/version

/dependency2.

retrofit-spring-boot-starter支持注解式配置降级规则通过Degrade注解来配置降级规则

。

Degrade注解可以配置在接口或者方法上配置在方法上的优先级更高。

Retention(RetentionPolicy.RUNTIME)

ElementType.TYPE})

}如果应用项目已支持通过配置中心配置降级规则可忽略注解式配置方式

RetrofitClient设置fallback或者fallbackFactory

如果RetrofitClient不设置fallback或者fallbackFactory当触发熔断时会直接抛出RetrofitBlockException异常。

用户可以通过设置fallback或者fallbackFactory来定制熔断时的方法返回值

。

fallback类必须是当前接口的实现类fallbackFactory必须是FallbackFactory实现类泛型参数类型为当前接口类型。

另外fallback和fallbackFactory实例必须配置成Spring容器的Bean。

fallbackFactory相对于fallback主要差别在于能够感知每次熔断的异常原因(cause)

Slf4j

Result();fallback.setCode(100).setMsg(fallback).setBody(1000000);return

fallback;}

Result();fallback.setCode(100).setMsg(fallback).setBody(1000000);return

fallback;}}

配置ServiceInstanceChooser为Spring容器Bean

用户可以自行实现ServiceInstanceChooser接口完成服务实例的选取逻辑并将其配置成Spring容器的Bean。

对于Spring

Cloud应用retrofit-spring-boot-starter提供了SpringCloudServiceInstanceChooser实现用户只需将其配置成Spring的Bean即可。

Bean

serviceInstanceChooser(LoadBalancerClient

loadBalancerClient)

SpringCloudServiceInstanceChooser(loadBalancerClient);

}使用Retrofit的serviceId和path属性可以实现微服务之间的HTTP调用

${jy-helicarrier-api.serviceId},

path

Retrofit可以通过调用适配器CallAdapterFactory将Call对象适配成接口方法的返回值类型。

retrofit-spring-boot-starter扩展2种CallAdapterFactory实现

BodyCallAdapterFactory默认启用可通过配置retrofit.enable-body-call-adapterfalse关闭同步执行http请求将响应体内容适配成接口方法的返回值类型实例。

除了Retrofit.Call、Retrofit.Response、java.util.concurrent.CompletableFuture之外其它返回类型都可以使用该适配器。

ResponseCallAdapterFactory默认启用可通过配置retrofit.enable-response-call-adapterfalse关闭

同步执行http请求将响应体内容适配成Retrofit.Response返回。

如果方法的返回值类型为Retrofit.Response则可以使用该适配器。

Retrofit自动根据方法返回值类型选用对应的CallAdapterFactory执行适配处理加上Retrofit默认的CallAdapterFactory可支持多种形式的方法返回值类型

Call:

不关注返回类型可以使用Void。

如果http状态码不是2xx直接抛错

Response:

其他任意Java类型将响应体内容适配成一个对应的Java类型对象返回如果http状态码不是2xx直接抛错

/***

return*/GET(person)CallResultPerson

Long

将响应体内容适配成CompletableFutureT对象返回*

param

return*/GET(person)CompletableFutureResultPerson

getPersonCompletableFuture(Query(id)

Long

不关注返回类型可以使用Void。

如果http状态码不是2xx直接抛错*

param

return*/GET(person)ResponseResultPerson

Long

将响应体内容适配成一个对应的Java类型对象返回如果http状态码不是2xx直接抛错*

param

return*/GET(person)ResultPerson

getPerson(Query(id)

id);我们也可以通过继承CallAdapter.Factory扩展实现自己的CallAdapter

retrofit-spring-boot-starter支持通过retrofit.global-call-adapter-factories配置全局调用适配器工厂工厂实例优先从Spring容器获取如果没有获取到则反射创建。

默认的全局调用适配器工厂是[BodyCallAdapterFactory,

retrofit:#

全局调用适配器工厂global-call-adapter-factories:-

com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory-

com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory针对每个Java接口还可以通过RetrofitClient注解的callAdapterFactories()指定当前接口采用的CallAdapter.Factory指定的工厂实例依然优先从Spring容器获取。

注意如果CallAdapter.Factory没有public的无参构造器请手动将其配置成Spring容器的Bean对象

数据转码器

Retrofit使用Converter将Body注解标注的对象转换成请求体将响应体数据转换成一个Java对象可以选用以下几种Converter

Gson:

com.squareup.Retrofit:converter-gsonJackson:

com.squareup.Retrofit:converter-jacksonMoshi:

com.squareup.Retrofit:converter-moshiProtobuf:

com.squareup.Retrofit:converter-protobufWire:

com.squareup.Retrofit:converter-wireSimple

XML:

com.squareup.Retrofit:converter-simplexmlJAXB:

com.squareup.retrofit2:converter-jaxb

retrofit-spring-boot-starter支持通过retrofit.global-converter-factories配置全局数据转换器工厂转换器工厂实例优先从Spring容器获取如果没有获取到则反射创建。

默认的全局数据转换器工厂是retrofit2.converter.jackson.JacksonConverterFactory你可以直接通过spring.jackson.*配置jackson序列化规则配置可参考Customize

***

全局转换器工厂global-converter-factories:-

retrofit2.converter.jackson.JacksonConverterFactory针对每个Java接口还可以通过RetrofitClient注解的converterFactories()指定当前接口采用的Converter.Factory指定的转换器工厂实例依然优先从Spring容器获取。

注意如果Converter.Factory没有public的无参构造器请手动将其配置成Spring容器的Bean对象

retrofit-spring-boot-starter一个适用于SpringBoot项目的轻量级HTTP客户端框架已在线上稳定运行一年多并且已经有多个外部公司也接入使用。

github项目地址https://github.com/LianjiaTech/retrofit-spring-boot-starter

gitee项目地址https://gitee.com/lianjiatech/retrofit-spring-boot-starter