common-base 模块功能概览

1. 模块定位

common-base 是整个 BeyondSoft Spring3 Framework 的基础模块，提供跨项目复用的 通用模型、异常体系、工具类和基础依赖。其他 Starter（Web、异常、日志、安全等）都依赖于本模块，本模块应当保持“无业务、弱依赖、高复用”。

2. 主要能力

• 统一错误结果模型

  • 提供统一的错误返回结构（如 ErrorResult），供异常处理模块和 Web 模块封装错误响应。

• 业务异常体系

  • 定义标准的业务异常类型（如 BusinessException, ParameterInvalidException, DataConflictException, InternalServerException, RemoteAccessException, ExcelException 等）。
  • 供 beyondsoft-exception-spring3-starter 统一捕获和转换为标准错误响应。

• 通用工具与基础能力

  • 常用工具类（日期时间、集合、加解密、IP 解析等）。
  • Excel 处理、压缩文件处理等通用能力。
  • 预置对 Redis、MongoDB、Sa-Token、MyBatis 等常用组件的依赖（多为可选依赖），为上层 Starter 提供支撑。

3. 使用约定

• 禁止在业务项目中重新定义 Result/异常体系

  • 业务项目应统一使用 common-base 中的错误模型（如 ErrorResult）和业务异常，而不要再定义新的 "Result" / "ErrorCode" / 自定义异常体系。

• 跨项目通用能力优先沉淀到 common-base

  • 当发现某个工具类或通用模型会在多个业务项目中复用时，应优先考虑将其抽取到 common-base 中，而不是只放在某个业务项目内。

• 保持无业务逻辑、职责单一

  • common-base 只承载通用基础能力，不允许引入具体业务相关逻辑或强业务耦合的依赖，避免基础模块膨胀和污染。