Как читать заголовки HTTP в контроллерах Spring REST

1. Обзор

В этом кратком руководстве мы рассмотрим, как получить доступ к заголовкам HTTP в Spring Rest Controller .

Во-первых, мы будем использовать аннотацию @RequestHeader для чтения заголовков как по отдельности, так и все вместе.

После этого мы более подробно рассмотрим атрибуты @RequestHeader .

2. Доступ к заголовкам HTTP

2.1. Индивидуально

Если нам нужен доступ к определенному заголовку, мы можем настроить @RequestHeader с именем заголовка :

@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 не найден в запросе, метод возвращает ошибку «400 Bad Request».

Наши заголовки не обязательно должны быть строками. Если мы знаем, что наш заголовок является числом, мы можем объявить нашу переменную как числовой тип:

@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. Все сразу

Если мы не уверены, какие заголовки будут присутствовать, или нам нужно их больше, чем мы хотим в сигнатуре нашего метода, мы можем использовать аннотацию @RequestHeader без определенного имени.

У нас есть несколько вариантов для типа нашей переменной: Map , MultiValueMap или объект HttpHeaders .

Во-первых, давайте получим заголовки запроса в виде карты :

@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 и один из заголовков имеет более одного значения, мы получим только первое значение. Это эквивалентно использованию метода getFirst для MultiValueMap .

Если наши заголовки могут иметь несколько значений, мы можем получить их как 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);
}

Мы также можем получить наши заголовки как объект HttpHeaders :

@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);
}

Объект HttpHeaders имеет средства доступа для общих заголовков приложений.

Когда мы получаем доступ к заголовку по имени из Map , MultiValueMap или объекта HttpHeaders , мы получим null , если он отсутствует.

3. Атрибуты @RequestHeader

Теперь, когда мы рассмотрели основы доступа к заголовкам запросов с помощью аннотации @RequestHeader , давайте подробнее рассмотрим его атрибуты.

Мы уже неявно использовали атрибуты 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) {}

Когда мы специально называем заголовок, заголовок требуется по умолчанию. Если заголовок в запросе не найден, контроллер возвращает ошибку 400.

Давайте используем обязательный атрибут, чтобы указать, что наш заголовок не требуется:

@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);
}

Поскольку наша переменная будет нулевой , если заголовок не присутствует в запросе , мы должны обязательно выполнить соответствующую проверку нулевого значения .

Давайте используем атрибут defaultValue , чтобы указать значение по умолчанию для нашего заголовка:

@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);
}

4. Вывод

В этом кратком руководстве мы узнали, как получить доступ к заголовкам запросов в контроллерах Spring REST.

Во-первых, мы использовали аннотацию @RequestHeader для предоставления заголовков запросов нашим методам контроллера.

Изучив основы, мы подробно рассмотрели атрибуты аннотации @RequestHeader .

Код примера доступен на GitHub .