摘要：作用跟一致跟屬性作用一致給設置注解絕對路徑，用于替換服務名。在服務名或與之間默認是，表示當前這個生成的是否是。內(nèi)部的能獲取服務名信息，的實現(xiàn)類能拿到對應的請求路徑信息。很不幸，這個類也是包級別的類。整合的代碼目前已經(jīng)在倉庫上，但是沒未發(fā)版。
作者 | Spring Cloud Alibaba 高級開發(fā)工程師洛夜
來自公眾號阿里巴巴中間件投稿
前段時間 Hystrix 宣布不再維護之后（Hystrix 停止開發(fā)。。。Spring Cloud 何去何從？），F(xiàn)eign 作為一個跟 Hystrix 強依賴的組件，必然會有所擔心后續(xù)的使用。
作為 Spring Cloud Alibaba 體系中的熔斷器 Sentinel，Sentinel 目前整合了 Feign，本文對整合過程做一次總結(jié)，歡迎大家討論和使用。
Feign 是什么？
Feign 是一個 Java 實現(xiàn)的 Http 客戶端，用于簡化 Restful 調(diào)用。
Feign 跟 OkHttp、HttpClient 這種客戶端實現(xiàn)理念不一樣。Feign 強調(diào)接口的定義，接口中的一個方法對應一個 Http 請求，調(diào)用方法即發(fā)送一個 Http 請求；OkHttp 或 HttpClient 以過程式的方式發(fā)送 Http 請求。Feign 底層發(fā)送請求的實現(xiàn)可以跟 OkHttp 或 HttpClient 整合。
要想整合 Feign，首先要了解 Feign 的使用以及執(zhí)行過程，然后看 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 數(shù)組，而 basePackageClasses 是個 Class 數(shù)組，用于掃描這些類對應的 package；
defaultConfiguration:Class[] 默認的配置類，對于所有的 Feign Client，這些配置類里的配置都會對它們生效，可以在配置類里構(gòu)造 feign.codec.Decoder, feign.codec.Encoder 或 feign.Contract 等bean;
clients:Class[] 表示 @FeignClient； 注解修飾的類集合，如果指定了該屬性，那么掃描功能相關的屬性就是失效。比如 value、basePackages 和 basePackageClasses；
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 根據(jù)這個接口生成一個代理類。
生成代理類之后，會被注入到 ApplicationContext 中，直接 AutoWired 就能使用，使用的時候調(diào)用 echo 方法就相當于是發(fā)起一個 Restful 請求。
@FeignClient 屬性介紹：
value:String 服務名。比如 service-provider, http://service-provider。比如 EchoService 中如果配置了 value=service-provider，那么調(diào)用 echo 方法的 url 為 http://service-provider/echo；如果配置了 value=https://service-provider，那么調(diào)用 echo 方法的 url 為 https://service-provider/divide
serviceId:String 該屬性已過期，但還能用。作用跟 value 一致
name:String 跟 value 屬性作用一致
qualifier:String 給 FeignClient 設置 @Qualifier 注解
url:String 絕對路徑，用于替換服務名。優(yōu)先級比服務名高。比如 EchoService 中如果配置了 url=aaa，那么調(diào)用 echo 方法的 url 為 http://aaa/echo；如果配置了 url=https://aaa，那么調(diào)用 echo 方法的 url 為 https://aaa/divide
decode404:boolean 默認是 false，表示對于一個 http status code 為 404 的請求是否需要進行 decode，默認不進行 decode，當成一個異常處理。設置為true之后，遇到 404 的 response 還是會解析 body
configuration:Class[] 跟 @EnableFeignClients 注解的 defaultConfiguration 屬性作用一致，但是這個對于單個 FeignClient 的配置，而 @EnableFeignClients 里的 defaultConfiguration 屬性是作用域全局的，針對所有的 FeignClient
fallback:Class 默認值是 void.class，表示 fallback 類，需要實現(xiàn) FeignClient 對應的接口，當調(diào)用方法發(fā)生異常的時候會調(diào)用這個 Fallback 類對應的 FeignClient 接口方法。
如果配置了 fallback 屬性，那么會把這個 Fallback 類包裝在一個默認的 FallbackFactory 實現(xiàn)類 FallbackFactory.Default 上，而不使用 fallbackFactory 屬性對應的 FallbackFactory 實現(xiàn)類
fallbackFactory:Class 默認值是 void.class，表示生產(chǎn) fallback 類的 Factory，可以實現(xiàn) feign.hystrix.FallbackFactory 接口，FallbackFactory 內(nèi)部會針對一個 Throwable 異常返回一個 Fallback 類進行 fallback 操作
path:String 請求路徑。 在服務名或 url 與 requestPath 之間
primary:boolean 默認是 true，表示當前這個 FeignClient 生成的 bean 是否是 primary。
所以如果在 ApplicationContext中存在一個實現(xiàn) EchoService 接口的 Bean，但是注入的時候并不會使用該Bean，因為 FeignClient 生成的 Bean 是 primary
Feign 的執(zhí)行過程
了解了 Feign 的使用之后，接下來我們來看 Feign 構(gòu)造一個 Client 的過程。
從 @EnableFeignClients 注解可以看到，入口在該注解上的 FeignClientsRegistrar 類上，整個鏈路是這樣的：
從這個鏈路上我們可以得到幾個信息：
1.@FeignClient 注解修飾的接口最終會被轉(zhuǎn)換成 FeignClientFactoryBean 這個 FactoryBean，FactoryBean 內(nèi)部的 getObject 方法最終會返回一個 Proxy
2.在構(gòu)造 Proxy 的過程中會根據(jù) org.springframework.cloud.openfeign.Targeter 接口的 target 方法去構(gòu)造。如果啟動了hystrix開關(feign.hystrix.enabled=true)，會使用 HystrixTargeter，否則使用默認的 DefaultTargeter
3.Targeter 內(nèi)部構(gòu)造 Proxy 的過程中會使用 feign.Feign.Builder 去調(diào)用它的 build 方法構(gòu)造 feign.Feign 實例(默認只有一個子類 ReflectiveFeign)。
如果啟動了 hystrix 開關(feign.hystrix.enabled=true)，會使用 feign.hystrix.HystrixFeign.Builder，否則使用默認的feign.Feign.Builder
4.構(gòu)造出 feign.Feign 實例之后，調(diào)用 newInstance 方法返回一個 Proxy
簡單看下這個 newInstance 方法內(nèi)部的邏輯：
public T newInstance(Target target) {
Map nameToHandler = targetToHandlersByName.apply(target);
Map methodToHandler = new LinkedHashMap();
List defaultMethodHandlers = new LinkedList();
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 根據(jù)接口的方法信息和 target 對象構(gòu)造 InvocationHandler
InvocationHandler handler = factory.create(target, methodToHandler);
// 構(gòu)造代理
T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(), new Class[]{target.type()}, handler);
for(DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
defaultMethodHandler.bindTo(proxy);
}
return proxy;
}
這里的 InvocationHandlerFactory 是通過構(gòu)造 Feign 的時候傳入的：
使用原生的 DefaultTargeter: 那么會使用 feign.InvocationHandlerFactory.Default 這個 factory，并且構(gòu)造出來的 InvocationHandler 是 feign.ReflectiveFeign.FeignInvocationHandler
使用 hystrix 的 HystrixTargeter: 那么會在feign.hystrix.HystrixFeign.Builder#build(feign.hystrix.FallbackFactory) 方法中調(diào)用父類的 invocationHandlerFactory 方法傳入一個匿名的 InvocationHandlerFactory 實現(xiàn)類，該類內(nèi)部構(gòu)造出的 InvocationHandler 為 HystrixInvocationHandler
Sentinel 整合 Feign
理解了 Feign 的執(zhí)行過程之后，Sentinel 想要整合 Feign，可以參考 Hystrix 的實現(xiàn)：
1.? 實現(xiàn) Targeter 接口 SentinelTargeter。 很不幸，Targeter 這個接口屬于包級別的接口，在外部包中無法使用，這個 Targeter 無法使用。沒關系，我們可以沿用默認的 HystrixTargeter(實際上會用 DefaultTargeter，下文 Note 有解釋)
2.? FeignClientFactoryBean 內(nèi)部構(gòu)造 Targeter、feign.Feign.Builder 的時候，都會從 FeignContext 中獲取。所以我們沿用默認的 DefaultTargeter 的時候，內(nèi)部使用的 feign.Feign.Builder 可控，而且這個 Builder 不是包級別的類，可在外部使用
創(chuàng)建 SentinelFeign.Builder 繼承 feign.Feign.Builder ，用來構(gòu)造 Feign
SentinelFeign.Builder 內(nèi)部需要獲取 FeignClientFactoryBean 中的屬性進行處理，比如獲取 fallback, name, fallbackFactory。
很不幸，FeignClientFactoryBean 這個類也是包級別的類。沒關系，我們知道它存在在 ApplicationContext 中的 beanName， 拿到 bean 之后根據(jù)反射獲取屬性就行(該過程在初始化的時候進行，不會在調(diào)用的時候進行，所以不會影響性能)
SentinelFeign.Builder 調(diào)用 build 方法構(gòu)造 Feign 的過程中，我們不需要實現(xiàn)一個新的 Feign，跟 hystrix 一樣沿用 ReflectiveFeign 即可，在沿用的過程中調(diào)用父類 feign.Feign.Builder 的一些方法進行改造即可，比如 invocationHandlerFactory 方法設置 InvocationHandlerFactory ，contract 的調(diào)用
3.? 跟 hystrix 一樣實現(xiàn)自定義的 InvocationHandler 接口 SentinelInvocationHandler 用來處理方法的調(diào)用
4.? SentinelInvocationHandler 內(nèi)部使用 Sentinel 進行保護，這個時候涉及到資源名的獲取。SentinelInvocationHandler 內(nèi)部的 feign.Target 能獲取服務名信息，feign.InvocationHandlerFactory.MethodHandler 的實現(xiàn)類 feign.SynchronousMethodHandler 能拿到對應的請求路徑信息。
很不幸，feign.SynchronousMethodHandler 這個類也是包級別的類。沒關系，我們可以自定義一個 feign.Contract 的實現(xiàn)類 SentinelContractHolder 在處理 MethodMetadata 的過程把這些 metadata 保存下來(feign.Contract 這個接口在 Builder 構(gòu)造 Feign 的過程中會對方法進行解析并驗證)。
在 SentinelFeign.Builder 中調(diào)用 contract 進行設置，SentinelContractHolder 內(nèi)部保存一個 Contract 使用委托方式不影響原先的 Contract 過程
Note: spring-cloud-starter-openfeign 依賴內(nèi)部包含了 feign-hystrix。所以是說默認使用 HystrixTargeter 這個 Targeter ，進入 HystrixTargeter 的 target 方法內(nèi)部一看，發(fā)現(xiàn)有段邏輯這么寫的：
@Override
public T target(FeignClientFactoryBean factory, Feign.Builder feign, FeignContext context,
Target.HardCodedTarget target) {
if (!(feign instanceof feign.hystrix.HystrixFeign.Builder)) {
// 如果 Builder 不是 feign.hystrix.HystrixFeign.Builder，使用這個 Builder 進行處理
// 我們默認構(gòu)造了 SentinelFeign.Builder 這個 Builder，默認使用 feign-hystrix 依賴也沒有什么問題
return feign.target(target);
}
feign.hystrix.HystrixFeign.Builder builder = (feign.hystrix.HystrixFeign.Builder) feign;
...
}
在 SentinelInvocationHandler 內(nèi)部我們對資源名的處理策略是: http方法:protocol://服務名/請求路徑跟參數(shù)
比如這個 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
總結(jié)
1.Feign 的內(nèi)部很多類都是 package 級別的，外部 package 無法引用某些類，這個時候只能想辦法繞過去，比如使用反射
2.目前這種實現(xiàn)有風險，萬一哪天 starter 內(nèi)部使用的 Feign 相關類變成了 package 級別，那么會改造代碼。所以把 Sentinel 的實現(xiàn)放到 Feign 里并給 Feign 官方提 pr 可能更加合適
3.Feign的處理流程還是比較清晰的，只要能夠理解其設計原理，我們就能容易地整合進去
歡迎大家對整合方案進行討論，并能給出不合理的地方，當然能提pr解決不合理的地方就更好了。
Sentinel Starter 整合 Feign 的代碼目前已經(jīng)在 github 倉庫上，但是沒未發(fā)版。預計月底發(fā)版，如果現(xiàn)在就想使用，可以在 pom 中引入 Spring SNAPSHOT 的 repository 或自行下載源碼進行編譯。
最后再附上一個使用 Nacos 做服務發(fā)現(xiàn)和 Sentinel 做限流的 Feign 例子。
https://github.com/spring-clo...
最后，在Java技術棧微信公眾號后臺回復：cloud，可獲取棧長整理的一系列 Spring Cloud 教程，目前大量教程還在撰寫中……
