Spring Cloud Feign請求添加headers的實現方式

Posted on by

背景

部門技術升級，HttpClient需要升級Feign調用，重構某一個資方時遇到請求需要添加上自定義簽名headers，踩坑後記錄瞭下來

方案一

方法上的@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://www.jb51.net/article/282530.htm

方案四

自定義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;
            }
        }
    }
}

總結

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：