在 Spring MVC 3 中指定 HTTP“位置”响应标头的首选方法是什么？
据我所知，Spring 只会提供一个“位置”来响应重定向（“redirect:xyz”或 RedirectView），但是在某些情况下，位置应该与实体主体一起发送（例如，作为“201 Created”的结果）。
恐怕我唯一的选择是手动指定它：
httpServletResponse.setHeader("Location", "/x/y/z");
这是正确的吗？有没有更好的方法来解决这个问题？
【问题讨论】：
标签： java rest spring-mvc
关键是使用UriComponentsBuilder。
有几种方法可以获取它的实例
UriComponentsBuilder 来自 MvcUriComponentsBuilder
UriComponentsBuilder 作为方法的参数注入UriComponentsBuilder 来自 MvcUriComponentsBuilder
通过这种方式，您可以获得UriComponentsBuilder，该UriComponentsBuilder 被配置为生成URI，它指向一些具有预定义参数的控制器方法。
这是来自javadoc 的MvcUriComponentsBuilder 示例：
例如，给定这个控制器：
@RequestMapping("/people/{id}/addresses")
class AddressController {
@RequestMapping("/{country}")
public HttpEntity<Void> getAddressesForCountry(@PathVariable String country) { ... }
@RequestMapping(value="/", method=RequestMethod.POST)
public void addAddress(Address address) { ... }
}
可以创建一个 UriComponentsBuilder：
// Inline style with static import of "MvcUriComponentsBuilder.on"
MvcUriComponentsBuilder.fromMethodCall(
on(AddressController.class).getAddressesForCountry("US")).buildAndExpand(1);
有时可能更可取的另一个选项是按名称指定控制器方法：
UriComponents uriComponents = MvcUriComponentsBuilder.fromMethodName(
AddressController.class, "getAddressesForCountry", "US").buildAndExpand(1);
URI nextUri = uriComponents.toUri();
UriComponentsBuilder 作为方法的参数注入从 spring 3.1 开始，Location 可以使用 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();
}
感谢 Dieter Hubau 指出这一点。
【讨论】：
return ResponseEntity.created(uriComponents.toUri()).build();
UriComponentsBuilder 被注入了吗？可以是@Autowired吗？
以下示例来自spring教程：
@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}")
【讨论】：
这是一个老问题，但如果你想让 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 调用可以让Spring 找出正确的完整URI。 （MvcUriComponentsBuilder 是在 4.0 中添加的）。
【讨论】：
根据：http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30
应该使用绝对URI：
Location = "Location" ":" absoluteURI
URI 应该正确转义：
【讨论】：
您的方法看起来不错，但为了保持简洁，您可以将代码放在自定义 HandlerInterceptor 中，例如，该代码仅在存在 HTTP 201 时触发。
更多信息请参见here。
【讨论】：