Spring Boot教程（二十五）返回JSON格式

在上述例子中，通過@ControllerAdvice統一定義不同Exception映射到不同錯誤處理頁面。而當我們要實現RESTful API時，返回的錯誤是JSON格式的數據，而不是HTML頁面，這時候我們也能輕松支持。

本質上，只需在@ExceptionHandler之后加入@ResponseBody，就能讓處理函數return的內容轉換為JSON格式。

下面以一個具體示例來實現返回JSON格式的異常處理。

• 創建統一的JSON返回對象，code：消息類型，message：消息內容，url：請求的url，data：請求返回的數據

  public class ErrorInfo<T> {
  
      public static final Integer OK = 0;
      public static final Integer ERROR = 100;
  
      private Integer code;
      private String message;
      private String url;
      private T data;
  
      // 省略getter和setter
  
  }
  

  　　

   

• 創建一個自定義異常，用來實驗捕獲該異常，並返回json

  public class MyException extends Exception {
  
      public MyException(String message) {
          super(message);
      }
      
  }
  

  　　

   

• Controller中增加json映射，拋出MyException異常

  @Controller
  public class HelloController {
  
      @RequestMapping("/json")
      public String json() throws MyException {
          throw new MyException("發生錯誤2");
      }
  
  }

   

• 為MyException異常創建對應的處理

  @ControllerAdvice
  public class GlobalExceptionHandler {
  
      @ExceptionHandler(value = MyException.class)
      @ResponseBody
      public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
          ErrorInfo<String> r = new ErrorInfo<>();
          r.setMessage(e.getMessage());
          r.setCode(ErrorInfo.ERROR);
          r.setData("Some Data");
          r.setUrl(req.getRequestURL().toString());
          return r;
      }
  
  }

• 啟動應用，訪問：http://localhost:8080/json，可以得到如下返回內容：

• {
      code: 100，
      data: "Some Data"，
      message: "發生錯誤2"，
      url: "http://localhost:8080/json"
  }
  

  　　

  至此，已完成在Spring Boot中創建統一的異常處理，實際實現還是依靠Spring MVC的注解，更多更深入的使用可參考Spring MVC的文檔。

• 源碼來源