博客

SpringBoot2中使用@RequestHeader获取请求头的方法

  • Post category:http

下面是详细讲解“SpringBoot2中使用@RequestHeader获取请求头的方法”的完整攻略：

什么是@RequestHeader

@RequestHeader 是 Spring 提供的用于获取请求头信息的注解，被标注的参数值会自动从 HTTP 头中获取值。通常需要用到的头信息包括：Accept，Accept-Language，Accept-Encoding，User-Agent，Host，Connection 等等。使用 @RequestHeader 注解可以轻松获取到这些信息。

使用方式

在方法参数中使用 @RequestHeader 注解即可获取请求头信息

@RequestMapping("/")
@ResponseBody
public String index(@RequestHeader("Accept-Encoding") String encoding) {
    return "Hello World" + encoding;
}

上述代码中，我们获取了 Accept-Encoding 头信息。

如果请求中不存在该头信息，可以通过设置 required 属性来控制是否抛出异常。

@RequestMapping("/")
@ResponseBody
public String index(@RequestHeader(value = "Accept-Encoding", required = false) String encoding) {
    if (encoding == null) {
        encoding = "no encoding specified";
    }
    return "Hello World" + encoding;
}

必须在方法参数列表中注解必须以常规参数形式出现，不能用于像类或者返回值这样的位置。

示例代码

下面我们通过两个例子来演示 @RequestHeader 的使用。

示例一： 通过 @RequestHeader 注解获取实际 IP 地址。

@RequestMapping(value = "/test")
public String test(@RequestHeader(value = "X-Forwarded-For", required = false) String ip) {
    if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
        ip = request.getRemoteAddr();
    }
    return "IP:" + ip;
}

通过 X-Forwarded-For 请求头可以获取到客户端的真实 IP 地址，这对于需要统计用户量的应用非常有帮助。

示例二： 通过 @RequestHeader 注解获取 User-Agent 信息。

@RequestMapping(value = "/hello")
public String hello(@RequestHeader(value = "user-agent") String userAgent) {
    return "Hello，我是一台" + userAgent;
}

通过 user-agent 请求头可以获取到客户端的浏览器类型和操作系统类型。

总结

通过上述示例，我们可以得知，使用 @RequestHeader 注解获取请求头信息非常方便，可以解决很多实际问题，提高开发效率。最后提醒一下，有些请求头信息可能是存在安全风险的，使用时需要格外注意。

Tags: