java接口controller接口获取headers中的参数 controller获取请求头

转载

编程小天才 2023-12-29 11:37:29

1. 引言

本教程中，将展示如何从REST Controller中获取HTTP 请求头。我将使用 @RequestHeader注解分别来获取单个Header和所有Header，然后将深入了解下 @RequestHeader的属性。

2. 获取Header

2.1. 获取单个Header

如果我们要获取具体的Header，可以在 @RequestHeader指定对应的Header名称。

@GetMapping("/greeting")	
public ResponseEntity<String> greeting(@RequestHeader("accept-language") String language) {	
    // code that uses the language variable	
    return new ResponseEntity<String>(greeting, HttpStatus.OK);	
}

然后我们可以在方法中使用该变量的名称来获取请求头的值，以上代码中，如果 accept-language无法在请求头中找到，则会返回 400BadRequest错误。当然，请求头不一定非要是字符串。例如，如果知道请求头的值是数字，可以将变量声明为数字类型。

@GetMapping("/double")	
public ResponseEntity<String> doubleNumber(@RequestHeader("my-number") int myNumber) {	
    return new ResponseEntity<String>(String.format("%d * 2 = %d", 	
      myNumber, (myNumber * 2)), HttpStatus.OK);	
}

2.2. 一次获取所有Header

如果不确定哪些Header会被使用，或者想要使用某些未在方法中声明的header，那么在使用 @RequestHeader注解时，不指定名称即可。可以使用诸如 Map, MultiValueMap，或者 HttpHeader对象来接收变量，有很多种选择。先看下使用 Map来接收。

@GetMapping("/listHeaders")	
public ResponseEntity<String> listAllHeaders(@RequestHeader Map<String, String> headers) {	
    headers.forEach((key, value) -> {	
        LOG.info(String.format("Header '%s' = %s", key, value));	
    });	
    return new ResponseEntity<String>(String.format("Listed %d headers", headers.size()), HttpStatus.OK);	
}

如果使用 Map，则当某个 Header有多个值时，只能拿到第一个值。这等价于我们使用 MultiValueMap时，调用 getFirst方法。如果 Header中有多个参数，可以使用 MultiValueMap来接收参数值。

@GetMapping("/multiValue")	
public ResponseEntity<String> multiValue(@RequestHeader MultiValueMap<String, String> headers) {	
    headers.forEach((key, value) -> {	
        LOG.info(String.format("Header '%s' = %s", key, value.stream().collect(Collectors.joining("|"))));	
    });	
    return new ResponseEntity<String>(String.format("Listed %d headers", headers.size()), HttpStatus.OK);	
}

也可以使用 HttpHeader对象：

@GetMapping("/getBaseUrl")	
public ResponseEntity<String> getBaseUrl(@RequestHeader HttpHeaders headers) {	
    InetSocketAddress host = headers.getHost();	
    String url = "http://" + host.getHostName() + ":" + host.getPort();	
    return new ResponseEntity<String>(String.format("Base URL = %s", url), HttpStatus.OK);	
}

HttpHeader对象中可以访问应用的一些公共请求头。使用以上三种方式来获取请求头时，如果 Header不存在，将会返回 null值。

3. @RequestHeader的属性

我们已经学习了使用 @RequestHeader注解访问请求头的基础知识，现在来进一步了解它的属性。

当我们指定Header是，实际上已经隐式地使用了 name或 value属性。

public ResponseEntity<String> greeting(@RequestHeader("accept-language") String language) {	
}

当然也可以用 name属性：

public ResponseEntity<String> greeting(@RequestHeader(name = "accept-language") String language) {	
}

同样地可以使用 value属性：

public ResponseEntity<String> greeting(@RequestHeader(value = "accept-language") String language) {	
}

但我们明确地指定某个 Header的名称时，默认这个 Header是必需的，如果请求中不存在，将会发生 400错误。可以使用 required属性来表明某个 Header不是必需的。

@GetMapping("/nonRequiredHeader")	
public ResponseEntity<String> evaluateNonRequiredHeader(	
  @RequestHeader(value = "optional-header", required = false) String optionalHeader) {	
    return new ResponseEntity<String>(	
      String.format("Was the optional header present? %s!", (optionalHeader == null ? "No" : "Yes")), 	
      HttpStatus.OK);	
}

当某个 Header不存在时，我们声明的变量可能为 null值，因此，程序中要适当对 null值进行检查。或者使用 defaultValue提供默认的header值。

@GetMapping("/default")	
public ResponseEntity<String> evaluateDefaultHeaderValue(	
  @RequestHeader(value = "optional-header", defaultValue = "3600") int optionalHeader) {	
    return new ResponseEntity<String>(String.format("Optional Header is %d", optionalHeader), 	
    HttpStatus.OK);	
}