doc(common): 优化统一响应和工具类注释

2026-01-06 15:50:36 +08:00
parent d38196cb6e
commit 327e983c46
11 changed files with 510 additions and 302 deletions
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/GlobalResponse.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/GlobalResponse.java
@@ -4,69 +4,121 @@ import java.util.List;
 import java.util.Map;

 /**
- * 全局响应对象
+ * 全局统一API响应封装类
 * <p>
- * 该类用于统一封装API接口的响应结果，提供标准化的响应格式。
- * 通过状态码、消息和数据三个字段，清晰地表达请求的处理结果。
+ * 该类用于统一封装RESTful API接口的响应结果，提供标准化的响应格式。
+ * 通过状态码、消息和数据三个字段，清晰地表达请求的处理结果，便于前端统一处理。
 * </p>
 *
- * <p>
- * 响应格式示例:
+ * <h3>设计特点</h3>
+ * <ul>
+ *   <li>使用Java Record实现，不可变，线程安全</li>
+ *   <li>泛型设计，支持任意类型的数据封装</li>
+ *   <li>提供丰富的静态工厂方法，简化响应对象创建</li>
+ *   <li>支持分页查询、详情查询等常见场景</li>
+ * </ul>
+ *
+ * <h3>响应格式示例</h3>
+ * <p><b>成功响应（无数据）:</b></p>
+ * <pre>
+ * {
+ *   "status": 0,
+ *   "message": "OK",
+ *   "data": null
+ * }
+ * </pre>
+ *
+ * <p><b>成功响应（带数据）:</b></p>
+ * <pre>
+ * {
+ *   "status": 0,
+ *   "message": "操作成功",
+ *   "data": {
+ *     "id": 1,
+ *     "name": "示例数据"
+ *   }
+ * }
+ * </pre>
+ *
+ * <p><b>分页列表响应:</b></p>
 * <pre>
 * {
 *   "status": 0,
 *   "message": "OK",
 *   "data": {
- *     "items": [...],
- *     "total": 10
+ *     "items": [
+ *       {"id": 1, "name": "数据1"},
+ *       {"id": 2, "name": "数据2"}
+ *     ],
+ *     "total": 100
 *   }
 * }
 * </pre>
- * </p>
 *
- * <p>
- * 使用说明:
+ * <p><b>错误响应:</b></p>
+ * <pre>
+ * {
+ *   "status": 500,
+ *   "message": "系统异常，请稍后重试",
+ *   "data": null
+ * }
+ * </pre>
+ *
+ * <h3>使用场景</h3>
 * <ul>
- *   <li>成功响应: 使用 responseSuccess() 系列方法</li>
- *   <li>错误响应: 使用 responseError() 系列方法</li>
- *   <li>CRUD操作: 使用 responseListData() 方法返回列表数据</li>
- *   <li>详情查询: 使用 responseDetailData() 方法返回单条记录</li>
+ *   <li><b>RESTful API:</b> 作为所有API接口的标准响应格式</li>
+ *   <li><b>前后端分离:</b> 前端可统一处理成功/失败逻辑</li>
+ *   <li><b>微服务架构:</b> 服务间调用的标准化响应</li>
+ *   <li><b>移动端接口:</b> 移动端APP的统一数据格式</li>
 * </ul>
- * </p>
 *
- * @param <T>     响应数据的类型
- * @param status  响应状态码，0表示成功，500表示错误，其他值可根据业务需求扩展
+ * @param <T>     响应数据的类型，可以是任意对象、集合、Map或包装类
+ * @param status  响应状态码
+ *                <ul>
+ *                  <li>0 - 成功</li>
+ *                  <li>500 - 服务器错误</li>
+ *                  <li>其他 - 业务自定义状态码</li>
+ *                </ul>
 * @param message 响应消息，对状态码的简短描述，如"OK"、"ERROR"或具体的错误信息
 * @param data    响应数据，具体的业务数据，可以是任意类型。对于列表查询，通常封装为包含items和total的Map；对于详情查询，直接返回对象或Map
+ *
+ * @see #responseSuccess()
+ * @see #responseError()
+ * @see #responseListData(Iterable, Long)
+ * @see #responseDetailData(Object)
 */
 public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
-   * 成功状态码
+   * 成功状态码 - 表示请求处理成功
   */
  private static final int SUCCESS_STATUS = 0;

  /**
-   * 错误状态码
+   * 错误状态码 - 表示服务器内部错误或业务异常
   */
  private static final int ERROR_STATUS = 500;

  /**
-   * 成功默认消息
+   * 成功默认消息 - 用于通用成功响应
   */
  private static final String SUCCESS_MESSAGE = "OK";

  /**
-   * 错误默认消息
+   * 错误默认消息 - 用于通用错误响应
   */
  private static final String ERROR_MESSAGE = "ERROR";

  /**
   * 返回默认错误响应
   * <p>
-   * 使用默认错误消息"ERROR"，状态码500，数据为null
+   * 使用默认错误消息"ERROR"，状态码500，数据为null。
+   * 适用于无法确定具体错误原因的通用异常场景。
   * </p>
   *
-   * @return 错误响应对象
+   * @return 错误响应对象，格式：{status: 500, message: "ERROR", data: null}
+   *
+   * @see #responseError(String)
+   * @see #responseSuccess()
   */
  public static GlobalResponse<Object> responseError() {
    return responseError(ERROR_MESSAGE);
@@ -75,11 +127,15 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回指定错误消息的响应
   * <p>
-   * 使用指定的错误消息，状态码500，数据为null
+   * 使用指定的错误消息，状态码500，数据为null。
+   * 适用于需要向客户端传递具体错误信息的场景。
   * </p>
   *
-   * @param message 错误消息内容
-   * @return 错误响应对象
+   * @param message 错误消息内容，建议描述具体错误原因，便于前端展示和问题定位
+   * @return 错误响应对象，格式：{status: 500, message: "自定义错误信息", data: null}
+   *
+   * @see #responseError()
+   * @see #responseSuccess(String)
   */
  public static GlobalResponse<Object> responseError(String message) {
    return new GlobalResponse<>(ERROR_STATUS, message, null);
@@ -88,10 +144,15 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回默认成功响应
   * <p>
-   * 使用默认成功消息"OK"，状态码0，数据为null
+   * 使用默认成功消息"OK"，状态码0，数据为null。
+   * 适用于操作成功但不需要返回数据的场景。
   * </p>
   *
-   * @return 成功响应对象
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: null}
+   *
+   * @see #responseSuccess(String)
+   * @see #responseSuccess(Object)
+   * @see #responseError()
   */
  public static GlobalResponse<Object> responseSuccess() {
    return responseSuccess(SUCCESS_MESSAGE);
@@ -100,11 +161,16 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回指定成功消息的响应
   * <p>
-   * 使用指定的成功消息，状态码0，数据为null
+   * 使用指定的成功消息，状态码0，数据为null。
+   * 适用于需要向客户端返回自定义成功提示的场景。
   * </p>
   *
-   * @param message 成功消息内容
-   * @return 成功响应对象
+   * @param message 成功消息内容，建议描述具体操作结果，便于用户理解
+   * @return 成功响应对象，格式：{status: 0, message: "自定义成功信息", data: null}
+   *
+   * @see #responseSuccess()
+   * @see #responseSuccess(Object)
+   * @see #responseSuccess(String, Object)
   */
  public static GlobalResponse<Object> responseSuccess(String message) {
    return responseSuccess(message, null);
@@ -113,12 +179,17 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回包含数据的成功响应
   * <p>
-   * 使用默认成功消息"OK"，状态码0，包含指定数据
+   * 使用默认成功消息"OK"，状态码0，包含指定数据。
+   * 适用于需要返回数据但不需要自定义消息的场景。
   * </p>
   *
-   * @param <E>  数据类型
-   * @param data 业务数据
-   * @return 成功响应对象
+   * @param <E>  数据类型，可以是任意Java对象
+   * @param data 业务数据，可以是实体对象、Map、集合等
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: 业务数据}
+   *
+   * @see #responseSuccess(String, Object)
+   * @see #responseListData(Iterable, Long)
+   * @see #responseDetailData(Object)
   */
  public static <E> GlobalResponse<E> responseSuccess(E data) {
    return responseSuccess(SUCCESS_MESSAGE, data);
@@ -127,13 +198,18 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回包含指定消息和数据的成功响应
   * <p>
-   * 使用指定的成功消息，状态码0，包含指定数据
+   * 使用指定的成功消息，状态码0，包含指定数据。
+   * 这是最完整的方法，适用于需要同时自定义消息和返回数据的场景。
   * </p>
   *
   * @param <E>     数据类型
-   * @param message 成功消息内容
-   * @param data    业务数据
-   * @return 成功响应对象
+   * @param message 成功消息内容，描述具体操作结果
+   * @param data    业务数据，可以是任意类型
+   * @return 成功响应对象，格式：{status: 0, message: "自定义消息", data: 业务数据}
+   *
+   * @see #responseSuccess()
+   * @see #responseSuccess(Object)
+   * @see #responseSuccess(String)
   */
  public static <E> GlobalResponse<E> responseSuccess(String message, E data) {
    return new GlobalResponse<>(SUCCESS_STATUS, message, data);
@@ -142,11 +218,15 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回Map类型数据的成功响应
   * <p>
-   * 适用于需要返回结构化数据的场景，如分页查询结果
+   * 适用于需要返回结构化数据的场景，如分页查询结果、统计信息等。
+   * 内部使用responseSuccess方法封装。
   * </p>
   *
-   * @param data Map格式的业务数据
-   * @return 成功响应对象
+   * @param data Map格式的业务数据，键为String，值为任意对象
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: Map数据}
+   *
+   * @see #responseMapData(String, Object)
+   * @see #responseSuccess(Object)
   */
  public static GlobalResponse<Map<String, Object>> responseMapData(Map<String, Object> data) {
    return responseSuccess(data);
@@ -155,17 +235,32 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回单个键值对的成功响应
   * <p>
-   * 将单个键值对封装为Map后返回
+   * 将单个键值对封装为Map后返回，适用于返回单个配置项或简单结果的场景。
   * </p>
   *
-   * @param key   数据键名
-   * @param value 数据值
-   * @return 成功响应对象
+   * @param key   数据键名，不能为null
+   * @param value 数据值，可以是任意对象
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: {key: value}}
+   *
+   * @see #responseMapData(Map)
+   * @see #responseSuccess(Object)
   */
  public static GlobalResponse<Map<String, Object>> responseMapData(String key, Object value) {
    return responseMapData(Map.of(key, value));
  }

+  /**
+   * 返回空列表的成功响应
+   * <p>
+   * 适用于查询结果为空的场景，返回空列表和总数为0。
+   * </p>
+   *
+   * @param <T> 数据项类型
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: {items: [], total: 0}}
+   *
+   * @see #responseListData(Iterable, Long)
+   * @see #responseListData(Iterable, Integer)
+   */
  public static <T> GlobalResponse<ListItem<T>> responseListData() {
    return responseListData(List.of(), 0);
  }
@@ -173,13 +268,18 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回CRUD列表数据的成功响应（Integer类型总数）
   * <p>
-   * 适用于分页查询，将数据列表和总数封装为Map格式
+   * 适用于分页查询，将数据列表和总数封装为标准格式。
+   * 自动将Integer类型的总数转换为Long类型。
   * </p>
   *
   * @param <T>   数据项类型
-   * @param data  数据列表
-   * @param total 总记录数
-   * @return 成功响应对象
+   * @param data  数据列表，可以是List、Set等Iterable实现
+   * @param total 总记录数，Integer类型
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: {items: [...], total: total}}
+   *
+   * @see #responseListData(Iterable, Long)
+   * @see #responseListData()
+   * @see #responseSuccess(Object)
   */
  public static <T> GlobalResponse<ListItem<T>> responseListData(Iterable<T> data, Integer total) {
    return responseListData(data, total.longValue());
@@ -188,13 +288,19 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回CRUD列表数据的成功响应（Long类型总数）
   * <p>
-   * 适用于分页查询，将数据列表和总数封装为Map格式
+   * 适用于分页查询，将数据列表和总数封装为标准格式。
+   * 支持大数据量场景，使用Long类型避免整数溢出。
   * </p>
   *
   * @param <T>   数据项类型
-   * @param data  数据列表
-   * @param total 总记录数
-   * @return 成功响应对象
+   * @param data  数据列表，可以是List、Set等Iterable实现
+   * @param total 总记录数，Long类型，支持大数据量
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: {items: [...], total: total}}
+   *
+   * @see #responseListData(Iterable, Integer)
+   * @see #responseListData()
+   * @see ListItem
+   * @see #responseSuccess(Object)
   */
  public static <T> GlobalResponse<ListItem<T>> responseListData(Iterable<T> data, Long total) {
    return responseSuccess(new ListItem<>(data, total));
@@ -203,19 +309,51 @@ public record GlobalResponse<T>(Integer status, String message, T data) {
  /**
   * 返回详情数据的成功响应
   * <p>
-   * 适用于详情查询，将单条记录封装为Map格式
+   * 适用于详情查询，将单条记录封装为标准格式。
+   * 便于前端统一处理详情数据的展示。
   * </p>
   *
-   * @param data 详情数据
-   * @return 成功响应对象
+   * @param <T>  数据类型
+   * @param data 详情数据，可以是实体对象、Map等
+   * @return 成功响应对象，格式：{status: 0, message: "OK", data: {item: 详情数据}}
+   *
+   * @see #responseSuccess(Object)
+   * @see DetailItem
   */
  public static <T> GlobalResponse<DetailItem<T>> responseDetailData(T data) {
    return responseSuccess(new DetailItem<>(data));
  }

+  /**
+   * 列表数据封装类
+   * <p>
+   * 用于封装分页查询的结果，包含数据列表和总记录数。
+   * 便于前端进行分页控件的渲染和数据展示。
+   * </p>
+   *
+   * @param <T>  数据项类型
+   * @param items 数据列表，包含当前页的所有记录
+   * @param total 总记录数，用于计算总页数和显示分页信息
+   *
+   * @see #responseListData(Iterable, Long)
+   */
  public record ListItem<T>(Iterable<T> items, Long total) {
  }

+  /**
+   * 详情数据封装类
+   * <p>
+   * 用于封装单条记录的查询结果，提供统一的详情数据结构。
+   * 便于前端统一处理详情页面的数据展示。
+   * </p>
+   *
+   * <p><b>注意：</b> item字段使用Object类型，可以存储任意类型的详情数据。</p>
+   *
+   * @param <T>  数据类型（主要用于类型提示）
+   * @param item 单条记录数据，可以是实体对象、Map、VO对象等
+   *
+   * @see #responseDetailData(Object)
+   */
  public record DetailItem<T>(T item) {
  }
 }
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/QueryController.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/QueryController.java
@@ -2,56 +2,24 @@ package com.lanyuanxiaoyao.service.template.common.controller;

 /**
 * 查询控制器接口，用于定义统一的查询实体详情和列表的接口规范
- *
 * <p>
- * 前端传入的JSON格式示例:
- * <pre>
- * {
- *   "query": {
- *     "equal": {
- *       "status": "ACTIVE"
- *     },
- *     "like": {
- *       "name": "关键字"
- *     }
- *   },
- *   "sort": [
- *     {
- *       "column": "createTime",
- *       "direction": "DESC"
- *     }
- *   ],
- *   "page": {
- *     "index": 0,
- *     "size": 10
- *   }
- * }
- * </pre>
+ * 该接口提供了标准的查询功能，支持条件查询、分页查询和详情查询。
+ * 所有实现类应当遵循统一的请求响应格式。
 * </p>
 *
- * <p>
- * 支持的查询条件说明:
+ * <h3>查询条件说明</h3>
 * <ul>
- *   <li>nullEqual: 指定字段值为null的条件列表</li>
- *   <li>notNullEqual: 指定字段值不为null的条件列表</li>
- *   <li>empty: 指定字段值为空的条件列表（如空字符串、空集合等）</li>
- *   <li>notEmpty: 指定字段值不为空的条件列表</li>
- *   <li>equal: 指定字段值相等的条件映射（字段名 -> 值）</li>
- *   <li>notEqual: 指定字段值不相等的条件映射（字段名 -> 值）</li>
- *   <li>like: 指定字段模糊匹配的条件映射（字段名 -> 匹配值）</li>
- *   <li>notLike: 指定字段不模糊匹配的条件映射（字段名 -> 匹配值）</li>
- *   <li>great: 指定字段大于条件的映射（字段名 -> 值）</li>
- *   <li>less: 指定字段小于条件的映射（字段名 -> 值）</li>
- *   <li>greatEqual: 指定字段大于等于条件的映射（字段名 -> 值）</li>
- *   <li>lessEqual: 指定字段小于等于条件的映射（字段名 -> 值）</li>
- *   <li>in: 指定字段值在指定范围内的条件映射（字段名 -> 值列表）</li>
- *   <li>notIn: 指定字段值不在指定范围内的条件映射（字段名 -> 值列表）</li>
- *   <li>between: 指定字段值在指定区间内的条件映射（字段名 -> 区间范围）</li>
- *   <li>notBetween: 指定字段值不在指定区间内的条件映射（字段名 -> 区间范围）</li>
+ *   <li><b>空值条件:</b> nullEqual、notNullEqual、empty、notEmpty</li>
+ *   <li><b>相等条件:</b> equal、notEqual</li>
+ *   <li><b>模糊匹配:</b> like、notLike、contain、notContain</li>
+ *   <li><b>前后缀匹配:</b> startWith、notStartWith、endWith、notEndWith</li>
+ *   <li><b>范围条件:</b> great、less、greatEqual、lessEqual</li>
+ *   <li><b>集合条件:</b> inside、notInside</li>
+ *   <li><b>区间条件:</b> between、notBetween</li>
 * </ul>
- * </p>
 *
- * @param <DETAIL_ITEM> 查询结果的实体类型
+ * @param <LIST_ITEM>   列表查询结果的实体类型
+ * @param <DETAIL_ITEM> 详情查询结果的实体类型
 */
 public interface QueryController<LIST_ITEM, DETAIL_ITEM> {
  String LIST = "/list";
@@ -59,26 +27,38 @@ public interface QueryController<LIST_ITEM, DETAIL_ITEM> {

  /**
   * 获取所有实体列表
+   * <p>
+   * 查询所有记录，不带任何过滤条件，返回分页格式的数据。
+   * 适用于获取全量数据的场景。
+   * </p>
   *
-   * @return GlobalResponse<Map<String, Object>> 返回实体列表
+   * @return 返回包含实体列表的响应对象，格式：{status: 0, message: "OK", data: {items: [...], total: total}}
   * @throws Exception 查询过程中可能抛出的异常
   */
  GlobalResponse<GlobalResponse.ListItem<LIST_ITEM>> list() throws Exception;

  /**
   * 根据查询条件获取实体列表
+   * <p>
+   * 支持复杂的查询条件、排序和分页，返回符合条件的数据。
+   * 查询条件包括相等、模糊匹配、范围查询、集合查询等。
+   * </p>
   *
-   * @param query 查询条件对象
-   * @return GlobalResponse<Map<String, Object>> 返回符合条件的实体列表
+   * @param query 查询条件对象，包含过滤条件、排序规则和分页信息
+   * @return 返回符合条件的实体列表响应对象，格式：{status: 0, message: "OK", data: {items: [...], total: total}}
   * @throws Exception 查询过程中可能抛出的异常
   */
  GlobalResponse<GlobalResponse.ListItem<LIST_ITEM>> list(Query query) throws Exception;

  /**
   * 根据ID获取实体详情
+   * <p>
+   * 根据主键ID查询单条记录的详细信息。
+   * 适用于详情页面展示或数据编辑的场景。
+   * </p>
   *
-   * @param id 实体ID
-   * @return GlobalResponse<QUERY_ITEM> 返回实体详情
+   * @param id 实体主键ID
+   * @return 返回实体详情响应对象，格式：{status: 0, message: "OK", data: {item: 详情数据}}
   * @throws Exception 查询过程中可能抛出的异常
   */
  GlobalResponse<DETAIL_ITEM> detail(Long id) throws Exception;
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/RemoveController.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/RemoveController.java
@@ -2,12 +2,9 @@ package com.lanyuanxiaoyao.service.template.common.controller;

 /**
 * 删除控制器接口，用于定义统一的删除实体对象的接口规范
- *
 * <p>
- * 前端传入的JSON格式示例:
- * <pre>
- * DELETE /remove/1
- * </pre>
+ * 该接口提供了标准的删除功能，通过主键ID删除单条记录。
+ * 所有实现类应当遵循统一的请求响应格式。
 * </p>
 */
 public interface RemoveController {
@@ -15,9 +12,13 @@ public interface RemoveController {

  /**
   * 根据ID删除实体对象
+   * <p>
+   * 根据主键ID删除指定的记录，执行成功后返回操作结果。
+   * 适用于单条记录删除的场景。
+   * </p>
   *
-   * @param id 需要删除的实体ID
-   * @return GlobalResponse<Object> 返回删除结果
+   * @param id 需要删除的实体主键ID
+   * @return 返回删除结果响应对象，格式：{status: 0, message: "OK", data: null}
   * @throws Exception 删除过程中可能抛出的异常
   */
  GlobalResponse<Object> remove(Long id) throws Exception;
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/SaveController.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/controller/SaveController.java
@@ -2,26 +2,25 @@ package com.lanyuanxiaoyao.service.template.common.controller;

 /**
 * 保存控制器接口，用于定义统一的保存实体对象的接口规范
- *
 * <p>
- * 前端传入的JSON格式示例:
- * <pre>
- * {
- *   // 实体对象的具体字段
- *   "name": "示例名称",
- *   "description": "示例描述"
- * }
- * </pre>
+ * 该接口提供了标准的保存功能，支持新增和更新操作。
+ * 所有实现类应当遵循统一的请求响应格式。
 * </p>
+ *
+ * @param <SAVE_ITEM> 保存操作的实体类型
 */
 public interface SaveController<SAVE_ITEM> {
  String SAVE = "/save";

  /**
   * 保存实体对象
+   * <p>
+   * 保存或更新实体对象，根据业务逻辑判断是新增还是更新操作。
+   * 返回保存后的实体ID，便于前端获取操作结果。
+   * </p>
   *
-   * @param item 需要保存的实体对象
-   * @return GlobalResponse<Long> 返回保存后的实体ID
+   * @param item 需要保存的实体对象，包含完整的字段信息
+   * @return 返回保存后的实体ID响应对象，格式：{status: 0, message: "OK", data: 实体ID}
   * @throws Exception 保存过程中可能抛出的异常
   */
  GlobalResponse<Long> save(SAVE_ITEM item) throws Exception;
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/helper/ObjectHelper.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/helper/ObjectHelper.java
@@ -4,9 +4,20 @@ import java.util.Collection;
 import java.util.Map;
 import java.util.Optional;

+/**
+ * 对象工具类，提供常用的对象判断和处理方法
+ * <p>
+ * 该类封装了对象空值判断、空值检查、类型判断等常用功能，
+ * 用于简化代码中的对象处理逻辑。
+ * </p>
+ */
 public class ObjectHelper {
+
  /**
   * 判断对象是否为null
+   * <p>
+   * 简单的null值检查，用于避免空指针异常。
+   * </p>
   *
   * @param obj 待检查的对象
   * @return 如果对象为null返回true，否则返回false
@@ -15,9 +26,11 @@ public class ObjectHelper {
    return obj == null;
  }

-
  /**
   * 判断对象是否不为null
+   * <p>
+   * isNull方法的反向操作，语义更清晰。
+   * </p>
   *
   * @param obj 待判断的对象
   * @return 如果对象不为null则返回true，否则返回false
@@ -26,82 +39,138 @@ public class ObjectHelper {
    return !isNull(obj);
  }

-
  /**
   * 判断对象是否为空
+   * <p>
+   * 支持多种类型的空值判断，包括：
+   * <ul>
+   *   <li>null值</li>
+   *   <li>集合（Collection）</li>
+   *   <li>映射（Map）</li>
+   *   <li>字符序列（String、StringBuilder等）</li>
+   *   <li>各种基本类型数组</li>
+   *   <li>Optional对象</li>
+   * </ul>
+   * </p>
   *
   * @param obj 待判断的对象
   * @return 如果对象为null或为空则返回true，否则返回false
   */
  public static boolean isEmpty(Object obj) {
-    // 首先判断对象是否为null
    if (isNull(obj)) return true;
-      // 判断是否为集合类型
-    else if (obj instanceof Collection<?> collection) return collection.isEmpty();
-      // 判断是否为Map类型
-    else if (obj instanceof Map<?, ?> map) return map.isEmpty();
-      // 判断是否为字符序列类型
-    else if (obj instanceof CharSequence sequence) return sequence.isEmpty();
-      // 判断是否为各种基本类型数组
-    else if (obj instanceof Object[] array) return array.length == 0;
-    else if (obj instanceof byte[] array) return array.length == 0;
-    else if (obj instanceof short[] array) return array.length == 0;
-    else if (obj instanceof int[] array) return array.length == 0;
-    else if (obj instanceof long[] array) return array.length == 0;
-    else if (obj instanceof float[] array) return array.length == 0;
-    else if (obj instanceof double[] array) return array.length == 0;
-    else if (obj instanceof char[] array) return array.length == 0;
-    else if (obj instanceof boolean[] array) return array.length == 0;
-      // 判断是否为Optional类型
-    else if (obj instanceof Optional<?> optional) return optional.isEmpty();
-      // 其他情况认为对象不为空
-    else return false;
+    if (obj instanceof Collection<?> collection) return collection.isEmpty();
+    if (obj instanceof Map<?, ?> map) return map.isEmpty();
+    if (obj instanceof CharSequence sequence) return sequence.isEmpty();
+    if (obj instanceof Object[] array) return array.length == 0;
+    if (obj instanceof byte[] array) return array.length == 0;
+    if (obj instanceof short[] array) return array.length == 0;
+    if (obj instanceof int[] array) return array.length == 0;
+    if (obj instanceof long[] array) return array.length == 0;
+    if (obj instanceof float[] array) return array.length == 0;
+    if (obj instanceof double[] array) return array.length == 0;
+    if (obj instanceof char[] array) return array.length == 0;
+    if (obj instanceof boolean[] array) return array.length == 0;
+    if (obj instanceof Optional<?> optional) return optional.isEmpty();
+    return false;
  }

-
+  /**
+   * 判断对象是否不为空
+   * <p>
+   * isEmpty方法的反向操作，语义更清晰。
+   * </p>
+   *
+   * @param obj 待判断的对象
+   * @return 如果对象不为空则返回true，否则返回false
+   */
  public static boolean isNotEmpty(Object obj) {
    return !isEmpty(obj);
  }

+  /**
+   * 如果对象为null则返回默认值
+   * <p>
+   * 提供对象的null值保护，避免空指针异常。
+   * </p>
+   *
+   * @param object 待检查的对象
+   * @param defaultValue 默认值，当object为null时返回
+   * @return 如果object不为null则返回object，否则返回defaultValue
+   */
  public static <T> T defaultIfNull(final T object, final T defaultValue) {
    return isNull(object) ? defaultValue : object;
  }

  /**
   * 判断给定的类是否可比较
+   * <p>
+   * 可比较的类型包括：枚举、字符序列、实现了Comparable接口的类、基本数据类型。
+   * </p>
   *
   * @param clazz 待判断的类对象
   * @return 如果类是枚举、字符序列、可比较接口的实现类或基本数据类型则返回true，否则返回false
   */
  public static boolean isComparable(Class<?> clazz) {
    if (isNull(clazz)) return false;
-    // 判断类是否为可比较类型：枚举、字符序列、可比较接口实现类或基本数据类型
    return clazz.isEnum() ||
        CharSequence.class.isAssignableFrom(clazz) ||
        Comparable.class.isAssignableFrom(clazz) ||
        clazz.isPrimitive();
  }

+  /**
+   * 判断对象是否可比较
+   * <p>
+   * 通过对象的类来判断其是否可比较。
+   * </p>
+   *
+   * @param obj 待判断的对象
+   * @return 如果对象所属的类可比较则返回true，否则返回false
+   */
  public static boolean isComparable(Object obj) {
    if (isNull(obj)) return false;
    return isComparable(obj.getClass());
  }

+  /**
+   * 判断给定的类是否为集合类型
+   *
+   * @param clazz 待判断的类对象
+   * @return 如果类是Collection的子类则返回true，否则返回false
+   */
  public static boolean isCollection(Class<?> clazz) {
    if (isNull(clazz)) return false;
    return Collection.class.isAssignableFrom(clazz);
  }

+  /**
+   * 判断对象是否为集合类型
+   *
+   * @param obj 待判断的对象
+   * @return 如果对象是集合类型则返回true，否则返回false
+   */
  public static boolean isCollection(Object obj) {
    if (isNull(obj)) return false;
    return isCollection(obj.getClass());
  }

+  /**
+   * 判断给定的类是否为字符串类型
+   *
+   * @param clazz 待判断的类对象
+   * @return 如果类是String类型则返回true，否则返回false
+   */
  public static boolean isString(Class<?> clazz) {
    if (isNull(clazz)) return false;
    return String.class.isAssignableFrom(clazz);
  }

+  /**
+   * 判断对象是否为字符串类型
+   *
+   * @param obj 待判断的对象
+   * @return 如果对象是字符串类型则返回true，否则返回false
+   */
  public static boolean isString(Object obj) {
    if (isNull(obj)) return false;
    return isString(obj.getClass());
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/Page.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/Page.java
@@ -3,7 +3,29 @@ package com.lanyuanxiaoyao.service.template.common.service;
 import java.util.stream.Stream;

 /**
- * 分页
+ * 分页数据封装类
+ * <p>
+ * 用于封装分页查询的结果，包含数据流和总记录数。
+ * 适用于需要流式处理大量数据的场景，同时提供总数用于分页计算。
+ * </p>
+ *
+ * <h3>使用场景</h3>
+ * <ul>
+ *   <li>数据库分页查询结果封装</li>
+ *   <li>大数据量流式处理</li>
+ *   <li>分页控件的数据源</li>
+ * </ul>
+ *
+ * <h3>特点</h3>
+ * <ul>
+ *   <li>使用Java Record实现，不可变，线程安全</li>
+ *   <li>支持流式数据处理，内存效率高</li>
+ *   <li>包含总记录数，便于分页计算</li>
+ * </ul>
+ *
+ * @param <ENTITY> 实体类型
+ * @param items    数据流，包含当前页的所有记录
+ * @param total    总记录数，用于计算总页数和显示分页信息
 */
 public record Page<ENTITY>(Stream<ENTITY> items, long total) {
 }
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/QueryService.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/QueryService.java
@@ -6,30 +6,45 @@ import java.util.Set;

 /**
 * 查询服务接口，用于定义统一的查询实体详情和列表的服务规范
+ * <p>
+ * 该接口提供了标准的查询功能，支持详情查询、列表查询、分页查询和统计查询。
+ * 所有实现类应当遵循统一的查询逻辑和异常处理规范。
+ * </p>
 *
 * @param <ENTITY> 实体类型
 */
 public interface QueryService<ENTITY> {
+
  /**
   * 根据ID获取实体详情
+   * <p>
+   * 查询单条记录的详细信息，如果记录不存在返回null。
+   * </p>
   *
-   * @param id 实体ID
-   * @return 实体详情
+   * @param id 实体主键ID
+   * @return 实体详情，如果不存在则返回null
   * @throws Exception 查询过程中可能抛出的异常
   */
  ENTITY detail(Long id) throws Exception;

  /**
   * 根据ID获取实体详情，如果不存在则抛出异常
+   * <p>
+   * 查询单条记录的详细信息，如果记录不存在则抛出异常。
+   * 适用于需要确保记录存在的场景。
+   * </p>
   *
-   * @param id 实体ID
+   * @param id 实体主键ID
   * @return 实体详情
-   * @throws Exception 查询过程中可能抛出的异常
+   * @throws Exception 当记录不存在或查询失败时抛出异常
   */
  ENTITY detailOrThrow(Long id) throws Exception;

  /**
   * 获取实体总数
+   * <p>
+   * 统计所有记录的数量，不带任何过滤条件。
+   * </p>
   *
   * @return 实体总数
   * @throws Exception 查询过程中可能抛出的异常
@@ -38,6 +53,10 @@ public interface QueryService<ENTITY> {

  /**
   * 获取所有实体列表
+   * <p>
+   * 查询所有记录，不带任何过滤条件，返回完整列表。
+   * 适用于数据量较小或需要全量数据的场景。
+   * </p>
   *
   * @return 实体列表
   * @throws Exception 查询过程中可能抛出的异常
@@ -46,18 +65,26 @@ public interface QueryService<ENTITY> {

  /**
   * 根据ID集合获取实体列表
+   * <p>
+   * 批量查询指定ID的记录，返回对应的实体列表。
+   * 适用于需要批量获取特定记录的场景。
+   * </p>
   *
   * @param ids 实体ID集合
-   * @return 实体列表
+   * @return 实体列表，包含集合中ID对应的记录
   * @throws Exception 查询过程中可能抛出的异常
   */
  List<ENTITY> list(Set<Long> ids) throws Exception;

  /**
   * 根据查询条件获取分页实体列表
+   * <p>
+   * 支持复杂的查询条件、排序和分页，返回符合条件的数据。
+   * 这是最完整的查询方法，适用于大多数业务场景。
+   * </p>
   *
-   * @param query 查询条件对象
-   * @return 分页实体列表
+   * @param query 查询条件对象，包含过滤条件、排序规则和分页信息
+   * @return 分页实体列表，包含数据流和总记录数
   * @throws Exception 查询过程中可能抛出的异常
   */
  Page<ENTITY> list(Query query) throws Exception;
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/RemoveService.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/RemoveService.java
@@ -2,20 +2,33 @@ package com.lanyuanxiaoyao.service.template.common.service;

 /**
 * 删除服务接口，用于定义统一的删除实体对象的服务规范
+ * <p>
+ * 该接口提供了标准的删除功能，支持单条记录删除和批量删除。
+ * 所有实现类应当遵循统一的删除逻辑和异常处理规范。
+ * </p>
 *
 * @param <ENTITY> 实体类型
 */
 public interface RemoveService<ENTITY> {
+
  /**
   * 根据ID删除实体对象
+   * <p>
+   * 删除指定ID的单条记录，执行成功后无返回值。
+   * 适用于单条记录删除的场景。
+   * </p>
   *
-   * @param id 需要删除的实体ID
+   * @param id 需要删除的实体主键ID
   * @throws Exception 删除过程中可能抛出的异常
   */
  void remove(Long id) throws Exception;

  /**
   * 批量删除实体对象
+   * <p>
+   * 删除指定ID集合的多条记录，执行成功后无返回值。
+   * 适用于批量删除的场景，提高删除效率。
+   * </p>
   *
   * @param ids 需要删除的实体ID集合
   * @throws Exception 删除过程中可能抛出的异常
--- a/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/SaveService.java
+++ b/spring-boot-service-template-common/src/main/java/com/lanyuanxiaoyao/service/template/common/service/SaveService.java
@@ -2,21 +2,34 @@ package com.lanyuanxiaoyao.service.template.common.service;

 /**
 * 保存服务接口，用于定义统一的保存实体对象的服务规范
+ * <p>
+ * 该接口提供了标准的保存功能，支持单条记录保存和批量保存。
+ * 所有实现类应当遵循统一的保存逻辑和异常处理规范。
+ * </p>
 *
 * @param <ENTITY> 实体类型
 */
 public interface SaveService<ENTITY> {
+
  /**
   * 保存实体对象
+   * <p>
+   * 保存或更新单条实体记录，根据业务逻辑判断是新增还是更新操作。
+   * 返回保存后的实体ID，便于后续操作。
+   * </p>
   *
-   * @param entity 需要保存的实体对象
-   * @return 保存后的实体ID
+   * @param entity 需要保存的实体对象，包含完整的字段信息
+   * @return 保存后的实体主键ID
   * @throws Exception 保存过程中可能抛出的异常
   */
  Long save(ENTITY entity) throws Exception;

  /**
   * 批量保存实体对象
+   * <p>
+   * 批量保存或更新多条实体记录，提高数据处理效率。
+   * 适用于批量数据导入或同步的场景。
+   * </p>
   *
   * @param entities 需要保存的实体对象集合
   * @throws Exception 保存过程中可能抛出的异常