首页
所有分类
TAGS
文字工具 EMOJI BIBLE
编程 Java/Android

使用feign服务调用添加Header参数

Posted in Java/Android onJune 23, 2021

feign添加Header参数

@Configuration
public class FeignConfiguration implements RequestInterceptor {	
	private static final Logger logger = LoggerFactory.getLogger(FeignConfiguration.class);
	
	@Override
	public void apply(RequestTemplate template) {
		ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
		if(null != attributes) {
			HttpServletRequest request = attributes.getRequest();
	        String token = request.getHeader("token");
	        template.header("token", token);
		}
        logger.info("feign interceptor header:{}",template);
	}
}

Feign设置Header头部,@Headers无效

在使用FeignClient调用外部接口的时候，需要在请求头部添加header的参数，用于请求的认证。在查找Feign文档中提供了@Headers注解，该注解可以完成头部的添加。但是却没有生效

@FeignClient(name="name",url = "127.0.0.1:8090/test",path = "/")
public interface IUserService { 
    @RequestMapping(value = "getUserPage",method = RequestMethod.POST)
    @Headers(value={"ContentType=application/x-www-form-urlencoded","Inner_token=PXH0dP5I8qQ8UbFPpzm67cQkm7j8tWT2Kwn6J6SXYkfp2kMo/lSqHQ=="})
    public Map<String,Object> getUserPage(User user);
}

在服务端获取不到Inner_token的头部参数。得到的结果是null

于是开启feign的日志

第一步：定义feign的日志配置文件类

@Configuration
public class FeignConfig { 
    @Bean
    Logger.Level feignLevel(){
        return Logger.Level.FULL;
    }
}

第二步：在调用的FeignClien客户端注解上指定该日志级别配置文件

@FeignClient(name="name",url = "127.0.0.1:8090/test",path = "/",configuration = FeignConfig.class)
public interface IUserService { 
    @RequestMapping(value = "getUserPage",method = RequestMethod.POST)
    @Headers(value={"ContentType=application/x-www-form-urlencoded","Inner_token=PXH0dP5I8qQ8UbFPpzm67cQkm7j8tWT2Kwn6J6SXYkfp2kMo/lSqHQ=="})
    public Map<String,Object> getUserPage(User user);
}

第三步：配置yml文件，指定该feignclient的配置路径和日志级别

logging:
  level:
    demo.IUserService: debug

重启，并发起请求

2019-09-27 10:46:01.662 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] ---> POST http://127.0.0.1:8090/test/getUserPage HTTP/1.1
2019-09-27 10:46:01.663 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] Content-Type: application/json;charset=UTF-8
2019-09-27 10:46:01.663 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] Content-Length: 53
2019-09-27 10:46:01.663 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage]
2019-09-27 10:46:01.663 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] {"id":0,"tableName":"feignTable","page":10,"size":10}
2019-09-27 10:46:01.663 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] ---> END HTTP (53-byte body)
2019-09-27 10:46:01.684 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] <--- HTTP/1.1 200 (21ms)
2019-09-27 10:46:01.684 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] content-type: application/json;charset=UTF-8
2019-09-27 10:46:01.685 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] date: Fri, 27 Sep 2019 02:46:01 GMT
2019-09-27 10:46:01.685 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] transfer-encoding: chunked
2019-09-27 10:46:01.685 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] x-application-context: HelloServer:8090
2019-09-27 10:46:01.685 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage]
2019-09-27 10:46:01.689 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] {"success":true,"rows":[{"id":10111,"tableName":"hbaseTable","page":1,"size":20},{"id":10112,"tableName":"hbaseTable","page":1,"size":20},{"id":10113,"tableName":"hbaseTable","page":1,"size":20},{"id":10114,"tableName":"hbaseTable","page":1,"size":20},{"id":10115,"tableName":"hbaseTable","page":1,"size":20},{"id":10116,"tableName":"hbaseTable","page":1,"size":20},{"id":10117,"tableName":"hbaseTable","page":1,"size":20},{"id":10118,"tableName":"hbaseTable","page":1,"size":20},{"id":10119,"tableName":"hbaseTable","page":1,"size":20},{"id":10120,"tableName":"hbaseTable","page":1,"size":20}]}
2019-09-27 10:46:01.689 DEBUG 15200 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] <--- END HTTP (595-byte body)

在日志中发现，header中没有被加上我之前设置的参数。说明该注解没有生效

于是debug调试

通过debug我发现feign会先将请求参数构建成Request对象，request信息如下：

使用feign服务调用添加Header参数

从图中可看到，该Request实例的headers属性为空，而Request又是根据RequestTemplate模板对象生成的，RequestTemplate实例信息如下：

使用feign服务调用添加Header参数

到这里可以看出，问题是出在RequestTemplate的构建构成中，于是我就去跟踪RequestTemplate构建的代码，发现RequestTemplate是根据MethodMetadata构建而成，而MethodMetadata就是对方法配置的抽象。

RequestTemplate template = resolve(argv, mutable, varBuilder);
      if (metadata.queryMapIndex() != null) {
        // add query map parameters after initial resolve so that they take
        // precedence over any predefined values
        template = addQueryMapQueryParameters(argv, template);
      }
 
      if (metadata.headerMapIndex() != null) {
        template = addHeaderMapHeaders(argv, template);
      }

从上述代码可以看到，header的设置是由metadata的headerMapIndex 属性决定的，那么，设置headerMapIndex的位置，必然就和Header的解析相关，于是通过查看方法引用，我找到了下面的代码：

private void parseHeaders(MethodMetadata md, Method method,
            RequestMapping annotation) {
        // TODO: only supports one header value per key
        if (annotation.headers() != null && annotation.headers().length > 0) {
            for (String header : annotation.headers()) {
                int index = header.indexOf('=');
                if (!header.contains("!=") && index >= 0) {
                    md.template().header(resolve(header.substring(0, index)),
                        resolve(header.substring(index + 1).trim()));
                }
            }
        }
    }

从代码中我们可以清晰的看到，解析过程中是从@RequestMapping或其派生注解的header属性中解析Header的，并且Header的key和value需要用“=”进行分割。

于是我修改成下面的形式，问题就解决了：

@FeignClient(name="name",url = "127.0.0.1:8090/test",path = "/",configuration = FeignConfig.class)
public interface IUserService {
 
    @RequestMapping(value = "getUserPage",method = RequestMethod.POST,headers = {"ContentType=application/x-www-form-urlencoded","Inner_token=PXH0dP5I8qQ8UbFPpzm67cQkm7j8tWT2Kwn6J6SXYkfp2kMo/lSqHQ=="})
    @Headers(value={"ContentType=application/x-www-form-urlencoded","Inner_token=PXH0dP5I8qQ8UbFPpzm67cQkm7j8tWT2Kwn6J6SXYkfp2kMo/lSqHQ=="})
    public Map<String,Object> getUserPage(User user);
}

查看请求日志

2019-09-27 11:10:29.975 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] ---> POST http://127.0.0.1:8090/test/getUserPage HTTP/1.1
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] ContentType: application/x-www-form-urlencoded
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] Inner_token: PXH0dP5I8qQ8UbFPpzm67cQkm7j8tWT2Kwn6J6SXYkfp2kMo/lSqHQ==
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] Content-Type: application/json;charset=UTF-8
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] Content-Length: 53
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage]
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] {"id":0,"tableName":"feignTable","page":10,"size":10}
2019-09-27 11:10:29.976 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] ---> END HTTP (53-byte body)
2019-09-27 11:10:29.992 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] <--- HTTP/1.1 200 (16ms)
2019-09-27 11:10:29.993 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] content-type: application/json;charset=UTF-8
2019-09-27 11:10:29.993 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] date: Fri, 27 Sep 2019 03:10:29 GMT
2019-09-27 11:10:29.993 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] transfer-encoding: chunked
2019-09-27 11:10:29.993 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] x-application-context: HelloServer:8090
2019-09-27 11:10:29.993 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage]
2019-09-27 11:10:29.995 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] {"success":true,"rows":[{"id":10141,"tableName":"hbaseTable","page":1,"size":20},{"id":10142,"tableName":"hbaseTable","page":1,"size":20},{"id":10143,"tableName":"hbaseTable","page":1,"size":20},{"id":10144,"tableName":"hbaseTable","page":1,"size":20},{"id":10145,"tableName":"hbaseTable","page":1,"size":20},{"id":10146,"tableName":"hbaseTable","page":1,"size":20},{"id":10147,"tableName":"hbaseTable","page":1,"size":20},{"id":10148,"tableName":"hbaseTable","page":1,"size":20},{"id":10149,"tableName":"hbaseTable","page":1,"size":20},{"id":10150,"tableName":"hbaseTable","page":1,"size":20}]}
2019-09-27 11:10:29.995 DEBUG 8604 --- [ hystrix-name-1] demo.IUserService : [IUserService#getUserPage] <--- END HTTP (595-byte body)

请求中header已经被成功添加~

以上为个人经验，希望能给大家一个参考，也希望大家多多支持三水点靠木~

使用feign服务调用添加Header参数

- Author -

精英丶阿琦

声明：登载此文出于传递更多信息之目的，并不意味着赞同其观点或证实其描述。

Java/Android 相关文章推荐
Java方法重载和方法重写的区别到底在哪?
Jun 11 Java/Android
SpringCloud Alibaba 基本开发框架搭建过程
Jun 13 Java/Android
HashMap实现保存两个key相同的数据
Jun 30 Java/Android
springboot如何接收application/x-www-form-urlencoded类型的请求
Nov 02 Java/Android
Java设计模式之享元模式示例详解
Mar 03 Java/Android
springboot+zookeeper实现分布式锁
Mar 21 Java/Android
Android基于Fresco实现圆角和圆形图片
Apr 01 Java/Android
Spring Boot接口定义和全局异常统一处理
Apr 20 Java/Android
Java中生成微信小程序太阳码的实现方案
Jun 01 Java/Android
Android Canvas绘制文字横纵向对齐
Jun 05 Java/Android
Java多线程并发FutureTask使用详解
Jun 28 Java/Android
利用Java连接Hadoop进行编程
Jun 28 Java/Android
详解Java实现数据结构之并查集
解决SpringCloud Feign传对象参数调用失败的问题
Jun 23 #Java/Android
详解Java实现设计模式之责任链模式
Jun 23 #Java/Android
Spring boot应用启动后首次访问很慢的解决方案
Java并发编程之详解CyclicBarrier线程同步
如何解决springcloud feign 首次调用100%失败的问题
分析设计模式之模板方法Java实现
OutputStream(1) persistedstate(1) vuex(1) 高动态范围(1) InputStream(1) HDR(1) Vue3(1) axios(1) 曝光融合(1) Set接口(1)
You might like
收听困难？教您超简便短波广播抗干扰方法！
2021/03/01 无线电
PHP similar_text 字符串的相似性比较函数
2010/05/26 PHP
php 上传文件类型判断函数(避免上传漏洞 )
2010/06/08 PHP
PHP迭代器的内部执行过程详解
2013/11/12 PHP
PHP采用curl模仿用户登陆新浪微博发微博的方法
2014/11/07 PHP
浅析PHP中的i++与++i的区别及效率
2016/06/15 PHP
PHP针对字符串开头和结尾的判断方法
2016/07/11 PHP
利用php_imagick实现复古效果的方法
2016/10/18 PHP
php实现购物车产品删除功能（2）
2020/07/23 PHP
jQuery autocomplete插件修改
2009/04/17 Javascript
利用jquery操作select下拉列表框的代码
2010/06/04 Javascript
基于jquery的web页面日期格式化插件
2011/11/15 Javascript
Bootstrap实现响应式导航栏效果
2015/12/28 Javascript
js 判断各种数据类型的简单方法(推荐)
2016/08/29 Javascript
jquery版轮播图效果和extend扩展
2017/07/18 jQuery
ligerUI---ListBox(列表框可移动的实例)
2017/11/28 Javascript
javascript 通过键名获取键盘的keyCode方法
2017/12/31 Javascript
小程序点击图片实现自动播放视频
2020/05/29 Javascript
JavaScript查看代码运行效率console.time()与console.timeEnd()用法
2019/01/18 Javascript
react 中父组件与子组件双向绑定问题
2019/05/20 Javascript
解决Can't find variable: SockJS vue项目的问题
2020/09/22 Javascript
原生js实现下拉框选择组件
2021/01/20 Javascript
Python自动化测试ConfigParser模块读写配置文件
2016/08/15 Python
PyQt4实现下拉菜单可供选择并打印出来
2018/04/20 Python
Python实现使用卷积提取图片轮廓功能示例
2018/05/12 Python
python实现将一维列表转换为多维列表(numpy+reshape)
2019/11/29 Python
HTML5未来发展趋势
2016/02/01 HTML / CSS
Expedia英国：全球最大的在线旅游公司
2017/09/07 全球购物
建材业务员岗位职责
2013/12/08 职场文书
2014三八妇女节活动总结范文四篇
2014/03/09 职场文书
计算机专业求职信
2014/06/02 职场文书
出国留学自荐信模板
2015/03/06 职场文书
OpenCV图像变换之傅里叶变换的一些应用
2021/07/26 Python
一篇文章带你学习Mybatis-Plus(新手入门)
2021/08/02 Java/Android
Python os和os.path模块详情
2022/04/02 Python
IDEA中sout快捷键无效问题的解决方法
2022/07/23 Java/Android