java - 将正文添加到 404 Not Found 异常

Question

在使用 JHipster 生成的 REST API 中，我想抛出一些 404 异常。通常用

return new ResponseEntity<>(HttpStatus.NOT_FOUND);

这实际上会导致对 xhr 请求的 404 响应。问题是在前端，JHipster 用

解析响应

angular.fromJson(result)

当 404 是实际响应时，这样的结果为空，这使得解析失败。

如果我指向一个未映射的 URI，让我们说 /api/user 而我的 Controller 映射到 /api/users (注意复数)我从API 中有一个主体:

{
    "timestamp": "2016-04-25T18:33:19.947+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/api/user/myuser/contact"
}

在角度上正确解析。

如何创建这样的主体？这个异常是spring抛的还是tomcat抛的？

我试过这个:Trigger 404 in Spring-MVC controller?但我无法设置响应的参数。

Answer 1

基本思路

---

第一个选项是定义错误对象并将它们作为 404 Not Found 正文返回。类似以下内容:

Map<String, String> errors = ....;
return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errors);

您可以抛出一个Exception，而不是返回典型的ResponseEntity，该异常将被解析为404 Not Found。假设您有一个 NotFoundException，例如:

@ResponseStatus(code = HttpStatus.NOT_FOUND)
public class NotFoundException extends RuntimeException {}

然后如果你在你的 Controller 中抛出这个异常，你会看到类似的东西:

{  
   "timestamp":1461621047967,
   "status":404,
   "error":"Not Found",
   "exception":"NotFoundException",
   "message":"No message available",
   "path":"/greet"
}

如果你想自定义消息和正文的其他部分，你应该为NotFoundException定义一个ExceptionHandler。

引入异常层次结构

---

如果您正在创建一个 RESTful API 并希望针对不同的异常情况使用不同的错误代码和错误消息，您可以创建一个异常层次结构来表示这些情况并从每一个中提取消息和代码。

例如，您可以引入一个异常，比如 APIException，它是您的 Controller 抛出的所有其他异常的父类(super class)。此类定义代码/消息对，如:

public class APIException extends RuntimeException {
    private final int code;
    private final String message;

    APIException(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int code() {
        return code;
    }

    public String message() {
        return message;
    }
}

每个子类都可以根据异常的性质为这对提供一些合理的值。例如，我们可以有一个 InvalidStateException:

@ResponseStatus(code = HttpStatus.BAD_REQUEST)
public class InvalidStateException extends APIException {
    public InvalidStateException() {
        super(1, "Application is in invalid state");
    }
}

或者那个臭名昭著的未发现的:

@ResponseStatus(code = HttpStatus.NOT_FOUND)
public class SomethingNotFoundException extends APIException {
    public SomethingNotFoundException() {
        super(2, "Couldn't find something!");
    }
}

然后我们应该定义一个 ErrorController 来捕获这些异常并将它们转换为有意义的 JSON 表示。该错误 Controller 可能如下所示:

@RestController
public class APIExceptionHandler extends AbstractErrorController {
    private static final String ERROR_PATH = "/error";
    private final ErrorAttributes errorAttributes;

    @Autowired
    public APIExceptionHandler(ErrorAttributes errorAttributes) {
        super(errorAttributes);
        this.errorAttributes = errorAttributes;
    }

    @RequestMapping(path = ERROR_PATH)
    public ResponseEntity<?> handleError(HttpServletRequest request) {
        HttpStatus status = getStatus(request);

        Map<String, Object> errors = getErrorAttributes(request, false);
        getApiException(request).ifPresent(apiError -> {
            errors.put("message" , apiError.message());
            errors.put("code", apiError.code());
        });
        // If you don't want to expose exception!
        errors.remove("exception");


        return ResponseEntity.status(status).body(errors);
    }

    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }

    private Optional<APIException> getApiException(HttpServletRequest request) {
        RequestAttributes attributes = new ServletRequestAttributes(request);
        Throwable throwable = errorAttributes.getError(attributes);
        if (throwable instanceof APIException) {
            APIException exception = (APIException) throwable;
            return Optional.of(exception);
        }

        return Optional.empty();
    }
}

因此，如果您抛出 SomethingNotFoundException，返回的 JSON 将类似于:

{  
   "timestamp":1461621047967,
   "status":404,
   "error":"Not Found",
   "message":"Couldn't find something!",
   "code": 2,
   "path":"/greet"
}