大统一 Java 服务端 Monorepo 项目

项目代号: Athena (雅典娜) - 智慧女神
愿景: 构建易于复用、迭代、维护和扩展的项目架构，实现关注点分离与代码复用，打造生生不息的软件生命力

📖 项目简介

Athena 是一个基于 Spring Boot 4.x 与 JDK 25 的 Monorepo 多模块 Java 服务端项目。采用单体仓库、多模块架构，实现：

一级模块: 基础通用模块，可持续增强优化

二级模块: 业务模块，支持无限扩展

🏗️ 模块结构

java-monorepo/
├── athena-core           # 核心模块 (业务无关，基础依赖)
├── athena-common         # 公共通用模块 (业务无关，通用依赖)
├── athena-dao            # 数据库配置层
├── athena-util           # 工具类模块
├── athena-constant       # 常量、枚举、通用配置
├── athena-test           # 测试与实验性功能
├── athena-generator      # 代码生成器
├── business-common-service # 业务通用服务模块组
└── single-module-projects  # 独立单模块项目集合

✨ 核心特性

基础能力

✅ 最佳实践的项目结构与精简 POM 配置

✅ 统一响应结果封装与生成工具

✅ 统一异常处理机制

✅ JWT 接口签名认证

✅ 常用基础方法抽象封装

数据持久层

✅ 集成 MyBatis + 通用 Mapper + PageHelper 分页插件

✅ 单表业务零 SQL 编写

✅ ShardingSphere 分库分表/读写分离/分布式事务

开发效率

✅ 代码生成器：根据表名自动生成 Model、Mapper、Service、Controller 等基础代码

✅ 内置 RESTful 模板，支持按需扩展

✅ 统一团队代码风格

🚀 快速开始

环境要求

JDK 25+

Maven 3.8+

MySQL 8+ / PostgreSQL 15+

📝 开发规范

命名规范

类型	规范
表名	小写，多单词用下划线拼接
URL	小写名词，使用连字符 `-`，避免动词
集合路径	使用复数形式，如 `/articles`
多级路径	避免过深，使用查询参数，如 `/users/1?schools=2`

代码规范

遵循阿里巴巴 Java 开发手册

Model 成员变量与表字段一一对应，扩展字段使用 @Transient 注解

业务异常直接抛出 ServiceException，由统一异常处理器封装

工具类选型

优先使用 Apache Commons 和 Guava

确实没有再自行封装或引入第三方库

🔧 RESTful API 规范

请求方法映射

HTTP 方法	注解	用途
GET	`@GetMapping`	获取资源
POST	`@PostMapping`	新增/分页查询
PUT	`@PutMapping`	修改资源
DELETE	`@DeleteMapping`	删除资源

API 版本控制

https://api.example.com/v{n}/

整数版本: 大功能发布 (v1, v2)

浮点版本: 小版本补充 (v1.1, v2.2)

⚠️ 已上线接口禁止修改，废弃接口需标注 @Deprecated 并说明替代方案

📋 Git Commit Message 规范

采用 Angular 规范格式：type(scope): subject

Type 类型

类型	说明
`feat`	新功能
`fix`	Bug 修复
`docs`	文档变更
`refactor`	代码重构
`style`	格式调整 (不影响逻辑)
`perf`	性能优化
`test`	测试用例
`chore`	构建/工具/依赖
`ci`	持续集成
`release`	发布版本
`revert`	回滚

示例

feat(app): 用户登录功能

- 实现手机号验证码登录
- 添加 JWT Token 生成与验证
- 补充单元测试

Closes #123

🛠️ IDEA 配置

文件头模板

路径：File → Settings → File and Code Templates → Includes → File Header

🔄 CI/CD

Jenkins 自动发布

release 前缀的提交自动触发 Jenkins 构建

支持单仓库多模块与多仓库多模块部署

通过 Git WebHooks 触发流水线

📚 技术栈文档

技术	文档
Spring Boot	官方文档
MyBatis	中文文档
通用 Mapper	官方文档
PageHelper	官方文档
ShardingSphere	官方文档

📄 License

Apache License 2.0

Built with ❤️ by Athena Team

首页

大统一 Java 服务端 Monorepo 项目#

📖 项目简介#

🏗️ 模块结构#

✨ 核心特性#

基础能力#

数据持久层#

开发效率#

🚀 快速开始#

环境要求#

📝 开发规范#

命名规范#

代码规范#

工具类选型#

🔧 RESTful API 规范#

请求方法映射#

API 版本控制#

📋 Git Commit Message 规范#

Type 类型#

示例#

🛠️ IDEA 配置#

文件头模板#

🔄 CI/CD#

Jenkins 自动发布#

📚 技术栈文档#

📄 License#