@FeignClient声明接口调用简述
在SpringCloud微服务架构体系内，FeignClient是跨应用接口调用场景中最常用的组件之一。常见的使用FeignClient远程调用方式就是通过在消费端声明接口绑定@FeignClient注解的方式，这种用法是比较优雅的，其有如下好处：
- 相比各种HttpClient，消费端声明接口让跨应用的交互接口更加清晰明了，依赖清晰，方便维护
- spring-cloud-starter-openfeign适配了客户端负载、连接池等组件，无需自行实现，运行可靠性能有保障
- spring-cloud-starter-openfeign可识别Spring MVC的@RequestMapping注解（较新版本不支持类上声明@RequestMapping注解），让服务能够通过Controller接口开放SDK给消费端，集成更加高效
服务提供端Controller接口示例：
/**
* 模拟提供端的SDK接口。
* <BR>注意:新版本Spring Cloud Feign 不支持接口类上的@RequestMapping注解,
* <BR>服务提供端做SDK接口时@RequestMapping声明Base Url建议写到Controller实现类上，
* <BR>客户端BASEURL通过@FeignClient注解的path属性指定。
*/
// @RequestMapping("/api/monitor")
public interface SimulaterPoviderApiSdk {
@GetMapping("/health")
String health();
}
服务消费端接口声明示例：
@FeignClient(name = "APP-DEMO" ,path = "/api/monitor")
public interface TestDynamicClient extends SimulaterPoviderApiSdk {
/**
* 示例为消费端引入服务端接口SDK后，新建@FeignClient消费接口继承SDK目标接口
* @FeignClient注解中name是目标应用名，Path是该接口的Base URL
*/
}
动态切换目标应用场景
在前面的示例中，消费端调用服务提供端的接口时，通过注解指定目标应用名APP-DEMO进行客户端负载均衡处理，然而在实际应用中我们会遇到一些更复杂的情况，在一些场景中目标应用的名称是动态变化的，举例如下：
- 多环境部署：同一个应用在部署多套环境共用同一套注册中心。这种场景下通常会从注册应用名入手进行区分，如开发环境应用名为
APP-DEMO-DEV，测试环境应用名为APP-DEMO-TEST。这种场景中消费端调用其他应用接口时，期望依据消费端的环境变量配置spring.profiles.active=dev动态将注解中的模板应用名APP-DEMO替换为实际环境对应应用名APP-DEMO-DEV - 多应用管控：例如一个应用管控的平台，可以同时管理多个应用，每个被管应用均提供了规格一致的监控、运维相关接口。运行时根据用户选择的具体应用进行对应接口调用。这种模式下，同样需要进行动态切换目标应用名。
动态切换目标应用示例
针对多应用管控场景，我们对做一个简单的示例代码，通过OpenFeign提供的扩展RequestInterceptor实现。
- 定义RequestInterceptor扩展拦截器，对固定常量应用名进行动态应用名替换
@Component
public class DynamicFeignClientInterceptor implements RequestInterceptor {
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public void apply(RequestTemplate template) {
Target<?> target = template.feignTarget();
System.out.println("origin:"+target);
String originClientName = target.name();
String targetClientName =convertTargetClientName(target.name());
if (!originClientName.equals(targetClientName)) {
String newUrl = target.url().replace(originClientName, targetClientName);
Target.HardCodedTarget newTarget = new Target.HardCodedTarget(target.type(), targetClientName, newUrl);
System.out.println("target:" + newTarget);
newTarget.apply(template);
}
}
public static final String DYNAMIC_CLIENT_NAME="DYNAMIC-CLIENT";
/**
* 根据需求转换目标客户端名称,本示例实现逻辑为从线程上下文获取动态客户端名称
* @param originClient
* @return
*/
protected String convertTargetClientName(String originClient) {
if (DYNAMIC_CLIENT_NAME.equals(originClient)) {
//从线程上下文获取当前请求对应的目标客户端名称
return DynamicFeignClientContext.peek();
}
return originClient;
}
}
- @FeignClient声明接口时，绑定动态切换目标应用的拦截器，应用名设置为拦截器给定的常量
@FeignClient(name =DynamicFeignClientInterceptor.DYNAMIC_CLIENT_NAME ,path = "/api/monitor",configuration = DynamicFeignClientInterceptor.class)
public interface TestDynamicClient extends SimulaterPoviderApiSdk {
}
- 调用接口时，指定目标应用
@RestController
@RequestMapping("/test")
public class TestController {
@Autowired
TestDynamicClient testDynamicClient;
@GetMapping
public String listUsers(String clientName) {
return DynamicFeignClientInvoker.build(clientName).invoke(() -> testDynamicClient.health());
}
}
- 辅助代码，线程上下文应用名动态管理代码示例
动态切换调用工具类
public class DynamicFeignClientInvoker {
private String clientName;
private DynamicFeignClientInvoker(String name) {
this.clientName=name;
}
public static DynamicFeignClientInvoker build(String clientName) {
return new DynamicFeignClientInvoker(clientName);
}
public <V> V invoke(Callable<V> callable) {
try {
DynamicFeignClientContext.push(clientName);
return callable.call();
} catch (Exception e) {
if (e instanceof RuntimeException) {
throw (RuntimeException)e;
}else {
throw new RuntimeException(e);
}
}finally {
DynamicFeignClientContext.poll();
}
}
}
动态客户端名线程上下文工具类
public class DynamicFeignClientContext {
private static final ThreadLocal<Deque<String>> LOOKUP_KEY_HOLDER = new NamedThreadLocal<Deque<String>>("dynamic-feign-client") {
@Override
protected Deque<String> initialValue() {
return new ArrayDeque<>();
}
};
/**
* 获得当前已指定的FeignClient名称
* @return FeignClient名称
*/
public static String peek() {
return LOOKUP_KEY_HOLDER.get().peek();
}
public static String push(String clientName) {
String client = StringUtils.hasLength(clientName)? clientName:"" ;
LOOKUP_KEY_HOLDER.get().push(client);
return client;
}
/**
* 清空当前指定的客户端名称
*/
public static void poll() {
Deque<String> deque = LOOKUP_KEY_HOLDER.get();
deque.poll();
if (deque.isEmpty()) {
LOOKUP_KEY_HOLDER.remove();
}
}
public static void clear() {
LOOKUP_KEY_HOLDER.remove();
}
}
消费端源码项目
该源码仅包含消费端代码，默认未连接注册中心，通过application.properties文件配置了本地IP路由地址。
