【feign】OpenFeign設定header的5種方式

文章目錄

• 設定Feign的Header資訊
• • 概述
  • 示例說明
  • • 在`@RequestMapping`注解裡添加headers屬性
    • 在方法參數前面添加`@RequestHeader`注解
    • 在方法或者類上添加`@Headers`的注解
    • • 使用feign自帶契約
      • 配置`@Headers`注解
    • 在方法參數前面添加`@HeaderMap`注解
    • • 使用feign自帶契約
      • 配置`@HeaderMap`注解
    • 實作`RequestInterceptor`接口
  • 參考

設定Feign的Header資訊

概述

在微服務間使用Feign進行遠端調用時需要在 header 中添加資訊，那麼 springcloud open feign 如何設定 header 呢？有5種方式可以設定請求頭資訊:

• 在

  @RequestMapping

  注解裡添加headers屬性
• 在方法參數前面添加

  @RequestHeader

  注解
• 在方法或者類上添加

  @Headers

  的注解
• 在方法參數前面添加

  @HeaderMap

  注解
• 實作

  RequestInterceptor

  接口

示例說明

由于Feign是完全支援Spring MVC注解的, 是以推薦使用前兩種Feign設定header的方式, 即: Spring MVC中使用注解設定header.

在

@RequestMapping

注解裡添加headers屬性

在application.yml中配置

app.secret: appSecretVal
           

編寫feignClient

@PostMapping(value = "/book/api", headers = {"Content-Type=application/json;charset=UTF-8", "App-Secret=${app.secret}"})
void saveBook(@RequestBody BookDto condition);
           

在方法參數前面添加

@RequestHeader

注解

• 設定單個header屬性

@GetMapping(value = "/getStuDetail")
public StudentVo getStudentDetail(@RequestBody StudentDto condition, @RequestHeader("Authorization") String token);
           

• 設定多個header屬性

@PostMapping(value = "/card")
public CardVo createCard(@RequestBody CardDto condition, @RequestHeader MultiValueMap<String, String> headers);
           

檢視源碼 org.springframework.web.bind.annotation.RequestHeader 說明:

If the method parameter is Map<String, String>, MultiValueMap<String, String>, or HttpHeaders then the map is populated with all header names and values.

在方法或者類上添加

@Headers

的注解

使用feign自帶契約

@Configuration
public class FooConfiguration {
    @Bean
    public Contract feignContract() {
        return new feign.Contract.Default();
    }
}
           

FeignClient使用

@RequestLine

注解, 而未配置feign自帶契約

Contract

時,

@Headers

不會起作用, 而且啟動項目會報錯:

解決該問題方案請參考部落格

查閱官方文檔，feign 預設使用的是spring mvc 注解（就是RequestMapping 之類的） ，是以需要通過新增一個配置類來修改其契約 ，即可可以解決該問題了。

配置

@Headers

注解

@FeignClient(url = "${user.api.url}", name = "user", configuration = FooConfiguration.class)
public interface UserFeignClient {
    @RequestLine("GET /simple/{id}")
    @Headers({"Content-Type: application/json;charset=UTF-8", "Authorization: {token}"})
    public User findById(@Param("id") String id, @Param("token") String token);
}
           

使用

@Param

可以動态配置Header屬性

網上很多在說

@Headers

不起作用，其實

@Headers

注解沒有生效的原因是：官方的

Contract

沒有生效，想了解的移步這篇部落格

在方法參數前面添加

@HeaderMap

注解

使用feign自帶契約

同上

配置

@HeaderMap

注解

@FeignClient(url = "${user.api.url}", name = "user", configuration = FooConfiguration.class)
public interface UserFeignClient {
    @RequestLine("GET /simple/{id}")
    public User findById(@Param("id") String id, @HeaderMap HttpHeaders headers);
}
           

實作

RequestInterceptor

接口

值得注意的一點是:

如果

FeignRequestInterceptor

注入到spring容器的話就會全局生效, 就是說即使在沒有指定

configuration

屬性的

FeignClient

該配置也會生效, 為什麼呢?有興趣的請看源碼分析.

配置

@Component

或

@Service

或

@Configuration

就可以将該配置注入spring容器中, 即可實作全局配置, 進而該項目中的所有

FeignClient

的feign接口都可以使用該配置.

如果隻想給指定

FeignClient

的feign接口使用該配置, 請勿将該類配置注入spring中.

@Configuration
public class FeignRequestInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate template) {
        template.header(HttpHeaders.AUTHORIZATION, "tokenVal");
    }

}
           

小疑問: 如何在

RequestTemplate template

對象中擷取feign接口的請求體資料呢?

@FeignClient(url = "${user.api.url}", name = "user", configuration = FeignRequestInterceptor.class)
public interface UserFeignClient {
    @GetMapping(value = "/simple/{id}")
	public User findById(@RequestParam("id") String id);
}
           

參考

• 參考文檔-feign設定header123
• 源碼-feign-demo

1. Spring 使用 feign時設定header資訊 ↩︎
2. 使用Feign時如何設定Feign的Header資訊 ↩︎
3. 設定Feign的Header資訊 ↩︎