Feign調用中的兩種Header傳參方式小結

Posted on 2023-01-02 by WalkonNet

Feign調用中的兩種Header傳參方式

在Spring Cloud Netflix棧中，各個微服務都是以HTTP接口的形式暴露自身服務的，因此在調用遠程服務時就必須使用HTTP客戶端。

我們可以使用JDK原生的URLConnection、Apache的Http Client、Netty的異步HTTP Client, Spring的RestTemplate。公司目前使用的是Feign。

下面來和大傢一起學習下feign調用中兩種Header傳參方式。

在請求攔截器中統一配置

每次Feign調用中，需要傳遞一些安全校驗參數，比如說token，bizId啥的，如果單獨在每次調用的時候去配置這些重復的邏輯，顯然不合適。所以我們可以在Feign的攔截器中統一配置這些權限參數。

如何配置呢？其實很簡單。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;
 
@Configuration
public class FeignConfiguration implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        ServletRequestAttributes attributes = (ServletRequestAttributes)
                RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        Enumeration<String> headerNames = request.getHeaderNames();
        if (headerNames != null) {
            while (headerNames.hasMoreElements()) {
                String name = headerNames.nextElement();
                String values = request.getHeader(name);
                template.header(name, values);
            }
        }
    }
}

然後再feignClient中配置自定義的配置類，覆蓋默認的配置

@Component
@FeignClient(value = "feignTest" ,configuration = FeignConfiguration.class)
public interface FeignTestService {
}

這樣就所有的Feign調用都會在Header調用中加上request中傳遞過來的參數。不需要單獨在每次Feign調用重復添加參數。

通過@RequestHeader註解

上面也說到，我們在攔截器中獲取request傳遞過來的參數，然後再放到header中。在攔截器中配置的一般都是公用的一些參數。

但是如果一個服務接口，需要一些特殊參數。但是其他服務不需要這個參數，這時候我們不必在攔截器中配置其他服務不需要的參數，隻需在需要的服務接口上加上@RequestHeader註解，然後在feign調用的時候把參數傳過來就ok瞭。

@PostMapping(value = "/orderDetails")
public ReturnInfo getOrderDetail(@RequestHeader(name = "id") String orderId);

比如說之前在quartz中通過Feign調用其他服務獲取優惠券信息，項目中封裝的方法獲取的attributes 是空的。

ServletRequestAttributes attributes = (ServletRequestAttributes)
                RequestContextHolder.getRequestAttributes();

這時候就不用攔截器瞭，直接在方法入參上加上 @RequestHeader註解。

這裡簡單介紹下Feign調用的傳參，實際在項目中，大傢對Feign調用方法都有自己的封裝，代碼和上面的可能不一樣，但是原理都是差不多的。

調用feign接口時，如何往header中添加參數

Controller接收到請求後，我們可以在service中通過feign直接調用其它服務的接口，但是，controller接收到的請求和通過feign調用其它服務，其它服務接收到的請求，是不一樣的。例如我們往往習慣於在header中放入用戶的token信息，在不做處理的情況下，其它服務接收到的請求，可能就是無用戶信息狀態，這種請求應該判定為無效狀態。

在服務的提供方或者調用方定義一個攔截器，將當前請求的token信息手動添加到feign請求的header中。

@Configuration
public class FeignRequestInterceptorConfig implements RequestInterceptor {
	@Bean
	public RequestContextListener requestContextListener() {
		return new RequestContextListener();
	}

	@Override
	public void apply(RequestTemplate requestTemplate) {
		ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
		if (ObjectUtils.isEmpty(attributes)) {
			return;
		}
		HttpServletRequest request = attributes.getRequest();
		String token = request.getHeader("token");
		requestTemplate.header("token", token);
	}
}

在使用過程中，可能會涉及到在請求方獲取自己的token信息都是為空的，查看一下是否是Hystrix策略導致的，如下配置可以解決該問題。

hystrix:
  command:
    default:
      execution:
        timeout:
          #如果enabled設置為false，則請求超時交給ribbon控制
          enabled: true
        isolation:
          # 隔離策略
          strategy: SEMAPHORE
          thread:
            timeoutInMilliseconds: 100000

總結

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

Feign調用中的兩種Header傳參方式小結

目錄