如何在Spring Boot中将异常抛回JSON

Question

我有一个请求-

  @RequestMapping("/fetchErrorMessages")
  public @ResponseBody int fetchErrorMessages(@RequestParam("startTime") String startTime,@RequestParam("endTime") String endTime) throws Exception
  {
      if(SanityChecker.checkDateSanity(startTime)&&SanityChecker.checkDateSanity(endTime))
      {
          return 0;
      }
      else
      {
          throw new NotFoundException("Datetime is invalid");
      }
  }

如果开始时间和结束时间无效，我想抛出一个500错误，但在JSON中返回异常字符串。然而，我得到一个超文本标记语言页面，而不是说

白标错误页面

此应用程序没有/error的显式映射，因此您将其视为一种回退。

Wed Dec20 10:49:37IST 2017
出现意外错误（type=内部服务器错误，状态=500）。
Datetime无效

相反，我想用JSON返回500

{"error":"Date time format is invalid"}

我该怎么做？

Answer 1

您可以使用@ResponseStatus注释创建NotFoundException类，如下所示：

@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public class NotFoundException extends RuntimeException {
   public NotFoundException() {
   }

   public NotFoundException(String message) {
    super(message);
   }

}

Answer 2

创建自定义异常。

public class SecurityException extends RuntimeException {

    private static final long serialVersionUID = -7806029002430564887L;

    private String message;

    public SecurityException() {
    }

    public SecurityException(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

创建自定义响应实体。

public class SecurityResponse {

    private String error;

    public SecurityResponse() {

    }

    public SecurityResponse(String error) {
        this.error = error;
    }

    public String getError() {
        return error;
    }

    public void setError(String error) {
        this.error = error;
    }

}

为自定义异常创建一个ControllerAdvice with ExceptionHandler，它将处理自定义异常，填充并返回自定义响应，如下所示。

@ControllerAdvice
public class SecurityControllerAdvice {

    @ExceptionHandler(SecurityException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public SecurityResponse handleSecurityException(SecurityException se) {
        SecurityResponse response = new SecurityResponse(se.getMessage());
        return response;
    }
}

根据您的条件引发自定义异常。

throw new SecurityException("Date time format is invalid");

现在运行并测试你的应用程序。例如：

Answer 3

假设您有一个自定义异常类NotFoundException，其实现如下：

public class NotFoundException extends Exception {

    private int errorCode;
    private String errorMessage;

    public NotFoundException(Throwable throwable) {
        super(throwable);
    }

    public NotFoundException(String msg, Throwable throwable) {
        super(msg, throwable);
    }

    public NotFoundException(String msg) {
        super(msg);
    }

    public NotFoundException(String message, int errorCode) {
        super();
        this.errorCode = errorCode;
        this.errorMessage = message;
    }


    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }

    public String getErrorMessage() {
        return errorMessage;
    }

    @Override
    public String toString() {
        return this.errorCode + " : " + this.getErrorMessage();
    }
}

现在你想从控制器抛出一些异常。如果你抛出一个异常，那么你必须从一个标准的错误处理程序类中捕捉它，例如在Spring，他们提供了@Controlller建议注释来应用于创建一个类标准错误处理程序。当它应用于一个类时，这个Spring组件（我是说你注释的类）可以捕捉从控制器抛出的任何异常。但是我们需要用正确的方法映射异常类。所以我们用你的异常NotFoundExctive处理程序定义了一个方法，如下所示。

@ControllerAdvice
public class RestErrorHandler {

    @ExceptionHandler(NotFoundException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public Object processValidationError(NotFoundException ex) {
        String result = ex.getErrorMessage();
        System.out.println("###########"+result);
        return ex;
    }
}

您希望将http状态发送到内部服务器错误（500），因此这里我们使用了@ResponseStatus（HttpStatus.internal_server_error）。因为您使用了Spring boot，所以不需要生成json字符串，只需要一个简单的注释@ResponseBody就可以自动生成json字符串。