Spring 注解面面通之 @RequestHeader_requestheader注解的作用-CSDN博客

@RequestHeader注解用于Spring MVC框架中，将HTTP请求头中的数据映射到控制器方法的参数上。本文详细介绍了该注解的属性及使用方法，并通过示例展示了如何以Map和单个键值对的形式解析请求头。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@RequestHeader用于将Web请求头中的数据映射到控制器处理方法的参数中。

注解解析

① value:

绑定的参数名称，参数值为String类型。

② name:

绑定的参数名称，参数值为String类型。name和value可以同时使用，但两者的值需一致，否则会出现错误。

attribute 'name' and its alias 'value' are present with values of [XXX] and [XXX], but only one is permitted

③ required:

请求头中是否必须包含指定的值，默认值为true。

required为true时，如果请求头中缺少指定的值，则会抛出异常。

required为false时，如果请求头中缺少指定的值，则会返回null。

④ defaultValue：

请求头变量绑定失败时的默认值，指定默认值后，会隐式的将required设置为false。

注解示例

1) 建Controller，用来演示@RequestHeader使用方法。

package com.arhorchin.securitit.webannotations;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

import com.alibaba.fastjson.JSON;

/**
 * @author Securitit.
 * @note 演示@RequestHeader使用方法.
 */
@Controller
@RequestMapping("/WebAnnotations")
public class RequestHeaderController {

    /**
     * logger.
     */
    private Logger logger = LoggerFactory.getLogger(RequestHeaderController.class);

    /**
     * 跳转页面.
     */
    @RequestMapping(
            value = "/RequestHeader.html",
            method = RequestMethod.GET)
    public ModelAndView requestHeaderHtml(HttpServletRequest req, HttpServletResponse res, ModelMap modelMap)
            throws Exception {
        return new ModelAndView("webannotations/RequestHeader", modelMap);
    }

    /**
     * 从请求头以Map解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestHeaderMap.do",
            method = RequestMethod.GET)
    public String requestHeaderMap(@RequestHeader Map<String, String> requestHeaderMap) throws Exception {
        logger.info("Current value of RequestHeader is " + JSON.toJSONString(requestHeaderMap));
        return "Current value of RequestHeader is " + JSON.toJSONString(requestHeaderMap);
    }

    /**
     * 从请求头以单键值形式解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestHeaderSingle.do",
            method = RequestMethod.GET)
    public String requestHeaderSingle(@RequestHeader(
            value = "Host") String requestHeaderHost) throws Exception {
        logger.info("Current value of RequestHeader [Host] is " + requestHeaderHost);
        return "Current value of RequestHeader [Host] is " + requestHeaderHost;
    }

    /**
     * 从请求头以单键值形式解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestHeaderSingleRequiredTrue.do",
            method = RequestMethod.GET)
    public String requestHeaderSingleRequiredTrue(@RequestHeader(
            value = "Tmp-Header",
            required = true) String requestHeaderTmpHeader) throws Exception {
        logger.info("Current value of RequestHeader [Tmp-Header] is " + requestHeaderTmpHeader);
        return "Current value of RequestHeader [Tmp-Header] is " + requestHeaderTmpHeader;
    }

    /**
     * 从请求头以单键值形式解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestHeaderSingleRequiredFalse.do",
            method = RequestMethod.GET)
    public String requestHeaderSingleRequiredFalse(@RequestHeader(
            value = "Tmp-Header",
            required = false) String requestHeaderTmpHeader) throws Exception {
        logger.info("Current value of RequestHeader [Tmp-Header] is " + requestHeaderTmpHeader);
        return "Current value of RequestHeader [Tmp-Header] is " + requestHeaderTmpHeader;
    }

}

2) 建html，用来演示RequestHeaderController示例。

<!doctype html>
<html lang="en">
	<head>
		<meta charset="UTF-8">
		<meta name="Author" content="Securitit">
		<meta name="Keywords" content="-">
		<meta name="Description" content="Securitit @RequestHeader 测试页面">
		<title>@RequestHeader 测试页面</title>
	</head>
	<body>
		<a href="http://localhost:9199/spring-annotations/WebAnnotations/RequestHeaderMap.do" target="_blank">点击链接，@RequestHeader进行参数绑定，后端以Map解析方法参数.</a>
		<br />
		<br />
		<a href="http://localhost:9199/spring-annotations/WebAnnotations/RequestHeaderSingle.do" target="_blank">点击链接，@RequestHeader进行参数绑定，以单键值形式解析方法参数.</a>
		<br />
		<br />
		<a href="http://localhost:9199/spring-annotations/WebAnnotations/RequestHeaderSingleRequiredTrue.do" target="_blank">点击链接，@RequestHeader进行参数绑定，后端指定required=true，以单键值形式解析方法参数.</a>
		<br />
		<br />
		<a href="http://localhost:9199/spring-annotations/WebAnnotations/RequestHeaderSingleRequiredFalse.do" target="_blank">点击链接，@RequestHeader进行参数绑定，后端指定required=true，以单键值形式解析方法参数.</a>
	</body>
</html>