Common-Base 模块文档中心
概述
common-base 是 BeyondSoft Spring3 Framework 的基础核心模块，为整个框架提供跨项目复用的通用基础设施。本文档中心包含了所有相关的技术文档，帮助开发者理解、使用和扩展该模块。
文档导航
1. 入门指南
2. 核心概念
3. 详细文档
4. 功能模块
4.1 响应模型
- CommonResult - 统一成功响应模型
- ErrorResult - 统一错误响应模型
- Page - 分页模型
- 使用示例: 开发文档#3.1
4.2 异常体系
- RequestException - 异常基类
- BusinessException - 业务异常
- ParameterInvalidException - 参数无效异常
- 完整异常列表: API参考#2
4.3 工具类
- IpUtils - IP地址处理工具
- SpringUtil - Spring工具类
- RedisUtil - Redis操作工具
- ExcelUtil - Excel处理工具
- 完整工具列表: API参考#3
4.4 注解体系
- 查询条件注解 - @Eq, @Gt, @Lt, @In, @Regex
- 操作符注解 - @AndOperator, @OrOperator, @NorOperator
- 使用指南: 开发文档#3.5
4.5 常量定义
- CommonConstants - 通用常量
- HeaderConstants - 请求头常量
- RequestConstants - 请求参数常量
- 完整常量: API参考#7
5. 最佳实践
5.1 代码规范
- 异常使用规范: 集成指南#11.1
- 响应格式规范: 开发文档#3.1.3
- 工具类使用: 集成指南#5.2
5.2 性能优化
5.3 安全防护
- SQL注入防护: 集成指南#6.3
- 参数校验: 开发文档#3.2.2
- 异常安全: 架构设计#7
6. 进阶主题
6.1 自定义扩展
- 自定义异常: 集成指南#5.3.2
- 注解解析器: 集成指南#6.1.2
- 监听器扩展: 开发文档#3.5.1
6.2 集成测试
6.3 监控与日志
7. 故障排除
7.1 常见问题
7.2 错误代码
- 响应码说明: 开发文档#3.2.1
- 异常处理: 集成指南#4.2.1
- 调试技巧: 开发文档#3.3
8. 版本信息
8.1 当前版本
- 版本号: 1.0.0
- 发布日期: 2025-12-30
- Spring Boot: 3.x
- Java: JDK 17+
8.2 版本历史
| 版本 | 日期 | 主要更新 | 状态 |
|---|---|---|---|
| 1.0.0 | 2025-12-30 | 初始版本发布 | 正式 |
| 0.9.0 | 2025-11-15 | 预览版本 | 测试 |
8.3 升级指南
9. 贡献指南
9.1 开发环境
bash
# 克隆项目
git clone https://github.com/beyondsoft/beyondsoft-spring3-framework.git
# 进入目录
cd beyondsoft-spring3-framework/common-base
# 编译项目
mvn clean compile
# 运行测试
mvn test
# 打包
mvn package9.2 代码规范
- Java代码: 遵循阿里巴巴Java开发规范
- 注释要求: 所有公共API必须有JavaDoc注释
- 测试要求: 核心功能必须有单元测试
- 文档要求: 所有变更必须更新相关文档
9.3 提交规范
- Commit消息: 遵循Conventional Commits规范
- PR要求: 必须有相关测试和文档更新
- 代码审查: 所有变更必须经过代码审查
10. 资源链接
10.1 相关项目
- Web Starter - Web Starter模块
- Exception Starter - 异常处理模块
- Log Starter - 日志模块
- Security Starter - 安全模块（待完善）
10.2 外部依赖
10.3 学习资源
- Spring Boot教程: Spring官方教程
- Java最佳实践: 阿里巴巴Java开发手册
- 架构设计: 架构整洁之道
11. 支持与反馈
11.1 获取帮助
- 文档问题: 检查本文档和相关文档
- 代码问题: 查看示例代码和单元测试
- 配置问题: 参考配置示例和最佳实践
11.2 报告问题
- GitHub Issues: 提交Issue
- 问题模板: 请按照模板提交问题
- 重现步骤: 提供详细的重现步骤
11.3 贡献代码
- Fork项目: 从GitHub Fork项目
- 创建分支: 从main分支创建特性分支
- 提交PR: 完成开发后提交Pull Request
12. 许可证
本项目基于 Apache License 2.0 许可证开源。
Copyright 2025 BeyondSoft
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.文档维护
- 最后更新: 2025-12-30
- 维护团队: BeyondSoft 架构组
- 文档版本: 1.0.0
更新日志
- 2025-12-30: 创建初始版本文档中心
- 2025-12-30: 完善所有子文档链接
- 2025-12-30: 添加贡献指南和支持信息
温馨提示
- 建议按顺序阅读文档：入门指南 → 核心概念 → 详细文档
- 在实际使用中遇到问题，请先查看常见问题部分
- 欢迎贡献代码和文档，共同完善本项目