脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → 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请求头的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • SpringBoot中Zookeeper分布式锁的原理和用法详解

    SpringBoot中Zookeeper分布式锁的原理和用法详解

    Zookeeper是一个分布式协调服务，它提供了高可用、高性能、可扩展的分布式锁机制，SpringBoot是一个基于Spring框架的开发框架，它提供了对Zookeeper分布式锁的集成支持，本文将介绍SpringBoot中的 Zookeeper分布式锁的原理和使用方法,需要的朋友可以参考下
    2023-07-07
  • 基于Struts文件上传(FormFile)详解

    基于Struts文件上传(FormFile)详解

    下面小编就为大家带来一篇基于Struts文件上传(FormFile)详解。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • java异常机制分析

    java异常机制分析

    这篇文章主要介绍了java异常机制,包括异常机制的捕获、抛出及常见的异常机制总结,需要的朋友可以参考下
    2014-09-09
  • Java下载项目中静态文件方式

    Java下载项目中静态文件方式

    这篇文章主要介绍了Java下载项目中静态文件方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • 解决ThingsBoard编译报错问题:Failure to find org.gradle:gradle-tooling-api:jar:6.3

    解决ThingsBoard编译报错问题:Failure to find org.gradle:gradle-too

    这篇文章主要介绍了ThingsBoard编译报错:Failure to find org.gradle:gradle-tooling-api:jar:6.3,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-03-03
  • java实现二分法的完整代码

    java实现二分法的完整代码

    这篇文章主要为大家详细介绍了java实现二分法的完整代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-11-11
  • SpringBoot实现elasticsearch 查询操作(RestHighLevelClient 的案例实战)

    SpringBoot实现elasticsearch 查询操作(RestHighLevelClient 

    这篇文章主要给大家介绍了SpringBoot如何实现elasticsearch 查询操作，文中有详细的代码示例和操作流程，具有一定的参考价值,需要的朋友可以参考下
    2023-07-07
  • Java中Stream流的常用方法代码示例

    Java中Stream流的常用方法代码示例

    这篇文章主要介绍了Java中Stream流的常用方法代码示例,Stream类中每一个方法都对应集合上的一种操作,将真正的函数式编程引入到Java中,能 让代码更加简洁,极大地简化了集合的处理操作,提高了开发的效率和生产力,需要的朋友可以参考下
    2023-10-10
  • 代码详解java里的“==”和“equels”区别

    代码详解java里的“==”和“equels”区别

    本篇文章通过实例代码给大家详细解释了java里的“==”和“equels”区别，对此有兴趣的朋友跟着小编一起学习下。
    2018-02-02
  • JAVA加密算法数字签名实现原理详解

    JAVA加密算法数字签名实现原理详解

    这篇文章主要介绍了JAVA加密算法数字签名实现原理详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10

最新评论