谷粒学苑项目-第一章统一返回结果对象-1.5

小咪咪 2023-10-07 22:35 31阅读 0赞

## **一、统一返回数据格式** ##

项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一， 使前端(iOS Android, Web)对数据的操作更一致、轻松。

一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容

例如，我们的系统要求返回的基本数据格式如下：

**列表：**

{
      "success": true,
      "code": 20000,
      "message": "成功",
      "data": {
        "items": [
          {
            "id": "1",
            "name": "刘德华",
            "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
          }
        ]
      }
    }

**分页：**

> \{  
> "success": true,  
> "code": 20000,  
> "message": "成功",  
> "data": \{  
> "total": 17,  
> "rows": \[  
> \{  
> "id": "1",  
> "name": "刘德华",  
> "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"  
> \}  
> \]  
> \}  
> \}

**没有返回数据：**

> \{  
> "success": true,  
> "code": 20000,  
> "message": "成功",  
> "data": \{\}  
> \}

**失败：**

> \{  
> "success": false,  
> "code": 20001,  
> "message": "失败",  
> "data": \{\}  
> \}

因此，我们定义统一结果

> \{  
> "success": 布尔, //响应是否成功  
> "code": 数字, //响应码  
> "message": 字符串, //返回消息  
> "data": HashMap //返回数据，放在键值对中  
> \}

## 二、创建统一返回结果类 ##

### 1、在common模块下创建子模块common-utils ###

### 2、创建接口定义返回码 ###

**创建包com.atguigu.commonutils，创建接口 ResultCode.java**

public interface ResaultCode {
        public static Integer SUCCESS = 20000;
        public static Integer ERROR = 20001;
    }

### 3、创建结果类 ###

@Data
    public class Resault {
        private boolean success;
        private Integer code;
        private String message;
        private Map<String,Object> data= new HashMap<String,Object>();
    
        private Resault(){}
    
        public static Resault ok(){
            Resault resault = new Resault();
            resault.setSuccess(true);
            resault.setCode(ResaultCode.SUCCESS);
            resault.setMessage("成功");
            return resault;
        }
    
        public static Resault error(){
            Resault resault = new Resault();
            resault.setSuccess(false);
            resault.setCode(ResaultCode.ERROR);
            resault.setMessage("失败");
            return resault;
        }
    
        public Resault success(boolean success){
            this.setSuccess(success);
            return this;
        }
    
        public Resault code(Integer code){
            this.setCode(code);
            return this;
        }
        public Resault message(String message){
            this.setMessage(message);
            return this;
        }
        public Resault data(Map<String,Object> map){
            this.setData(map);
            return this;
        }
        public Resault data(String key,Object value){
            this.data.put(key,value);
            return this;
        }
    }

## 三、统一返回结果使用 ##

### 1、在service模块中添加依赖 ###

<dependency>
          <groupId>com.atguigu</groupId>
          <artifactId>common_utils</artifactId>
          <version>0.0.1-SNAPSHOT</version>
    </dependency>

### 2、修改Controller中的返回结果 ###

@RestController
    @RequestMapping("/eduservice/teacher")
    public class EduTeacherController {
    
        @Autowired
        private EduTeacherService eduTeacherService;
    
        @ApiOperation("查找全部功能")
        @GetMapping("/findall")
        public Resault findAll(){
            List<EduTeacher> list = eduTeacherService.list();
            return Resault.ok().data("items",list);
        }
    
        @ApiOperation("逻辑删除功能")
        @DeleteMapping("{id}") //{id}表示id值通过路径传递
        public Resault removeById(@PathVariable("id") String id){
            boolean flag = eduTeacherService.removeById(id);
            if(flag){
                return Resault.ok();
            }else {
                return Resault.error();
            }
        }
    }