SpringCloudSpringBootmybatis分散式微服務雲架構（十二）返回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的文件。