Springboot接口返回值的统一格式

• springboot 默认情况下的返回数据类型包括以下几种：

  • String型 ：返回字符串

    @GetMapping(value="/getstr/{id}")
    public String getstr(@PathVariable("id") Integer id){
           
        ...
        return "index";
    }
    

  • Object型：返回一个Json表示对象

    @GetMapping(value="/getObject")
    public UserVO getObject(){
           
        UserVO vo=new UserVO();
        vo.setUsername("agan");
        return vo;
    }
    

  • void型：返回空值

    @GetMapping(value="/empty")
    public void  empty(){
           
    
    }
    

  • Exception型：返回错误信息或异常信息

    @GetMapping(value="/error")
    public void  error(  ){
           
        int i=9/0;
    }
    

    如下：

    {
      "timestamp": "2019-09-07T10:35:56.658+0000",
      "status": 500,
      "error": "Internal Server Error",
      "message": "/ by zero",
      "path": "/user/error"
    } 
    

若是所有的接口按照以上四种方式实现，当你和客户端开发人员联调接口，会造成很大的麻烦，因为这些接口返回值没有统一的格式，客户端开发人员处理返回值将无从下手。

所以我们应该统一 response 标准格式。

• 对 response 代码封装（使用一个网上的常用案例）

  • 创建用于统一处理返回值的