设置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);
有一点需要注意：content-type=application/x-www-form-urlencoded时，方法里接收的参数，就不能直接是一个对象（Map等）。不然还是会默认 content-type为 application/json.
在方法参数前面添加@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不会起作用, 而且启动项目会报错:
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);
}
@FeignClient 注解各个属性进行分析
- value、name value和name的作用一样，如果没有配置url那么配置的值将作为服务名称，用于服务发现。反之只是一个名称。
- contextId 我们不想将所有的调用接口都定义在一个类中，有一种解决方案就是为每个Client手动指定不同的contextId，这样就不会冲突了。
- url url用于配置指定服务的地址，相当于直接请求这个服务，不经过Ribbon的服务选择。像调试等场景可以使用。
- decode404 当调用请求发生404错误时，decode404的值为true，那么会执行decoder解码，否则抛出异常。
- configuration configuration是配置Feign配置类，在配置类中可以自定义Feign的Encoder、Decoder、LogLevel、Contract等。
- fallback 定义容错的处理类，也就是回退逻辑，fallback的类必须实现Feign Client的接口，无法知道熔断的异常信息。
- fallbackFactory 也是容错的处理，可以知道熔断的异常信息。
- path path定义当前FeignClient访问接口时的统一前缀，比如接口地址是/user/get, 如果你定义了前缀是user, 那么具体方法上的路径就只需要写/get 即可。
- primary primary对应的是@Primary注解，默认为true，官方这样设置也是有原因的。当我们的Feign实现了fallback后，也就意味着Feign Client有多个相同的Bean在Spring容器中，当我们在使用@Autowired进行注入的时候，不知道注入哪个，所以我们需要设置一个优先级高的，@Primary注解就是干这件事情的。
- qualifier qualifier对应的是@Qualifier注解，使用场景跟上面的primary关系很淡，一般场景直接@Autowired直接注入就可以了。
参考