Java 中怎么使用 @RequestHeader 获取 HTTP 请求头信息

梦丽君_7477

梦丽君_7477

2026-10-15

438人浏览

原创

@requestheader用于绑定http请求头到控制器参数,支持直接映射、可选配置(required=false+defaultvalue)、批量获取(map或httpheaders)及类型转换(含枚举、日期等)。

java 中怎么使用 @requestheader 获取 http 请求头信息

在 Spring MVC 中,@RequestHeader 是一个用于绑定 HTTP 请求头(Header)到控制器方法参数的注解。它能方便地提取客户端发送的请求头字段,比如 Authorization、User-Agent、Content-Type 等。

基本用法:直接映射请求头字段

最常见的方式是将请求头名称作为注解的 value 值,Spring 会自动从当前 HTTP 请求中提取对应 Header 的值,并尝试转换为参数类型:

  • 如果请求头存在且可转换(如字符串、数字、枚举),则赋值成功
  • 如果请求头不存在,默认会抛出 MissingRequestHeaderException

示例:

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
@GetMapping("/api/data")
public String getData(@RequestHeader("User-Agent") String userAgent) {
    return "User-Agent: " + userAgent;
}

设置默认值与可选性

使用 required = false 可让该 Header 成为可选;再配合 defaultValue,可以避免空值判断:

  • required = false 表示即使请求没带这个头,也不报错
  • defaultValue = "unknown" 在头缺失或为空时提供默认值

示例:

@GetMapping("/api/log")
public String logInfo(@RequestHeader(value = "X-Trace-ID", required = false, defaultValue = "N/A") String traceId) {
    return "Trace ID: " + traceId;
}

批量获取所有请求头

如果需要读取全部 Header,可以把参数类型设为 Map<string string></string> 或 HttpHeaders:

  • Map<string string></string>:只保留每个 Header 的第一个值(适用于单值 Header)
  • HttpHeaders:Spring 封装类,支持多值 Header(如 Accept 可能有多个值),推荐用于复杂场景

示例(使用 HttpHeaders):

@GetMapping("/api/headers")
public String showAllHeaders(HttpHeaders headers) {
    return headers.toSingleValueMap().toString();
}

类型转换与自定义解析

Spring 默认支持常见类型的自动转换(如 Long、Boolean、Enum)。若需特殊格式(如时间戳、自定义编码),可:

  • 添加 @DateTimeFormat 处理日期字符串
  • 实现 Converter<string yourtype></string> 并注册到 WebMvcConfigurer
  • 对枚举类型,确保 Header 值与 name() 或 @JsonValue 匹配

示例(枚举):

public enum ApiVersion { V1, V2 }

@GetMapping("/api/resource")
public String getResource(@RequestHeader("X-API-Version") ApiVersion version) {
    return "Using version: " + version;
}

此时请求需携带 X-API-Version: V1 才能正确绑定。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10457

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7582

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6632

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1376

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2749

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20071

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1215

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习