在 Spring Boot 中处理无效的 PathVariables

Question

假设我有一个 GET 控制器 /api/product/{id} ，其中 id 是一个整数。 处理具有非整数 ID 的请求的最佳方法是什么？ 目前 Spring 只是抛出一个 java.lang.NumberFormatException 并返回一个 400。

Answer 1

您可以进行路径变量验证，假设 id 应该是正整数值。

@GetMapping("/api/product/{id}")
public void getProduct(@PathVariable("id") @Min(value = 0) Integer id) {
    // ...
}

在此处阅读以上请求验证的更多信息。

如果您知道产品 ID 具有一定范围的 int 值，您甚至可以尝试@Range 。

Answer 2

鉴于您声明id是整数，400 响应似乎合适。

如果您反对 Spring 对它的处理，您可以始终将路径变量设置为字符串，自己检查数字，然后静默地返回 400 或您想要的任何其他响应。

@GetMapping("/api/product/{id}")
public ResponseEntity<Product> getProduct(@PathVariable("id") String s) {
    try {
       int id = Integer.parseInt(s);
       // valid integer id here, do normal work ...
    }
    catch(NumberFormatException nfe) {
       return ResponseEntity.status(400).build(); // or whatever error code you want
    }
}

Answer 3

假设我有一个 GET 控制器 /api/product/{id} ，其中 id 是一个整数。 处理具有非整数 ID 的请求的最佳方法是什么？

如果/api/product/abcde是没有当前表示的资源，那么您可能应该返回404 Not Found ，并在消息正文中解释错误。

状态代码是元数据，状态代码的目标受众是理解“通过网络传输文档”域的通用组件。 在这里，您希望引起注意 target-uri 的拼写，而 404 是这样做的合适方法。

410 Gone可能是 404 的合理替代。

404 状态代码并不表示这种缺乏表示是暂时的还是永久的； 如果源服务器知道（大概是通过某种可配置的方式）该条件可能是永久性的，则 410（消失）状态代码比 404 更受欢迎。

410 响应的主要目的是通过通知接收者资源故意不可用以及服务器所有者希望删除到该资源的远程链接来协助 Web 维护任务。 这种事件对于限时促销服务和属于不再与源服务器站点关联的个人的资源来说很常见。 没有必要将所有永久不可用的资源标记为“消失”或将标记保留任何时间长度——这由服务器所有者自行决定。

请注意， 404和410都是“默认可缓存的”，这可能是您在这种情况下想要的。