Feign统一设置header

Posted 2023-04-21

参考技术A Feign可以通过实现接口 feign.RequestInterceptor ，完成对 feign.RequestTemplate 的修改，比如添加header

Spring Cloud Feign 请求添加headers

目录

• 方案一：方法上的@RequestMapping注解添加headers信息
• 方案二：接口上的@RequestMapping注解添加headers信息
• 方案三：使用@Headers注解添加headers信息
• 方案四：自定义RequestInterceptor添加headers信息
• 方案五：自定义RequestInterceptor实现添加动态数据到header

方案一：方法上的@RequestMapping注解添加headers信息

@RequestMapping注解的属性中包含一个headers数组，所以尝试使用，在指定的方法上@RequestMapping注解中添加需要的headers，可以是写死的，也可以读取配置，测试是有效的

同理@RequestMapping一组的@PostMapping，@GetMapping注解等均适用

@FeignClient(name = "server",url = "127.0.0.1:8080")
public interface FeignTest 
    @RequestMapping(value = "/test",headers = "app=test-app","token=$test-app.token")
    String test();

方案二：接口上的@RequestMapping注解添加headers信息

针对单个方法可以在方法上的@RequestMapping注解中添加headers，如果同一个接口中所有的方法都需要同样的headers时在方法上加就比较繁琐了，可以在接口上的@RequestMapping注解中添加headers，使整个接口的方法均被添加同样的headers

@FeignClient(name = "server",url = "127.0.0.1:8080")
@RequestMapping(value = "/",headers = "app=test-app","token=$test-app.token")
public interface FeignTest 
    @RequestMapping(value = "/test")
    String test();

方案三：使用@Headers注解添加headers信息

@FeignClient(name = "server",url = "127.0.0.1:8080")
@Headers("app: test-app","token: $test-app.token")
public interface FeignTest 
    @RequestMapping(value = "/test")
    String test();

查看openfeign官方文档发现其使用的是@Headers来添加headers，测试发现并没有生效，spring cloud使用了自己的SpringMvcContract来解析注解，所以需要自己实现一个Contract来实现对@Headers注解的支持，具体实现参照https://juejin.im/post/6844903961653149709

方案四：自定义RequestInterceptor添加headers信息

feign提供了一个拦截器接口RequestInterceptor，实现RequestInterceptor接口就可以实现对feign请求的拦截，接口提供了一个方法apply()，实现apply()方法

@Component
public class FeignRequestInterceptor implements RequestInterceptor 

    @Value("$test-app.token")
    private String token;
    
    @Override
    public void apply(RequestTemplate requestTemplate) 
        requestTemplate.header("app","test-app");//静态
        requestTemplate.header("token",token);//读配置
    

实现apply()方法直接添加header会拦截所有的请求都加上headers，如果不是所有的feign请求都需要用到不建议此方法

方案五：自定义RequestInterceptor实现添加动态数据到header

以上方案都不适合把动态的数据放入headers中，而通常场景下可能经常需要把计算的签名，用户id等动态信息设置到headers，所以还需要一个更加完善的方案。方案1/2/3均不能设置动态的值，方案4可以设置动态值，但是没做到请求的区分，所以在方案4的基础上进行改进得到了较为完善的方案5。具体实现如下：

在请求调用代码中，获取到HttpServletRequest对象，将需要添加到headers中的值封装成一个map后放入HttpServletRequest的attribute域中

ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
String signedMsg = getSignedMsg(reqJson); // 计算签名字符串
Map<String, String> reqMap = new HashMap<>();
reqMap.put("content-type", "application/json");//常量字段
reqMap.put("accessKey", accessKey);//常量字段
reqMap.put("signedMsg", signedMsg);//动态计算/获取字段
request.setAttribute("customizedRequestHeader", reqMap);

在自定义RequestInterceptor中获取到HttpServletRequest对象的attribute域中指定的key，将key对应map中的所有参数加入到headers。

@Component
public class FeignRequestInterceptor implements RequestInterceptor 

    @Override
    public void apply(RequestTemplate requestTemplate) 
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 设置自定义header
        // 设置request中的attribute到header以便转发到Feign调用的服务
        Enumeration<String> reqAttrbuteNames = request.getAttributeNames();
        if (reqAttrbuteNames != null) 
            while (reqAttrbuteNames.hasMoreElements()) 
                String attrName = reqAttrbuteNames.nextElement();
                if (!"customizedRequestHeader".equalsIgnoreCase(attrName)) 
                    continue;
                
                Map<String,String> requestHeaderMap = (Map)request.getAttribute(attrName);
                for (Map.Entry<String, String> entry : requestHeaderMap.entrySet()) 
                    requestTemplate.header(entry.getKey(), entry.getValue());
                
                break;