Каков предпочтительный способ указать HTTP-заголовок ответа «Расположение» в Spring MVC 3?

Question

Какой предпочтительный способ указать HTTP-заголовок ответа «Расположение» в Spring MVC 3?

Насколько я могу судить, Spring предоставит «Location» только в ответ на перенаправление («redirect: xyz» или RedirectView), однако существуют сценарии, когда Location следует отправлять вместе с телом объекта (например , в результате "201 Created").

Боюсь, мой единственный вариант - указать его вручную:

httpServletResponse.setHeader("Location", "/x/y/z");

Это правильно? Есть ли лучший способ решения этой проблемы?

Answer 1

Начиная с весны 3.1, лучший способ обработать Локацию - использовать параметр UriComponentBuilder и установить для него возвращенное значение ResponseEntity.UriComponentBuilder знает контекст и манипулирует относительными путями:

@RequestMapping(method = RequestMethod.POST)
public ResponseEntity<?> createCustomer(UriComponentsBuilder b) {

    UriComponents uriComponents = 
        b.path("/customers/{id}").buildAndExpand(id);

    HttpHeaders headers = new HttpHeaders();
    headers.setLocation(uriComponents.toUri());
    return new ResponseEntity<Void>(headers, HttpStatus.CREATED);
}

Начиная с версии 4.1, вы можете сделать его еще короче

@RequestMapping(method = RequestMethod.POST)
public ResponseEntity<?> createCustomer(UriComponentsBuilder b) {

    UriComponents uriComponents = 
        b.path("/customers/{id}").buildAndExpand(id);

    return ResponseEntity.created(uriComponents.toUri()).build();
}

Благодаря Дитеру Хубау за указание на это.

Answer 2

Следующий пример взят из весеннего урока:

@RequestMapping(method = RequestMethod.POST)
ResponseEntity<?> add(@PathVariable String userId, @RequestBody Bookmark input) {
    this.validateUser(userId);

    return this.accountRepository
            .findByUsername(userId)
            .map(account -> {
                Bookmark result = bookmarkRepository.save(new Bookmark(account,
                        input.uri, input.description));

                URI location = ServletUriComponentsBuilder
                    .fromCurrentRequest().path("/{id}")
                    .buildAndExpand(result.getId()).toUri();

                return ResponseEntity.created(location).build();
            })
            .orElse(ResponseEntity.noContent().build());

}

Обратите внимание, что следующий код будет вычислять путь контекста (URI) для вас, чтобы избежать дублирования кода и сделать ваше приложение более переносимым:

ServletUriComponentsBuilder
                    .fromCurrentRequest().path("/{id}")

Answer 3

Это старый вопрос, но вот что вы можете сделать, если хотите, чтобы Spring действительно создала для вас URI.

@RestController
@RequestMapping("/api/v1")
class JobsController {

  @PostMapping("/jobs")
  fun createJob(@RequestParam("use-gpu") useGPU: Boolean?): ResponseEntity<Unit> {

    val headers = HttpHeaders()

    val jobId = "TBD id"

    headers.location =
            MvcUriComponentsBuilder
                    .fromMethodName(JobsController::class.java, "getJob", jobId)
                    .buildAndExpand(jobId)
                    .toUri()

    return ResponseEntity(headers, HttpStatus.CREATED)
  }

  @GetMapping("/job/{jobId}")
  fun getJob(@PathVariable jobId: String) = ... // fetch job
}

В этом примере (который написан на Kotlin, но похож на java), базовый URI равен /api/v1 (определен в верхней части класса). Использование MvcUriComponentsBuilder.fromMethodName call позволяет Spring определить правильный полный URI. (MvcUriComponentsBuilder было добавлено в 4.0).

Answer 4

Согласно: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30

Абсолютный URI должен использоваться:

Location       = "Location" ":" absoluteURI  

И URI должен быть правильно экранирован:

http://www.ietf.org/rfc/rfc2396.txt

Answer 5

Ваш подход кажется нормальным, но чтобы сохранить его в чистоте, вы можете поместить код в пользовательский HandlerInterceptor, который срабатывает только при наличии HTTP 201, например.

См. здесь для получения дополнительной информации.