作者 | Spring Cloud Alibaba 高级开发工程师洛夜
来自公众号阿里巴巴中间件投稿

前段时间 Hystrix 宣布不再维护之后（Hystrix 停止开发。。。Spring Cloud 何去何从？），Feign 作为一个跟 Hystrix 强依赖的组件，必然会有所担心后续的使用。

作为 Spring Cloud Alibaba 体系中的熔断器 Sentinel，Sentinel 目前整合了 Feign，本文对整合过程做一次总结，欢迎大家讨论和使用。

Feign 是什么？

Feign 是一个 Java 实现的 Http 客户端，用于简化 Restful 调用。

Feign 跟 OkHttp、HttpClient 这种客户端实现理念不一样。Feign 强调接口的定义，接口中的一个方法对应一个 Http 请求，调用方法即发送一个 Http 请求；OkHttp 或 HttpClient 以过程式的方式发送 Http 请求。Feign 底层发送请求的实现可以跟 OkHttp 或 HttpClient 整合。

要想整合 Feign，首先要了解 Feign 的使用以及执行过程，然后看 Sentinel 如何整合进去。

Feign 的使用

需要两个步骤：

1、使用

@EnableFeignClients

注解开启 Feign 功能

@SpringBootApplication
@EnableFeignClients // 开启 Feign 功能
public class MyApplication {
...
}

@EnableFeignClients

value:String[] 包路径。比如

org.my.pkg

@FeignClient

basePackages:String[] 跟 value 属性作用一致；

basePackageClasses:Class<?>[] 跟 basePackages 作用一致，basePackages 是个 String 数组，而 basePackageClasses 是个 Class 数组，用于扫描这些类对应的 package；

defaultConfiguration:Class<?>[] 默认的配置类，对于所有的 Feign Client，这些配置类里的配置都会对它们生效，可以在配置类里构造

feign.codec.Decoder

feign.codec.Encoder

feign.Contract

clients:Class<?>[] 表示

@FeignClient

2、使用

@FeignClient

注解修饰接口，这样会基于跟接口生成代理类

@FeignClient(name = "service-provider")
public interface EchoService {
@RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
String echo(@PathVariable("str") String str);
}

只要确保这个被

@FeignClient

@EnableFeignClients

java.lang.reflect.Proxy

生成代理类之后，会被注入到

ApplicationContext

echo

@FeignClient

value:String 服务名。比如

service-provider

http://service-provider

EchoService

value=service-provider

echo

http://service-provider/echo

value=https://service-provider

echo

https://service-provider/divide

serviceId:String 该属性已过期，但还能用。作用跟 value 一致
name:String 跟 value 属性作用一致

qualifier:String 给 FeignClient 设置

@Qualifier

url:String 绝对路径，用于替换服务名。优先级比服务名高。比如

EchoService

url=aaa

echo

http://aaa/echo

url=https://aaa

echo

https://aaa/divide

decode404:boolean 默认是 false，表示对于一个 http status code 为 404 的请求是否需要进行 decode，默认不进行 decode，当成一个异常处理。设置为true之后，遇到 404 的 response 还是会解析 body

configuration:Class<?>[] 跟

@EnableFeignClients

defaultConfiguration

@EnableFeignClients

defaultConfiguration

fallback:Class<?> 默认值是

void.class

如果配置了 fallback 属性，那么会把这个 Fallback 类包装在一个默认的

FallbackFactory

FallbackFactory.Default

FallbackFactory

fallbackFactory:Class<?> 默认值是

void.class

feign.hystrix.FallbackFactory

FallbackFactory

Throwable

path:String 请求路径。 在服务名或 url 与 requestPath 之间

primary:boolean 默认是 true，表示当前这个 FeignClient 生成的 bean 是否是 primary。

所以如果在

ApplicationContext

EchoService

Feign 的执行过程

了解了 Feign 的使用之后，接下来我们来看 Feign 构造一个 Client 的过程。

从

@EnableFeignClients

FeignClientsRegistrar

从这个链路上我们可以得到几个信息：

1.

@FeignClient

FeignClientFactoryBean

FactoryBean

FactoryBean

2.在构造 Proxy 的过程中会根据

org.springframework.cloud.openfeign.Targeter

target

feign.hystrix.enabled=true

HystrixTargeter

DefaultTargeter

3.

Targeter

feign.Feign.Builder

build

feign.Feign

ReflectiveFeign

如果启动了 hystrix 开关(

feign.hystrix.enabled=true

feign.hystrix.HystrixFeign.Builder

feign.Feign.Builder

4.构造出

feign.Feign

newInstance

简单看下这个

newInstance

public <T> T newInstance(Target<T> target) {
Map<String, MethodHandler> nameToHandler = targetToHandlersByName.apply(target);
Map<Method, MethodHandler> methodToHandler = new LinkedHashMap<Method, MethodHandler>();
List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList<DefaultMethodHandler>();

for (Method method : target.type().getMethods()) {
if (method.getDeclaringClass() == Object.class) {
continue;
} else if(Util.isDefault(method)) {
DefaultMethodHandler handler = new DefaultMethodHandler(method);
defaultMethodHandlers.add(handler);
methodToHandler.put(method, handler);
} else {
methodToHandler.put(method, nameToHandler.get(Feign.configKey(target.type(), method)));
}
}
// 使用 InvocationHandlerFactory 根据接口的方法信息和 target 对象构造 InvocationHandler
InvocationHandler handler = factory.create(target, methodToHandler);
// 构造代理
T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(), new Class<?>[]{target.type()}, handler);

for(DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
defaultMethodHandler.bindTo(proxy);
}
return proxy;
}

这里的

InvocationHandlerFactory

Feign

• 使用原生的

  DefaultTargeter

  : 那么会使用

  feign.InvocationHandlerFactory.Default

  这个 factory，并且构造出来的

  InvocationHandler

  是

  feign.ReflectiveFeign.FeignInvocationHandler

• 使用 hystrix 的

  HystrixTargeter

  : 那么会在

  feign.hystrix.HystrixFeign.Builder#build(feign.hystrix.FallbackFactory<?>)

  方法中调用父类的

  invocationHandlerFactory

  方法传入一个匿名的

  InvocationHandlerFactory

  实现类，该类内部构造出的

  InvocationHandler

  为

  HystrixInvocationHandler

Sentinel 整合 Feign

理解了 Feign 的执行过程之后，Sentinel 想要整合 Feign，可以参考 Hystrix 的实现：

1.❌ 实现

Targeter

SentinelTargeter

Targeter

Targeter

HystrixTargeter

DefaultTargeter

2.✅

FeignClientFactoryBean

Targeter

feign.Feign.Builder

FeignContext

DefaultTargeter

feign.Feign.Builder

• 创建

  SentinelFeign.Builder

  继承

  feign.Feign.Builder

  ，用来构造

  Feign

• SentinelFeign.Builder

  内部需要获取

  FeignClientFactoryBean

  中的属性进行处理，比如获取

  fallback

  ,

  name

  ,

  fallbackFactory

  。

很不幸，

FeignClientFactoryBean

ApplicationContext

• SentinelFeign.Builder

  调用

  build

  方法构造

  Feign

  的过程中，我们不需要实现一个新的

  Feign

  ，跟 hystrix 一样沿用

  ReflectiveFeign

  即可，在沿用的过程中调用父类

  feign.Feign.Builder

  的一些方法进行改造即可，比如

  invocationHandlerFactory

  方法设置

  InvocationHandlerFactory

  ，

  contract

  的调用

3.✅ 跟 hystrix 一样实现自定义的

InvocationHandler

SentinelInvocationHandler

4.✅

SentinelInvocationHandler

SentinelInvocationHandler

feign.Target

feign.InvocationHandlerFactory.MethodHandler

feign.SynchronousMethodHandler

很不幸，

feign.SynchronousMethodHandler

feign.Contract

SentinelContractHolder

MethodMetadata

feign.Contract

在

SentinelFeign.Builder

contract

SentinelContractHolder

Contract

Contract

Note:

spring-cloud-starter-openfeign

feign-hystrix

HystrixTargeter

Targeter

HystrixTargeter

target

@Override
public <T> T target(FeignClientFactoryBean factory, Feign.Builder feign, FeignContext context,
Target.HardCodedTarget<T> target) {
if (!(feign instanceof feign.hystrix.HystrixFeign.Builder)) {
// 如果 Builder 不是 feign.hystrix.HystrixFeign.Builder，使用这个 Builder 进行处理
// 我们默认构造了 SentinelFeign.Builder 这个 Builder，默认使用 feign-hystrix 依赖也没有什么问题
return feign.target(target);
}
feign.hystrix.HystrixFeign.Builder builder = (feign.hystrix.HystrixFeign.Builder) feign;
...
}

在

SentinelInvocationHandler

http方法:protocol://服务名/请求路径跟参数

比如这个

TestService

@FeignClient(name = "test-service")
public interface TestService {
@RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
String echo(@PathVariable("str") String str);

@RequestMapping(value = "/divide", method = RequestMethod.GET)
String divide(@RequestParam("a") Integer a, @RequestParam("b") Integer b);
}

• echo

  方法对应的资源名：

  GET:http://test-service/echo/{str}

• divide

  方法对应的资源名：

  GET:http://test-service/divide

总结

1.Feign 的内部很多类都是 package 级别的，外部 package 无法引用某些类，这个时候只能想办法绕过去，比如使用反射

2.目前这种实现有风险，万一哪天 starter 内部使用的 Feign 相关类变成了 package 级别，那么会改造代码。所以把 Sentinel 的实现放到 Feign 里并给 Feign 官方提 pr 可能更加合适

3.Feign的处理流程还是比较清晰的，只要能够理解其设计原理，我们就能容易地整合进去

欢迎大家对整合方案进行讨论，并能给出不合理的地方，当然能提pr解决不合理的地方就更好了。

Sentinel Starter 整合 Feign 的代码目前已经在 github 仓库上，但是没未发版。预计月底发版，如果现在就想使用，可以在 pom 中引入 Spring SNAPSHOT 的 repository 或自行下载源码进行编译。

最后再附上一个使用 Nacos 做服务发现和 Sentinel 做限流的 Feign 例子。

https://github.com/spring-cloud-incubator/spring-cloud-alibaba/tree/master/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example

最后，在Java技术栈微信公众号后台回复：cloud，可获取栈长整理的一系列 Spring Cloud 教程，目前大量教程还在撰写中……