在使用JHipster生成的REST API中,我想抛出一些404异常。通常用
完成return new ResponseEntity<>(HttpStatus.NOT_FOUND);
实际上导致对xhr请求的404响应。问题是,在正面,JHipster用
解析响应angular.fromJson(result)
,当404是实际响应时,这样的结果为空,这使得解析失败。
如果我指向一个未映射的URI,当我的控制器映射到/api/user
(注意复数)时,我们说/api/users
我从API获得的404中有一个正文:
{
"timestamp": "2016-04-25T18:33:19.947+0000",
"status": 404,
"error": "Not Found",
"message": "No message available",
"path": "/api/user/myuser/contact"
}
正确解析角度。
如何创建这样的身体?春天是抛出这个例外还是扔掉它的tomcat?
我试过这个:Trigger 404 in Spring-MVC controller?但我无法设置响应的参数。
答案 0 :(得分:13)
第一个选项是定义错误对象并将它们作为404 Not Found
正文返回。如下所示:
Map<String, String> errors = ....;
return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errors);
您可以抛出将ResponseEntity
解析为Exception
的{{1}},而不是返回典型的404 Not Found
。假设你有一个NotFoundException
:
@ResponseStatus(code = HttpStatus.NOT_FOUND)
public class NotFoundException extends RuntimeException {}
然后,如果你在控制器中抛出这个异常,你会看到类似的东西:
{
"timestamp":1461621047967,
"status":404,
"error":"Not Found",
"exception":"NotFoundException",
"message":"No message available",
"path":"/greet"
}
如果您要自定义消息和正文的其他部分,则应为ExceptionHandler
定义NotFoundException
。
如果您正在创建RESTful API并希望针对不同的例外情况使用不同的错误代码和错误消息,则可以创建表示这些情况的异常层次结构并从每个提取消息和代码。
例如,您可以引入一个例外,例如APIException
,它是控制器抛出的所有其他异常的超类。该类定义了一个代码/消息对,如:
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表示。该错误控制器可能如下所示:
@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"
}
答案 1 :(得分:0)
如果您想要返回一些消息或使用您的错误代码进行测试
,我想您可以这样做result.Cuotas