OpenFeign 服务调用过程中实现 header 数据透传 | Java Debug笔记
Offer 驾到,掘友接招!我正在参与2022春招系列活动-Debug实录任务,点击查看活动详情。
一、问题描述
在通过 OpenFeign
进行服务调用的过程中,我们需要将用户的 user-token
、lang
等信息放入请求 header 中。在分布式系统中,往往一个业务接口内部会发生多次 RPC 调用。
在这个过程中,我们需要继续将用户请求头中的数据保持传递,方便底层服务获取用户登陆状态
, 本地化参数
等数据。
针对这样的场景,我们就需要在 OpenFeign
调用过程中对当前请求中的 header 数据进行 RPC 调用过程中进行透传。
二、解决方案
1、创建自定义 feign.RequestInterceptor
拦截器 RequestInterceptor
,将当前 HttpServletRequest
中的请求头信息传递给 Feign
请求所使用的 RequestTemplate
对象。代码如下:
注意:我们在 Spring MVC 项目中任意代码位置获取
HttpServletRequest
对象可以借助RequestContextHolder
来获取, 具体的调用方法见下面的代码块。
public class FeignRequestInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate template) {
Map<String, String> headers = getHeaders();
headers.forEach(template::header);
}
/**
* 获取 request 中的所有的 header 值
*
* @return
*/
private Map<String, String> getHeaders() {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
Map<String, String> map = new LinkedHashMap<>();
Enumeration<String> headerNames = request.getHeaderNames();
while (headerNames.hasMoreElements()) {
String key = headerNames.nextElement();
String value = request.getHeader(key);
map.put(key, value);
}
return map;
}
}
2、注册拦截器到 Spring 容器中(需要注意保证配置类 FeignSupportHeaderConfig
能够被在Spring 容器启动的过程中被扫描到)。代码如下:
@Configuration
public class FeignSupportHeaderConfig {
@Bean
public RequestInterceptor getRequestInterceptor() {
return new FeignRequestInterceptor();
}
}
3、如果有使用 hystrix
需要设置为 SEMAPHORE
模式。配置如下:
一般 spring-cloud 2.x 以后建议使用
org.springframework.cloud:spring-cloud-starter-circuitbreaker-resilience4j
它是 Spring 官方长期支持/维护的组件
# To set thread isolation to SEMAPHORE
hystrix:
command:
default:
execution:
isolation:
strategy: SEMAPHORE
三、问题总结
我们在解决请求头数据,透传的过程中首先需要先对中间件使用流程和原理有一定的了解,然后再针对具体的问题处理。在目前我们在项目中使用 hystrix
逐渐变少了,更多的是使用 Spring Retry
和 resilience4j
作为 circuitbreaker
。
如果我们需要获取客户端的语言,本地化(国际化 i18n)参数,我们可以借助 Spring 提供的 LocaleContextHolder
API 进行获取,比如:
1、获取语言:LocaleContextHolder.getLocale().getLanguage()
2、获取时区:LocaleContextHolder.getLocale().getTimeZone()
等等。
参考文档
转载自:https://juejin.cn/post/7070525661068132389