瑞吉外卖中r类的作用

在瑞吉外卖项目中，R 类通常用于封装响应结果，以便在控制器层返回统一的响应格式。通过利用 R 类，可以确保所有 API 返回的数据格式同等，便于前端分析和处理。这种设计模式在实际开发中非常常见，有助于提高代码的可维护性和可读性。
主要作用

• 封装响应结果：将响应数据和状态信息封装在一起，形成一个尺度的响应格式。
  
• 统一响应格式：确保所有 API 返回的数据格式同等，便于前端分析。
  
• 简化控制器层代码：通过 R 类提供的静态方法，可以在控制器层快速返反响应结果，减少重复代码。
  

示例代码

假设 R 类的定义如下：

1. package com.itheima.reggie.utils;
3. import lombok.Data;
5. import java.util.HashMap;
6. import java.util.Map;
8. /**
9. * 统一响应结果类
10. */
11. @Data
12. public class R<T> {
13.     private Integer code; // 响应码
14.     private String msg;   // 响应消息
15.     private T data;       // 响应数据
16.     private Map<String, Object> map = new HashMap<>(); // 扩展数据
18.     // 成功响应
19.     public static <T> R<T> success(T data) {
20.         R<T> r = new R<>();
21.         r.setCode(200);
22.         r.setMsg("成功");
23.         r.setData(data);
24.         return r;
25.     }
27.     // 成功响应（无数据）
28.     public static <T> R<T> success() {
29.         return success(null);
30.     }
32.     // 失败响应
33.     public static <T> R<T> error(String msg) {
34.         R<T> r = new R<>();
35.         r.setCode(500);
36.         r.setMsg(msg);
37.         return r;
38.     }
40.     // 失败响应（自定义状态码和消息）
41.     public static <T> R<T> error(Integer code, String msg) {
42.         R<T> r = new R<>();
43.         r.setCode(code);
44.         r.setMsg(msg);
45.         return r;
46.     }
48.     // 添加扩展数据
49.     public R<T> add(String key, Object value) {
50.         this.map.put(key, value);
51.         return this;
52.     }
53. }

复制代码

详细解释

• 属性：
  
  
  
  • code：响应码，用于标识请求的状态。
    
  • msg：响应消息，用于描述请求的结果。
    
  • data：响应数据，用于返回详细的业务数据。
    
  • map：扩展数据，用于返回额外的信息。
    
  
  
• 构造方法：
  
  
  
  • R 类没有显式的构造方法，通过静态方法创建实例。
    
  
  
• 静态方法：
  
  
  
  • success(T data)：创建一个成功的响应结果，包罗数据。
    
  • success()：创建一个成功的响应结果，不包罗数据。
    
  • error(String msg)：创建一个失败的响应结果，包罗错误消息。
    
  • error(Integer code, String msg)：创建一个失败的响应结果，包罗自定义的状态码和错误消息。
    
  
  
• 扩展数据：
  
  
  
  • add(String key, Object value)：添加扩展数据，返回当前对象，支持链式调用。
    
  
  

利用示例

在控制器类中，可以通过 R 类提供的静态方法快速返反响应结果：

1. package com.itheima.reggie.controller;
3. import com.itheima.reggie.entity.Employee;
4. import com.itheima.reggie.service.EmployeeService;
5. import com.itheima.reggie.utils.R;
6. import org.springframework.beans.factory.annotation.Autowired;
7. import org.springframework.web.bind.annotation.*;
9. @RestController
10. @RequestMapping("/employee")
11. public class EmployeeController {
13.     @Autowired
14.     private EmployeeService employeeService;
16.     @PostMapping("/login")
17.     public R<Employee> login(@RequestBody Employee employee) {
18.         // 处理登录逻辑...
19.         String password = employee.getPassword();
20.         password = DigestUtils.md5DigestAsHex(password.getBytes(StandardCharsets.UTF_8));
22.         LambdaQueryWrapper<Employee> queryWrapper = new LambdaQueryWrapper<>();
23.         queryWrapper.eq(Employee::getUsername, employee.getUsername());
24.         Employee emp = employeeService.getOne(queryWrapper);
26.         if (emp == null) {
27.             return R.error("用户不存在");
28.         }
30.         if (!emp.getPassword().equals(password)) {
31.             return R.error("密码不正确");
32.         }
34.         if (emp.getStatus() == 0) {
35.             return R.error("账号已禁用");
36.         }
38.         return R.success(emp);
39.     }
41.     @PostMapping("/register")
42.     public R<String> register(@RequestBody Employee employee) {
43.         // 检查用户名是否已存在
44.         if (employeeService.checkUsernameExists(employee.getUsername())) {
45.             return R.error("用户名已存在");
46.         }
48.         // 设置默认密码并加密
49.         employee.setPassword(DigestUtils.md5DigestAsHex("123456".getBytes(StandardCharsets.UTF_8)));
51.         // 保存新用户
52.         employeeService.save(employee);
54.         return R.success("注册成功").add("userId", employee.getId());
55.     }
56. }

复制代码

总结

R 类的主要作用是封装响应结果，确保所有 API 返回的数据格式同等。通过利用 R 类提供的静态方法，可以在控制器层快速返反响应结果，减少重复代码，提高代码的可维护性和可读性。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。