ChronicDisease_SpringBoot/docs/Dev/common目录文件说明.md

common 目录文件说明

在 src/main/java/work/baiyun/chronicdiseaseapp/common 目录下包含了项目中的通用类，这些类为整个应用程序提供基础的数据结构和响应格式。

Page.java

用途

Page 类是一个通用分页数据封装类，用于包装分页查询的结果，便于统一返回分页数据给前端。

实现细节

• 使用了泛型 <T>，可以适用于任何类型的数据列表
• 包含以下属性：
  • pageNum: 当前页码
  • pageSize: 每页大小
  • total: 数据总数
  • list: 当前页数据列表
• 构造函数接收页码、页面大小和数据列表作为参数
• 内部使用 com.github.pagehelper.PageInfo 来计算总记录数等分页信息
• 使用了 Lombok 注解 @Getter 和 @Setter 自动生成 getter 和 setter 方法

使用场景

主要用于所有需要分页功能的业务模块，如用户数据、健康数据等的分页查询结果返回。

R.java

用途

R 类是统一响应结果封装类，用于标准化 API 接口的返回格式，包含成功和失败两种情况的处理方法。

实现细节

• 使用了泛型 <T>，可以封装任意类型的数据
• 包含以下属性：
  • code: 响应状态码
  • message: 响应消息
  • data: 响应数据
  • timestamp: 时间戳（毫秒）
  • requestId: 请求 ID，用于追踪原始请求
  • traceId: 链路追踪 ID，用于分布式追踪
• 提供了四个静态方法来创建响应对象：
  • success(Integer code, String message): 创建无数据的成功响应
  • success(Integer code, String message, T data): 创建带数据的成功响应
  • fail(Integer code, String message): 创建无数据的失败响应
  • fail(Integer code, String message, T data): 创建带数据的失败响应
• 使用 TraceUtils 工具类获取 requestId 和 traceId 信息
• 使用了 Lombok 注解 @Data 自动生成 getter、setter、toString 等方法

使用场景

用于所有对外暴露的 RESTful API 接口，确保接口返回格式的一致性，方便前端处理。