Spring 使用 @RequestHeader 获取请求头常用方式

1、获取单个请求头

例如，获取 user-id 请求头

1. @RequestMapping("/getSingleHeader")
2. public Map<String, Object> getSingleHeader(@RequestHeader("user-id") String userId){
3. Map<String, Object> result = new HashMap<>();
4. result.put("code", 0);
5. result.put("msg", "success");
6. result.put("userId", userId);
7. return result;
8. }

测试

1. curl -X POST \
2. http://127.0.0.1:8080/getSingleHeader \
3. -H 'user-id: A10010'

2、一次性获取所有请求头

方式一：使用 Map 接收所有请求头

1. @RequestMapping("/getAllHeaders")
2. public Map<String, Object> listAllHeaders(@RequestHeader Map<String, String> headers) {
3. Map<String, Object> result = new HashMap<>();
4. headers.forEach((key, value) -> {
5. // 日志中输出所有请求头
6. System.out.println(String.format("Header '%s' = %s", key, value));
7. });
8. result.put("code", 0);
9. result.put("msg", "success");
10. result.put("headers", headers);
11. return result;
12. }

测试

1. curl -X POST \
2. http://127.0.0.1:8080/getAllHeaders \
3. -H 'company-id: 1001' \
4. -H 'user-id: A10010'

日志打印

1. Header 'host' = 127.0.0.1:8080
2. Header 'connection' = keep-alive
3. Header 'content-length' = 0
4. Header 'user-id' = A10010
5. Header 'company-id' = 1001

方式二：使用 MultiValueMap 接收所有请求头

1. @RequestMapping("/listHeaders")
2. public Map<String, Object> listHeaders(@RequestHeader MultiValueMap<String, String> headers) {
3. Map<String, Object> result = new HashMap<>();
4. headers.forEach((key, value) -> {
5. // 日志中输出所有请求头
6. System.out.println(String.format("Header '%s' = %s", key, value));
7. });
8. result.put("code", 0);
9. result.put("msg", "success");
10. result.put("headers", headers);
11. return result;
12. }

测试

1. curl -X POST \
2. http://127.0.0.1:8080/listHeaders \
3. -H 'company-id: 1001' \
4. -H 'user-id: A10010'

日志打印

1. Header 'host' = [127.0.0.1:8080]
2. Header 'connection' = [keep-alive]
3. Header 'content-length' = [0]
4. Header 'user-id' = [A10010]
5. Header 'company-id' = [1001]

可以发现如果一个请求头存在多个值的时，可以使用 MultiValueMap 接收所有请求头。查看 MultiValueMap 源码，发现 MultiValueMap 实现了 Map<K, List<V>> 

方式三：使用 HttpHeaders 接收所用请求头

1. @RequestMapping("/getAllHttpHeaders")
2. public Map<String, Object> getAllHttpHeaders(@RequestHeader HttpHeaders headers) {
3. headers.forEach((key, value) -> {
4. // 日志中输出所有请求头
5. System.out.println(String.format("getAllHttpHeaders '%s' = %s", key, value));
6. });
7. Map<String, Object> result = new HashMap<>();
8. result.put("code", 0);
9. result.put("msg", "success");
10. result.put("headers", headers);
11. return result;
12. }

测试

1. curl -X POST \
2. http://127.0.0.1:8080/getAllHttpHeaders \
3. -H 'company-id: 1001' \
4. -H 'user-id: A10010'

日志打印

1. getAllHttpHeaders 'host' = [127.0.0.1:8080]
2. getAllHttpHeaders 'connection' = [keep-alive]
3. getAllHttpHeaders 'content-length' = [0]
4. getAllHttpHeaders 'user-id' = [A10010]
5. getAllHttpHeaders 'company-id' = [1001]

查看 HttpHeaders 源码发现 MultiValueMap<String, String>
如果在项目中需要接收多个请求，使用 MultiValueMap 和 HttpHeaders 的选择，可以节省参数个数，使得代码整洁；当然，如果就接受一两个请求头，直接使用 RequestHeader 注解就可以。