如何為Feign客戶端添加自定義請求頭？

在微服務架構中，服務契約非常重要。Feign客戶端是一個流行的構建微服務之間契約的方法。但是，在實際應用中，我們可能需要在Feign請求中添加自定義的請求頭。那麼，如何為Feign客戶端添加自定義請求頭呢？下面就讓我們一步步進行探討。

一、在@FeignClient註解中添加configuration屬性

在@FeignClient註解中添加configuration屬性，並且設置為FeignConfig.class，可以為Feign客戶端應用自定義的Feign配置。以下是一個完整的示例：

@FeignClient(name = "exampleService", url = "${example-service.ribbon.listOfServers}", configuration = FeignConfig.class)
public interface ExampleServiceClient {
    @GetMapping("/example")
    String getExample();
}

在這個示例中，Feign客戶端的名稱為“exampleService”，URL由Ribbon進行負載均衡操作，並且配置為使用FeignConfig中定義的定製化配置。

二、為Feign客戶端創建自定義的Feign配置類

需要創建一個Feign配置類，並在此類中實現定製化配置。在這個配置類中，我們可以添加請求攔截器，設置請求頭等等。以下是一個完整的Feign配置類的示例：

@Configuration
public class FeignConfig {
    @Autowired
    private TokenProvider tokenProvider;

    @Bean
    public RequestInterceptor requestInterceptor() {
        return requestTemplate -> {
            requestTemplate.header("Authorization", "Bearer " + tokenProvider.getAccessToken());
        };
    }
}

在這個示例中，我們首先使用@Configuration註解標識這是一個配置類。然後，定義了一個@Autowired註解的TokenProvider成員變量來獲取訪問令牌。接下來，我們創建了一個名為requestInterceptor()的Bean方法，並且使用@Bean註解將其標記為Spring Bean。

在requestInterceptor()方法中，我們將Feign的RequestInterceptor接口注入，它有一個名為requestTemplate的參數。在方法體中，我們添加了我們想要的請求頭，這裡是Authorization請求頭，我們從TokenProvider獲取了令牌，並以Bearer格式添加到請求頭中。這樣，每個使用Feign客戶端的請求都將帶有我們設置的Authorization請求頭。

三、使用Feign客戶端

有了上面的步驟，我們現在可以使用Feign客戶端來發起請求，並且自定義請求頭已經添加到請求中。以下是一個完整的示例：

@RestController
public class ExampleController {
    @Autowired
    private ExampleServiceClient exampleServiceClient;

    @GetMapping("/example")
    public String getExample() {
        return exampleServiceClient.getExample();
    }
}

在這個示例中，我們首先使用@RestController註解標識這是一個控制器類。然後，我們通過@Autowired註解注入了ExampleServiceClient類的實例。在getExample()方法中，我們通過這個實例調用了getExample()方法，這個方法實際上是Feign客戶端中定義的方法。可以看到，我們並沒有進行任何的請求頭設置，但是Feign客戶端將會自動添加我們在配置類中定義的請求頭。

四、結論

通過上面的步驟，我們可以為Feign客戶端輕鬆添加自定義請求頭。在實際應用中，可以根據實際情況設置自定義請求頭，這有助於實現更高級別的安全認證以及服務跟蹤等功能。希望這篇文章能夠幫助到您在微服務架構中正確地使用Feign客戶端。