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

    • 源码来源

  • 相关阅读:
    Write File in Vugen
    2016.5.15 随笔————查看class 的 Jad 反编译插件安装
    2016.5.15 随笔————Tomcat 配置文件 server.xml
    2016.5.10 随笔——Jmeter架入 java中使用 说明
    2016.5.10 随笔——SQL语句
    怎么和小孩一起玩--科学之旅:给孩子一场纯粹的玩耍(图)
    三味书屋 bbb
    亚信数据的组织结构
    深度学习的几个关键点
    数据可视化产品
  • 原文地址:https://www.cnblogs.com/allalongx/p/8513167.html
Copyright © 2020-2023  润新知