springboot如何获取header中的信息呢?

下文笔者讲述SpringBoot获取header请求头信息的方法说明,如下所示

SpringBoot获取header请求头的实现思路

 使用`@RequestHeader`注解
     `HttpServletRequest`对象
	  或
	  `HttpHeaders` 对象
 即可获取header请求头信息
 
 =======三种获取header方式简述
`@RequestHeader`注解:
    适用于获取单个请求头信息，简单直接
`HttpServletRequest`对象:
    适用于需要处理所有请求头信息或进行复杂操作的场景
`HttpHeaders`对象:
    提供更方便的方法来处理请求头信息
	  适用于需要处理多个相同名称头信息的场景

例

使用`@RequestHeader`注解

`@RequestHeader`注解
   用于从HTTP请求头中提取特定的头信息
    并将其作为方法参数传递给控制器方法

例

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HeaderController {

    @GetMapping("/header")
    public String getHeader(@RequestHeader("User-Agent") String userAgent) {
        return "User-Agent: " + userAgent;
    }
}

代码相关说明

- `@RequestHeader("User-Agent")`:
    指定要提取的请求头名称 
- `String userAgent`:
    将提取的头信息绑定到方法参数`userAgent` 

Controller获取header信息

@GetMapping("/header")
public String getHeader(@RequestHeader(value = "User-Agent", required = false, defaultValue = "Unknown") String userAgent) {
    return "User-Agent: " + userAgent;
}

使用`HttpServletRequest`对象

通过注入`HttpServletRequest`对象
   可以获取请求头中的所有信息

例

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

@RestController
public class HeaderController {

    @GetMapping("/header")
    public String getHeader(HttpServletRequest request) {
        String userAgent = request.getHeader("User-Agent");
        return "User-Agent: " + userAgent;
    }
}

代码说明

- `HttpServletRequest request`
    使用`request.getHeader("User-Agent")`获取指定请求头信息

获取所有请求头

可使用`getHeaderNames()`方法获取所有请求头名称
 然后逐个获取对应的值 
@GetMapping("/headers")
public String getHeaders(HttpServletRequest request) {
    StringBuilder headers = new StringBuilder();
    Enumeration<String> headerNames = request.getHeaderNames();
    while (headerNames.hasMoreElements()) {
        String headerName = headerNames.nextElement();
        String headerValue = request.getHeader(headerName);
        headers.append(headerName).append(": ").append(headerValue).append("\n");
    }
    return headers.toString();
}

使用`HttpHeaders`对象

`HttpHeaders` 对象提供了更方便的方法来处理请求头信息。

例

import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HeaderController {

    @GetMapping("/header")
    public String getHeader(HttpHeaders headers) {
        String userAgent = headers.getFirst("User-Agent");
        return "User-Agent: " + userAgent;
    }
}

获取所有请求头

可使用 `toSingleValueMap()` 方法
获取所有请求头的键值对

@GetMapping("/headers")
public String getHeaders(HttpHeaders headers) {
    StringBuilder headersInfo = new StringBuilder();
    headers.toSingleValueMap().forEach((key, value) -> {
        headersInfo.append(key).append(": ").append(value).append("\n");
    });
    return headersInfo.toString();
}

处理多个相同名称的头信息

可使用`getHeaders`方法获取所有值

例

import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.list;

@RestController
public class HeaderController {

    @GetMapping("/cookies")
    public String getCookies(HttpHeaders headers) {
        List<String> cookies = headers.get("Cookie");
        if (cookies != null) {
            return String.join(", ", cookies);
        }
        return "No cookies found";
    }
}

========相关说明=======
- `headers.get("Cookie")`:
   获取所有名为`Cookie`头信息列表