【feign】OpenFeign设置header的5种方式

设置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, MultiValueMap, 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不会起作用, 而且启动项目会报错:

Method xxx not annotated with HTTP method type (ex. GET, POST)

解决该问题方案请参考博客

查阅官方文档，feign 默认使用的是spring mvc 注解（就是RequestMapping 之类的） ，所以需要通过新增一个配置类来修改其契约 ，即可可以解决该问题了。

@RequestLine is a core Feign annotation, but you are using the Spring Cloud @FeignClientwhich uses Spring MVC annotations. 

配置@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设置header¹²³
• 源码-feign-demo

---

1. Spring 使用 feign时设置header信息 ↩︎

2. 使用Feign时如何设置Feign的Header信息 ↩︎

3. 设置Feign的Header信息 ↩︎