【SpringCloud实战】一次开发中使用Feign添加动态Header问题思考

需求背景

【SpringCloud实战】一次开发中使用Feign添加动态Header问题思考

最近有个需求，是对接某个运动APP的Api开放平台用户授权业务。文中以两个API为例：

1、获取token

场景：用户在授权⻚页⾯面点击授权后，⻚页⾯面会跳转到合作⽅方提供的redirect_url，合作⽅方通过跳转传回的code换取token，完成认证和授权。

Header附加参数：Authorization:Basic base64(AppKey:AppSecret) `

注意：Basic后⾯面必须有一个空格。

2、获取用户资料

场景：获取用户资料接⼝⽤于获取用户在APP的用户资料。

Header附加参数：Authorization:Bearer token

注意：Bearer后⾯面必须有一个空格。

分析

从上述API资料里面分析得出要对接这两个API需要设置不同的Header信息，那么就需要代码中支持动态设置header功能。

【SpringCloud实战】一次开发中使用Feign添加动态Header问题思考

API

项目框架

由于项目是使用SpringCloud 集成Feign搭建的基础框架，并且在项目中已经设计了全局的Header。

通过实现RequestInterceptor接口,完成对所有的Feign请求,设置Header代码如下：

@Configurationpublic class FeignClientConfig implements RequestInterceptor {    @Value("${token}")    private String token;      @Override          public void apply(RequestTemplate template) {        template.header("token", token);    }    /*打印feign请求日志级别*/      @Bean      public Logger.Level level() {        return Logger.Level.FULL;    }}

原理：@FeignClient 的代理类在执行的时候，会去使用该拦截器，然后注入到 spring 上下文中，这样就可以在请求的上下文中添加自定义的请求头。

优点：所以自定义自己的拦截器

缺点：操作的是全局的 RequestTemplate，比较难以根据不同的服务方提供不同的 header。

方案一：使用Feign官方方案

经过分析得出现在的代码是不支持这次需求，那么项目中既然集成了OpenFeign，可以从这里入手看看官方是如何解决的。

OpenFeign源码地址：https://github.com/OpenFeign/feign

// openfeign 官方文档代码示例public interface ContentService {    @RequestLine("GET /api/documents/{contentType}")    @Headers("Accept: {contentType}")    String getDocumentByType(@Param("contentType") String type);}

通过上面的官方文档代码示例发现不需要那么麻烦，用原生的@Headers 注解就能解决我们的问题了，添加到代码上。

@Headers 代码示例

@FeignClient(name = "xxx-feign-service",url = "IP:端口")@Headers({"Authorization: ${token}"})    public interface FeignClient {      @RequestMapping(value = "/getToken")      String getToken();}

使用{token} 可以传递动态header属性。

一番折腾后发现@Headers 没有生效，在生成的RequestTemplate中，没有获取到token值。 然后调试一下代码，发现，ReflectFeign在生成远程服务的代理类的时候，会通过 Contract 接口准备数据。 而@Headers 注解没有生效的原因是：官方的 Contract 没有生效：

代码如下：

class FeignClientFactoryBean implements FactoryBean