这是一个面向企业级 Java 后端团队的 AI Skill 配置包，旨在帮助开发团队在使用 AI 编程助手（如 Windsurf、Cursor、Codex 等）时，获得更专业、更安全、更符合团队规范的代码建议。
- ✅ 稳定性优先：所有代码变更以最小风险为前提
- ✅ 架构一致性：严格遵循分层架构和编码规范
- ✅ 可审查性：保持变更范围小、逻辑清晰、易于回滚
- ✅ 业务导向：代码设计体现业务语义，易于理解和维护
AGENTS.md：AI 助手的工作模式和规则定义.codex/skills/java-backend-team/SKILL.md：详细的技能说明和最佳实践
your-java-project/
├─ AGENTS.md # AI 工作规则（放在项目根目录）
├─ .codex/
│ └─ skills/
│ └─ java-backend-team/
│ └─ SKILL.md # 技能详细说明
├─ src/
│ └─ main/
│ ├─ java/
│ │ └─ com/yourcompany/project/
│ │ ├─ controller/ # 控制器层
│ │ ├─ service/ # 服务层
│ │ ├─ manager/ # 管理器层
│ │ ├─ repository/ # 数据访问层
│ │ ├─ entity/ # 实体类
│ │ ├─ dto/ # 数据传输对象
│ │ └─ vo/ # 视图对象
│ └─ resources/
│ ├─ application.yml
│ └─ mapper/ # MyBatis XML
├─ pom.xml # Maven 配置
└─ README.md
- 将
AGENTS.md和.codex/目录复制到你的 Java 项目根目录 - 在 AI 对话框中输入：
请阅读 AGENTS.md 并使用 java-backend-team skill 来帮我开发
从项目根目录运行：
codex然后在提示词中引用：
Read AGENTS.md and use the java-backend-team skill.
请阅读 AGENTS.md 并使用 java-backend-team skill。
我需要实现一个用户注册功能，包括：
- 手机号注册
- 短信验证码校验
- 密码加密存储
- 返回 JWT Token
请用最小安全变更的方式实现。
请阅读 AGENTS.md 并使用 java-backend-team skill。
订单列表查询接口偶尔出现慢查询，帮我定位根因并修复。
要求：
1. 先找到根本原因
2. 应用最小安全修复
3. 添加回归测试
请阅读 AGENTS.md 并使用 java-backend-team skill。
审查这次提交的代码变更，重点检查：
- 分层架构是否合理
- 空值和边界处理
- 事务边界和并发安全
- SQL 性能和安全风险
- API 兼容性
请阅读 AGENTS.md 并使用 java-backend-team skill。
为 OrderService.createOrder() 方法编写完整的单元测试，
包括正常场景、边界条件和异常场景。
请阅读 AGENTS.md 并使用 java-backend-team skill。
优化商品列表查询接口的性能，当前有 N+1 查询问题。
要求保持 API 兼容性，不影响现有调用方。
| 场景 | 说明 |
|---|---|
| 新功能开发 | RESTful API、业务逻辑、数据库设计 |
| Bug 修复 | 定位根因、最小化修复、添加测试 |
| 代码审查 | 架构、安全、性能、规范检查 |
| 重构优化 | 性能优化、代码简化、架构调整 |
| 测试编写 | 单元测试、集成测试、边界测试 |
- Spring Boot 2.x / 3.x
- Spring MVC / WebFlux
- Spring Data JPA / MyBatis / MyBatis-Plus
- Spring Cloud（微服务）
- MySQL / PostgreSQL / Oracle
- Redis（缓存、分布式锁）
- MongoDB / Elasticsearch
- RabbitMQ / RocketMQ / Kafka
- XXL-Job / Quartz
- Nacos / Apollo
- Spring Security / Sa-Token / JWT
- Hutool / Guava / Lombok
- MapStruct / Validation
Controller → Service → Manager/Domain Service → Repository/DAO
↓ ↓ ↓ ↓
请求处理 业务编排 可复用能力 数据持久化
- DTO/Request：接收前端参数
- VO/Response：返回前端数据
- Entity/DO/PO：数据库实体
- BO：业务对象（内部流转）
- ✅ 统一异常处理
- ✅ 事务边界控制
- ✅ SQL 防注入和性能优化
- ✅ 并发安全和幂等性设计
- ✅ 敏感信息脱敏
以下模块变更需特别谨慎，AI 会主动提醒：
- 🔐 认证授权（登录、权限）
- 💰 支付订单（金额、状态）
- 🏢 多租户隔离
- 🔧 核心基础设施
- 不随意修改 API 契约
- 不随意修改数据库表结构
- 不随意修改 MQ 消息格式
- 保持变更可回滚
每次任务完成后，AI 会提供：
- 变更文件清单
- 变更内容说明
- 方案选择理由
- 风险与后续事项
- 验证建议
示例输出：
## 变更总结
### 1. 变更文件
- OrderController.java：新增创建订单接口
- OrderService.java：实现订单创建业务逻辑
- OrderMapper.xml：添加订单插入 SQL
### 2. 变更说明
- 使用 @Transactional 保证事务一致性
- 添加库存扣减幂等性校验
- 使用 Redis 分布式锁防止重复下单
### 3. 方案理由
选择分布式锁而非数据库锁，因为：
- 性能更好，不阻塞数据库连接
- 支持跨服务场景
- 可设置过期时间防止死锁
### 4. 风险提示
- 需要确保 Redis 高可用
- 建议添加降级策略
### 5. 验证建议
mvn clean test
mvn spring-boot:run
curl -X POST http://localhost:8080/api/orders -d '{...}'
可拆分为更细粒度的子技能：
java-bugfix：专注 Bug 定位和修复java-code-review：专注代码审查java-test-writing：专注测试用例编写java-feature-implementation：专注新功能开发java-performance-optimization：专注性能优化java-refactoring：专注代码重构
欢迎提交 Issue 和 Pull Request 来完善这个技能包！
详细的贡献指南请查看 CONTRIBUTING.md。
- 📝 完善文档和示例
- 🔧 优化规则和最佳实践
- 🌐 添加新技术栈支持
- 🐛 报告和修复问题
- 💡 提出改进建议
- 📄 文档数量：9 个核心文档
- 📋 代码规范：130+ 条规则
- 💡 使用示例：15+ 个实际场景
- 🛠️ 技术栈支持：20+ 个框架和工具
- ✅ 审查清单：7 大类 40+ 项检查点
| 文档 | 说明 | 推荐阅读 |
|---|---|---|
| README.md | 项目介绍和快速开始 | ⭐⭐⭐⭐⭐ |
| AGENTS.md | AI 工作规则（核心配置） | ⭐⭐⭐⭐⭐ |
| SKILL.md | 技能详细说明 | ⭐⭐⭐⭐⭐ |
| USAGE_EXAMPLES.md | 详细使用示例 | ⭐⭐⭐⭐ |
| QUICK_REFERENCE.md | 快速参考卡片 | ⭐⭐⭐⭐ |
| CONTRIBUTING.md | 贡献指南 | ⭐⭐⭐ |
| CHANGELOG.md | 更新日志 | ⭐⭐⭐ |
Q: 这个技能包适合我的项目吗？
A: 如果你的项目符合以下特征，这个技能包非常适合：
- 使用 Java 8+ 和 Spring Boot
- 采用分层架构（Controller-Service-Repository）
- 注重代码质量和安全性
- 团队协作开发
- 生产环境部署
Q: 如何自定义规则？
A: 你可以：
- 直接修改
AGENTS.md和SKILL.md文件 - 添加项目特定的规范和约定
- 在提示词中明确说明项目的特殊要求
- Fork 本项目并根据团队需求定制
Q: 支持哪些 AI 工具？
A: 支持所有可以读取项目文件的 AI 编程助手：
- ✅ Windsurf
- ✅ Cursor
- ✅ GitHub Copilot
- ✅ Codex
- ✅ 其他支持自定义 Skill 的工具
本项目采用 MIT License 开源协议。
你可以自由地：
- ✅ 商业使用
- ✅ 修改
- ✅ 分发
- ✅ 私有使用
唯一的要求是保留版权声明和许可证声明。
如果这个项目对你有帮助，请给个 Star ⭐️ 支持一下！