脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring MVC获取HTTP请求头

Spring MVC获取HTTP请求头的两种方式小结

 更新时间：2021年01月26日 11:19:55   作者：南瓜慢说  
这篇文章主要介绍了Spring MVC获取HTTP请求头的两种方式小结，帮助大家更好的理解和使用Spring MVC，感兴趣的朋友可以了解下

1 前言

请求是任何Web服务要关注的对象，而请求头也是其中非常重要的信息。本文将通过代码讲解如何在Spring MVC项目中获取请求头的内容。主要通过两种方式获取：

（1）通过注解@RequestHeader获取，需要在Controller中显式获取；

（2）通过RequestContextHolder获取，可以任何地方获取。

接下来通过代码讲解。

2 通过注解@RequestHeader获取

需要在Controller中显示使用@RequestHeader。

2.1 获取某个请求头

只获取其中一个请求头，相当容易，代码如下：

@GetMapping("/webSite")
public String webSite(@RequestHeader("webSite")String webSite) {
 return "The webSite is " + webSite;
}

这里获取的是webSite这个请求头，测试如下：

$ curl http://localhost:8088/header/webSite -H 'webSite: www.pkslow.com'
The webSite is www.pkslow.com

我们查看@RequestHeader的源码，它还有其它属性，如下所示：

public @interface RequestHeader {
  @AliasFor("name")
  String value() default "";
  @AliasFor("value")
  String name() default "";
  boolean required() default true;
  String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";
}

2.1.1 属性required

required属性默认为true，如果不配置而客户端没有传递该请求头，会有报错。如果配置为false且没有请求头，值为null。代码如下：

@GetMapping("/webSite-not-required")
public String webSiteNotRequired(@RequestHeader(value = "webSite", required = false)String webSite) {
 return "The webSite is " + webSite;
}

测试结果如下：

$ curl http://localhost:8088/header/webSite-not-required -H 'webSite: www.pkslow.com'
The webSite is www.pkslow.com

$ curl http://localhost:8088/header/webSite-not-required
The webSite is null

2.1.2 属性defaultValue

defaultValue更容易理解，通过它来设置默认值。如果有传递则获取客户端传递的值，如果没有传递为默认值。代码如下：

@GetMapping("/webSite-defaultValue")
public String webSiteDefaultValue(@RequestHeader(value = "webSite", defaultValue = "pkslow.com")String webSite) {
 return "The webSite is " + webSite;
}

测试结果如下：

$ curl http://localhost:8088/header/webSite-defaultValue -H 'webSite: www.pkslow.com'
The webSite is www.pkslow.com

$ curl http://localhost:8088/header/webSite-defaultValue
The webSite is pkslow.com

2.2 获取所有请求头

注解@RequestHeader除了可以获取某个请求头，还可以一次性获取所有请求头，这时不需要指定名字。可以通过Map、MultiValueMap和HttpHeaders来获取所有请求头的值，示例代码如下：

@GetMapping("/allMap")
public Map<String, String> allMap(@RequestHeader Map<String, String> headers) {
 return headers;
}

@GetMapping("/allMultiValueMap")
public Map<String, String> allMultiValueMap(@RequestHeader MultiValueMap<String, String> headers) {
 return headers.toSingleValueMap();
}

@GetMapping("/allHttpHeaders")
public String allHttpHeaders(@RequestHeader HttpHeaders headers) {
 return headers.toString();
}

测试如下：

$ curl http://localhost:8088/header/allMap -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
{"host":"localhost:8088","user-agent":"curl/7.64.1","accept":"*/*","authorization":"Basic cGtzbG93OjEyMzQ1Ng==","website":"www.pkslow.com"}

$ curl http://localhost:8088/header/allMultiValueMap -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
{"host":"localhost:8088","user-agent":"curl/7.64.1","accept":"*/*","authorization":"Basic cGtzbG93OjEyMzQ1Ng==","website":"www.pkslow.com"}

$ curl http://localhost:8088/header/allHttpHeaders -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
[host:"localhost:8088", user-agent:"curl/7.64.1", accept:"*/*", authorization:"Basic cGtzbG93OjEyMzQ1Ng==", website:www.pkslow.com]

3 通过RequestContextHolder获取

通过RequestContextHolder来获取则可以在其它层获取。它先获取Request对象，再获取请求头。代码如下：

@GetMapping("/webSite-RequestContextHolder")
public String webSiteRequestContextHolder() {
 ServletRequestAttributes requestAttributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
 // get the request
 HttpServletRequest request = requestAttributes.getRequest();
 return "The webSite is " + request.getHeader("webSite");
}

测试如下：

$ curl http://localhost:8088/header/webSite-RequestContextHolder -H 'webSite: www.pkslow.com'
The webSite is www.pkslow.com

4 总结

以上两个方法，对于WebFlux而言，通过注解@RequestHeader获取是可行的；通过RequestContextHolder获取则不行，可参考【在Spring WebFlux的任何地方获取Request对象】。

代码请查看：https://github.com/LarryDpk/pkslow-samples

以上就是Spring MVC获取HTTP请求头的两种方式小结的详细内容，更多关于Spring MVC获取HTTP请求头的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Redis command timed out两种异常情况的解决方式

    Redis command timed out两种异常情况的解决方式

    Redis是我们开发中常用的数据库,下面这篇文章主要给大家介绍了关于Redis command timed out两种异常情况的解决方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-04-04
  • java String的intern方法

    java String的intern方法

    本文主要介绍java 中String 的intern方法,这里主要通过实例来说明不同版本的JDK,intern方法的对比,有需要的小伙伴可以参考下
    2016-07-07
  • spring是如何实现声明式事务的

    spring是如何实现声明式事务的

    这篇文章主要介绍了spring是如何实现声明式事务的,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • Java二维数组实现数字拼图效果

    Java二维数组实现数字拼图效果

    这篇文章主要为大家详细介绍了Java二维数组实现数字拼图效果，控制台可以对空格进行移动，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2021-07-07
  • 带你快速搞定java并发库

    带你快速搞定java并发库

    本文主要介绍了java高并发写入用户信息到数据库的几种方法，具有很好的参考价值。下面跟着小编一起来看下吧，希望能给你带来帮助
    2021-07-07
  • Spring中的两种代理JDK和CGLIB的区别浅谈

    Spring中的两种代理JDK和CGLIB的区别浅谈

    本篇文章中主要介绍了Spring中的两种代理JDK和CGLIB的区别浅谈，详解的介绍了JDK和CGLIB的原理和方法，有需要的朋友可以了解一下
    2017-04-04
  • 浅谈Java内存模型之happens-before

    浅谈Java内存模型之happens-before

    于存在线程本地内存和主内存的原因，再加上重排序，会导致多线程环境下存在可见性的问题。那么我们正确使用同步、锁的情况下，线程A修改了变量a何时对线程B可见？下面小编来简单介绍下
    2019-05-05
  • Netty分布式pipeline管道传播outBound事件源码解析

    Netty分布式pipeline管道传播outBound事件源码解析

    这篇文章主要介绍了Netty分布式pipeline管道传播outBound事件源码解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-03-03
  • Java实现的求解经典罗马数字和阿拉伯数字相互转换问题示例

    Java实现的求解经典罗马数字和阿拉伯数字相互转换问题示例

    这篇文章主要介绍了Java实现的求解经典罗马数字和阿拉伯数字相互转换问题,涉及java输入输出及字符串、数组的遍历与转换相关操作技巧,需要的朋友可以参考下
    2018-04-04
  • SpringBoot整合Dozer映射框架流程详解

    SpringBoot整合Dozer映射框架流程详解

    dozer是用来两个对象之间属性转换的工具，有了这个工具之后，我们将一个对象的所有属性值转给另一个对象时，就不需要再去写重复的set和get方法了，下面介绍下SpringBoot中Dozer的使用，感兴趣的朋友一起看看吧
    2022-07-07

最新评论