Feign 集成 Hystrix实现不同的调用接口不同的设置方式
作者:帆影匆匆
问题描述
小编在写项目时遇到一个需求:
假设现在有三个项目A、B、C,其中A、B作为服务提供方,C作为调用方,需要实现C在调用A、B时实现不同的超时时间,比如C调用A时超时是2s,调用B时超时是3s。。。。
本来以为是很简单的事,但是面向百度编程时发现没有搜索到,官网也没有,这就难受了,小编属于那种不会主动研究源码的,都是项目有需要或者说看到别人改造了啥玩意特别有意思,否则都不去喵一眼,现在没办法只能研究一波源码,手动改造。
正文
正文分为三个部分描述
- 源码研究
- 提出方案
- 方案实现
源码研究
先说说如果找到关键的源代码,如果对hystrix feign 集成比较熟悉的朋友,可以略过,直接看方案,如果希望知道源码怎么走的朋友建议看下,这个花了我挺长时间的,网上的源码解析都是只有关键代码展示,但是具体细节怎么走,没有描述,要不然我也不会花很长时间进行研究阅读。
Hystrix、feign 简单介绍
首先我们知道 feign 是spring cloud 中用来进行服务之间的调用,openFeign 当中集成了 ribbon实现了负载均衡的实际的请求
Hystrix是个熔断器,就是在某些任务执行时及时的失败返回而不是挂着线程,造成服务器的级联瘫痪,feign在进行微服务之间调用时如果出现了服务超时,Hystrix进行熔断,立马返回结果。
关键代码
如果大家上网去搜 Hystrix 超时配置,应该都是这样
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=3000
那么 Hystrix 组件工作时肯定需要解析这个配置,调用它
spring boot 配置有个特点,命名方式都是 {组件名}Properties 这种形式,那么搜索下就找到了关键的配置类
com.netflix.hystrix.HystrixCommandProperties
可以看到这里属性都是final,就是说不能set,那么只有构造函数或者静态代码块可以改,后者明显不合适,找找构造方法就能看到
这就很像了嘛!随便点一个进去看
private static HystrixProperty<Boolean> getProperty(String propertyPrefix, HystrixCommandKey key, String instanceProperty, Boolean builderOverrideValue, Boolean defaultValue) { return forBoolean() .add(propertyPrefix + ".command." + key.name() + "." + instanceProperty, builderOverrideValue) .add(propertyPrefix + ".command.default." + instanceProperty, defaultValue) .build(); }
像不像拼接上面配置,那么关键是这个 HystrixCommandKey 怎么传进来的问题,这时候打个断点就行,启动项目,进行调用
这时候就有调用方法栈了,可以直接看 invoke:104, HystrixInvocationHandler (feign.hystrix)
@Override public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable { ............. // setterMethodMap 封装 hystrixCommand 配置信息(超时时间、是否重试.....) HystrixCommand<Object> hystrixCommand = new HystrixCommand<Object>(setterMethodMap.get(method)) { @Override protected Object run() throws Exception { .... HystrixInvocationHandler.this.dispatch.get(method).invoke(args); .... } @Override protected Object getFallback() { ......... } }; ...... return hystrixCommand.execute(); }
大致就这样,其实就是用hystrixCommand调用feign,最主要的是 setterMethodMap 从哪里设置的,
final class HystrixInvocationHandler implements InvocationHandler { private final Target<?> target; private final Map<Method, MethodHandler> dispatch; private final FallbackFactory<?> fallbackFactory; // Nullable private final Map<Method, Method> fallbackMethodMap; private final Map<Method, Setter> setterMethodMap; HystrixInvocationHandler(Target<?> target, Map<Method, MethodHandler> dispatch, SetterFactory setterFactory, FallbackFactory<?> fallbackFactory) { this.target = checkNotNull(target, "target"); this.dispatch = checkNotNull(dispatch, "dispatch"); this.fallbackFactory = fallbackFactory; this.fallbackMethodMap = toFallbackMethod(dispatch); this.setterMethodMap = toSetters(setterFactory, target, dispatch.keySet()); } }
一样也是final属性,那么也是构造函数赋值的,一样的打个断点,重新启动下项目
target:56, HystrixTargeter (org.springframework.cloud.openfeign)
看到这里代码 核心部分
// HystrixTargeter 这个类看代码就知道,对应这 @FeignClient 注解的接口 @SuppressWarnings("unchecked") class HystrixTargeter implements Targeter { @Override public <T> T target(FeignClientFactoryBean factory, Feign.Builder feign, FeignContext context, Target.HardCodedTarget<T> target) { ..... feign.hystrix.HystrixFeign.Builder builder = (feign.hystrix.HystrixFeign.Builder) feign; // 这里其实是容器中拿到 SetterFactory 配置类 SetterFactory setterFactory = getOptional(factory.getName(), context, SetterFactory.class); if (setterFactory != null) { builder.setterFactory(setterFactory); } // 从 @FeignClient 注解中读取或者默认 Class<?> fallback = factory.getFallback(); if (fallback != void.class) { return targetWithFallback(factory.getName(), context, target, builder, fallback); } Class<?> fallbackFactory = factory.getFallbackFactory(); if (fallbackFactory != void.class) { return targetWithFallbackFactory(factory.getName(), context, target, builder, fallbackFactory); } return feign.target(target); } ..... private <T> T getOptional(String feignClientName, FeignContext context, Class<T> beanType) { return context.getInstance(feignClientName, beanType); } }
看下 feign.hystrix.SetterFactory
public interface SetterFactory { HystrixCommand.Setter create(Target<?> target, Method method); // 默认实现 final class Default implements SetterFactory { @Override public HystrixCommand.Setter create(Target<?> target, Method method) { String groupKey = target.name(); String commandKey = Feign.configKey(target.type(), method); // HystrixCommandKey、group 赋值 return HystrixCommand.Setter .withGroupKey(HystrixCommandGroupKey.Factory.asKey(groupKey)) .andCommandKey(HystrixCommandKey.Factory.asKey(commandKey)); } } }
看到这里结合上面 HystrixCommandProperties 代码 是不是有点感觉了,就是说关键配置信息的 HystrixCommandKey 是这里指定的
是不是真的,可以验证下,打个断点,然后手动把 commandKey 修改了,然后上面 HystrixCommandProperties 断点处验证就行,我这里不贴代码了
提出方案
那结合代码发现 SetterFactory 这接口是关键,而这又是注入的那么简单了只要我们手动实现这接口并且注入到 spring 容器中就行
在 feign.hystrix.SetterFactory.Default#create 方法中手动实现不同的feign 接口不同的配置,甚至不同的feign
我这里目前是用注解实现的,大家也可以用方法名等规则实现
最终目的就是让指定的feign 方法获取指定的配置
@FeignClient(value = "itemRobot", path = "cloud/device") public interface DeviceApi { @RequestMapping(value = "/login", method = RequestMethod.GET) ServerResponse<String> login(@RequestParam String appId); @RequestMapping(value = "/logout", method = RequestMethod.GET) ServerResponse<String> logout(@RequestParam String appId); }
# login() 方法映射 hystrix.command.login.execution.isolation.thread.timeoutInMilliseconds=10000 # logout() 方法映射 hystrix.command.logout.execution.isolation.thread.timeoutInMilliseconds=10000
如果是基于方法级别的不同配置,hystrix 官方有给这样的注解
com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand
@HystrixCommand(groupKey="accountPayGroup",commandKey="accountPay",threadPoolKey="account",threadPoolProperties= { @HystrixProperty(name="coreSize",value="20"), @HystrixProperty(name="maxQueueSize",value="50") },commandProperties={ @HystrixProperty(name="circuitBreaker.sleepWindowInMilliseconds",value="3000"), @HystrixProperty(name="circuitBreaker.errorThresholdPercentage",value="40") })
ps:我用了发现不生效,目前还在调试,有了进展,再写一篇
但是不能基于feign 调用不同接口实现,所以如果想基于方法实现不同配置用官方这个就行,如果想一个接口下所有方法一样配置,不同接口实现不同,那么用我下面这方式也行。
具体实现
指定注解
@Target({TYPE, METHOD}) @Retention(RUNTIME) public @interface CusHystrixCommandKey { // 对应 commandKey String name(); }
实现 SetterFactory
import com.netflix.hystrix.HystrixCommand; import com.netflix.hystrix.HystrixCommandGroupKey; import com.netflix.hystrix.HystrixCommandKey; import feign.Feign; import feign.Target; import feign.hystrix.SetterFactory; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.stereotype.Component; import java.lang.reflect.Method; @Component public class MyHystrixFactory implements SetterFactory { @Override public HystrixCommand.Setter create(Target<?> target, Method method) { String groupKey = target.name(); String commandKey = Feign.configKey(target.type(), method); CusHystrixCommandKey annotation = method.getAnnotation(CusHystrixCommandKey.class); if (annotation == null) { // 如果指定方法没有 CusHystrixCommandKey 注解,用 FeignClient.value() 作为key FeignClient feignClient = method.getDeclaringClass().getAnnotation(FeignClient.class); commandKey = feignClient.value(); } else { // 否则获取指定的name() 作为key commandKey = annotation.name(); } return HystrixCommand.Setter .withGroupKey(HystrixCommandGroupKey.Factory.asKey(groupKey)) .andCommandKey(HystrixCommandKey.Factory.asKey(commandKey)); } }
测试页面就不贴了,老方法,万能的断点
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。