自研FeignClient轻量级http客户端

自研FeignClient轻量级http客户端

一. 为什么会想到编写此项目

1. 背景

在工作中,经常会遇到与其他业务系统进行通讯交互,无非是通过调用对方的http接口进行数据的交互,少则一个,多则几十个。

随着Oauth2.0协议在各个业务系统的应用,调用其他业务系统的方式也是千篇一律:首先通过对方颁发的客户端信息进行客户端认证,认证通过之后获取accessToken,随后所有业务接口携带accessToken调用接口。一些安全性较高的系统,还会增加一些加解密、验签、完整性、证书的验证。

当前大部分思路是通过开发各个接口调用逻辑功能,然后通过统一封装http调用工具进行接口调用,整个代码会显得特别臃肿,同时最近在读feign源码,因此仿照feign客户端进行代码改造,旨在优化业务代码,同时也加深对feign的理解。

2. 改造后的代码示例

只需要按照接口出入参拼接实体类,再接口中维护接口信息即可。一些公共的接口调用逻辑,在动态代理的InvocationHandler中统一进行处理(序列化、反序列化、远程接口调用、异常处理等等)。
同时该部分代码单独打包成jar包,易于维护及管理。

@InvokeClient(value = "/v1/api",
		name = "requestClient",
		configuration = {RemoteCallConfig.class})
public interface RequestClient {
	@InvokeRequest(value = "/queryUser",method = HttpMethod.POST)
	@BreakerCommand(fallback = RequestClientFallback.class)
	public ResponseDto<User> queryUser(User user);
}

3. 能够实现什么功能

  • 基础远程调用【已完成】
  • 重试机制【已完成】
  • 熔断机制【已完成】
  • 自定义配置类及客户段配置类之间的隔离【已完成】
  • 自定义请求拦截器【已完成】
  • 隔离策略(线程池及信号量)

4.项目地址

项目地址:https://github.com/beardlessCat/simple-remote-call,喜欢的烦请star

三.版本规划

1.0.x

该版本一些远程客户端的声明都必须在client包内,这样设计的初始目的主要是想规范将客户端的声明与客户端的调用区分开,使得代码更加的整洁已于管理。有需要改动时仅仅调整client包即可,
无需调整引入该包的相关代码。但是此种方式生成的依赖包仅仅能够供某一特定系统进行使用,系统兼容性较差。

2.0.x

该版本建议将客户端的声明存放到引入该包的模块或系统中,这样的话,client包仅仅作为远程调用的工具,客户端的声明需在引入该包的模块或者系统中自行声明,
优劣势与1.0.x相反,同时这种方式也是openfeign的模式。后续的一些维护及升级也是主要基于此版本。

四.功能原理

整个功能要实现最主要需要完成两点:远程调用client自动注入及动态代理生成生成客户端实现类进行远程调用处理。当这两个点完成后,其他的就剩下一下
代理逻辑的处理了。

1. openFeign原理

Alt text

2.接口熔断机制

通过接口熔断管理器管理接口状态,对接口进行熔断保护
(1)接口状态说明
接口基于断路器状态分为三种:OPEN,HAlf-OPEN,CLOSE

  • CLOSE:熔断器处于关闭状态,接口可正常调用;
  • HAlf-OPEN:熔断器处于半关闭状态,此时回对部门请求进行尝试调用,根据调用结果改变状态。
  • OPEN:熔断器处于开启状态,此时所有请求均不再调用接口,而是直接返回接口熔断信息。

(2)接口状态变更转换图
Alt text

  • CLOSE转换为OPEN:接口调用失败次数达到阈值
  • OPEN转换为HALF_OPEN:接口熔断时间达到阈值
  • HALF_OPEN转换为CLOSE:接口成功次数达到阈值
  • HALF_OPEN转换为OPEN:接口失败次数达到阈值

(3)接口状态流程图
Alt text

(4)熔断器测试日志

: 【断路器变为CLOSE】
: BreakerStateManager(failCount=0, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@43b23436)
: 接口调用失败!
: BreakerStateManager(failCount=1, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@43b23436)
: 接口调用失败!
: BreakerStateManager(failCount=2, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@43b23436)
: 接口调用失败!
: BreakerStateManager(failCount=3, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@43b23436)
: 接口调用失败!
: BreakerStateManager(failCount=4, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@43b23436)
: 接口调用失败!
===============================================================================================
: 【断路器变为OPEN】
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@189436cd)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@189436cd)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@189436cd)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@189436cd)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@189436cd)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: 【断路器变为HALF-OPEN】
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
: 接口调用失败!
: BreakerStateManager(failCount=6, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=1, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
: 接口调用失败!
: BreakerStateManager(failCount=7, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=2, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
: 接口调用失败!
: BreakerStateManager(failCount=8, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=3, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=8, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=3, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=8, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=3, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
: 接口调用失败!
: BreakerStateManager(failCount=9, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=4, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@4cef79fb)
: 接口调用失败!
: 【断路器变为OPEN】
: BreakerStateManager(failCount=10, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@485fb0e8)
: 【断路器变为HALF-OPEN】
: BreakerStateManager(failCount=10, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
: BreakerStateManager(failCount=10, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
: BreakerStateManager(failCount=10, successCount=3, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
: BreakerStateManager(failCount=10, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=10, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@6bb3d520)
===============================================================================================
: 【断路器变为CLOSE】
: BreakerStateManager(failCount=0, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: BreakerStateManager(failCount=0, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: BreakerStateManager(failCount=0, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: BreakerStateManager(failCount=0, successCount=3, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: BreakerStateManager(failCount=0, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: 接口调用失败!
: BreakerStateManager(failCount=1, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: 接口调用失败!
: BreakerStateManager(failCount=2, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: 接口调用失败!
: BreakerStateManager(failCount=3, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: 接口调用失败!
: BreakerStateManager(failCount=4, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@44348bd0)
: 接口调用失败!
===============================================================================================
: 【断路器变为OPEN】
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.OpenState@2e97b6dc)
===============================================================================================
: 【断路器变为HALF-OPEN】
: BreakerStateManager(failCount=5, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@5143c073)
com.bigyj.exception.MethodNotAvailableException: 服务已熔断,请稍等重试!
: BreakerStateManager(failCount=5, successCount=1, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@5143c073)
: BreakerStateManager(failCount=5, successCount=2, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@5143c073: BreakerStateManager(failCount=5, successCount=3, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@5143c073)
: BreakerStateManager(failCount=5, successCount=4, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.HalfOpenState@5143c073)
===============================================================================================
: 【断路器变为CLOSE】
: BreakerStateManager(failCount=0, successCount=0, maxOpenToTryTime=60000, maxFailCount=5, maxSuccessCount=5, openRetryCount=0, maxOpenRetryCount=5, breakerState=com.bigyj.breaker.state.ClosedState@7236669a)

3. 远程调用client自动注入

通过ImportBeanDefinitionRegistrar进行依赖注入

public class ClientBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware {
	private Environment environment;
	private ResourceLoader resourceLoader;

	/**
     * 自动注入相关类
	 * @param importingClassMetadata
	 * @param registry
	 */
	@Override
	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
	}
	@Override
	public void setEnvironment(Environment environment) {
		this.environment = environment ;
	}

	@Override
	public void setResourceLoader(ResourceLoader resourceLoader) {
		this.resourceLoader = resourceLoader ;
	}
}

4. 动态代理生成客户端实现类

通过自定义FactoryBean,在getObject方法中使用代理模式,动态生成相关类

public class InvokeClientFactoryBean implements FactoryBean<Object>, ApplicationContextAware {
	private ApplicationContext applicationContext ;
	@Setter
	private Class<?> type;
	@Setter
	private String path;
	/**
	 * 生成代理对象
	 * @return
	 * @throws Exception
	 */
	@Override
	public Object getObject() {
		return Proxy.newProxyInstance(type.getClassLoader(), new Class<?>[]{type}, invocationHandler);
	}

	@Override
	public Class<?> getObjectType() {
		return this.type;
	}

	@Override
	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
		this.applicationContext = applicationContext;
	}
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值