Spring Cloud Spring Boot mybatis分布式微服务云架构 返回JSON格式

在上述例子中,经过@ControllerAdvice统必定义不一样Exception映射到不一样错误处理页面。而当咱们要实现RESTful API时,返回的错误是JSON格式的数据,而不是HTML页面,这时候咱们也能轻松支持。java

本质上,只需在@ExceptionHandler以后加入@ResponseBody,就能让处理函数return的内容转换为JSON格式。json

下面以一个具体示例来实现返回JSON格式的异常处理。app

  • 建立统一的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异常url

@Controller  
public class HelloController {  
  
    @RequestMapping("/json")  
    public String json() throws MyException {  
        throw new MyException("发生错误2");  
    }  
  
}

MyException异常建立对应的处理code

@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的文档。文档

相关文章
相关标签/搜索