Spring Cloud Spring Boot mybatis分佈式微服務雲架構(十二)返回JSON格式

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

本質上,只需在@ExceptionHandler以後加入@ResponseBody,就能讓處理函數return的內容轉換爲JSON格式。app

下面以一個具體示例來實現返回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  
      
    }

    建立一個自定義異常,用來實驗捕獲該異常,並返回jsonurl

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

    Controller中增長json映射,拋出MyException異常code

  • @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的文檔。get

相關文章
相關標籤/搜索