如何将我的应用程序设置为仅返回 ResponseStatusException 消息？

Question

Spring Boot默认不返回任何异常的消息，包括ResponseStatusException，也就是说下面关于bar的消息不会返回给客户端：

    @GetMapping("/foo")
    @ResponseBody
    public Foo getFoo(@RequestParam(name = "bar", defaultValue = "0") int bar) {
        if (bar <= 0) {
            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "bar must always be positive");
        }
        return example.getFoo(bar);
    }

这可以通过在application.properties 中设置server.error.include-message=always 来更改，但是这会导致所有异常消息都返回给客户端，包括这个：

    @GetMapping("/baz")
    @ResponseBody
    public Baz getBaz() {
        if (!security.checkSecurity()) {
            throw new RuntimeException("Security breach! Hope no one finds out!");
        }
        return example.getBaz();
    }

我知道这是一个简单的示例，解决方案只是“不要从控制器抛出服务器异常”，但异常实际上可能来自深埋在应用程序中的其他代码，甚至可能是 @ 987654328@ 或其他。

如何让应用程序仅显示来自ResponseStatusException 的消息而不显示其他类型的异常？ （我想除了在每个控制器方法中添加 try-catch 子句之外。）

Answer 1

您可以向任何控制器添加额外的 (@ExceptionHandler) 方法，以专门处理同一控制器中的请求处理 (@RequestMapping) 方法引发的异常。此类方法可以：

• 处理不带 @ResponseStatus 注释的异常（通常是您未编写的预定义异常）
• 将用户重定向到专用错误视图
• 构建完全自定义的错误响应

控制器建议允许您使用完全相同的异常处理技术，但将它们应用于整个应用程序，而不仅仅是单个控制器。您可以将它们视为注释驱动的拦截器。

使用@ControllerAdvice 注解的任何类都成为控制器建议，并支持三种类型的方法：

• 用@ExceptionHandler注解的异常处理方法。
• 用@ModelAttribute 注释的模型增强方法（用于向模型添加附加数据）。请注意，这些属性不适用于异常处理视图。
• Binder 初始化方法（用于配置表单处理）注释为 @InitBinder。

---

解决方案：

@ControllerAdvice
public class RestControllerAdvice {

  @ExceptionHandler(ResponseStatusException.class)
  public ResponseEntity<String> handleStatusException(ResponseStatusException exception) {
    throw exception;
  }

  @ExceptionHandler(Exception.class)
  public ResponseEntity<String> handleException(Exception exception) {
    return new ResponseEntity<>("Exception", HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

Answer 2

捕获所有异常并在 catch 块中抛出 ResponseStatusException，如下所示：

@GetMapping("/actor/{id}")
public String getActorName(@PathVariable("id") int id) {
    try {
        return actorService.getActor(id);
    } catch (ActorNotFoundException ex) {
        throw new ResponseStatusException(
          HttpStatus.NOT_FOUND, "Actor Not Found", ex);
    }
}