codex等vibe coding初始化后端项目指令

codex等vibe coding初始化后端项目指令

  • [① 项目初始化理解(后端版 Codex 指令)](#① 项目初始化理解(后端版 Codex 指令))
  • [② AGENTS.md(后端版)](#② AGENTS.md(后端版))
  • [③ doc/project-map.md(后端开发地图)](#③ doc/project-map.md(后端开发地图))

① 项目初始化理解(后端版 Codex 指令)

go 复制代码
先不要修改任何代码,先完成对当前后端仓库的结构性理解。

请按以下顺序执行:

1. 识别技术栈
   - Java / Spring Boot 版本
   - 是否 Spring Cloud 微服务
   - ORM 框架(MyBatis / MyBatis-Plus / JPA)
   - 数据源(单库 / 多数据源 / dynamic-datasource)
   - 安全框架(Spring Security / JWT / CAS)
   - 接口文档(Swagger / OpenAPI / Knife4j)
   - 构建工具(Maven / Gradle)

2. 梳理后端目录结构:
   - controller(接口入口)
   - service / service.impl(业务层)
   - mapper / dao(数据访问层)
   - entity / po(数据库实体)
   - dto(请求参数)
   - vo(返回参数)
   - config(配置类)
   - util(工具类)
   - strategy / handler(扩展逻辑,如存在)

3. 读取关键配置文件:
   - application.yml / application-*.yml
   - pom.xml(依赖与版本)
   - security / datasource / session 配置
   - swagger / openapi 配置

4. 总结项目开发规范:
   - 是否统一返回结构(ResponseVo / ResponseBuilder)
   - 是否有统一异常处理
   - 是否使用策略模式 / 工厂模式
   - 是否使用线程池 / 异步任务
   - 是否使用 MyBatis-Plus Wrapper
   - 日志规范(Slf4j / MDC)

5. 执行只读检查:
   - mvn compile
   - mvn test(如存在)
   - mvn package(验证构建)

6. 输出总结:
   - 项目结构
   - 核心模块划分
   - 高频开发路径
   - 高风险区域
   - 后续任务如何最优交付方式

AGENTS.md(后端版)

go 复制代码
# AGENTS.md

## 1. 仓库用途说明
该项目是基于 Java Spring Boot 的后端服务系统,提供 REST API 能力,包括:
- 接口层(Controller)
- 业务层(Service)
- 数据层(Mapper)
- 安全认证模块
- 扩展计算/策略模块

---

## 2. 后端目录结构

- controller/   接口入口
- service/      业务逻辑层
- service/impl/ 实现层
- mapper/dao/   数据访问层
- entity/       数据库实体
- dto/          请求对象
- vo/           返回对象
- config/       配置类
- util/         工具类
- strategy/     扩展逻辑
- exception/    异常处理

---

## 3. 开发规则

- Controller 只负责参数接收与返回
- Service 承担业务逻辑
- Mapper 负责数据库访问
- 禁止 Controller 写业务逻辑
- 必须统一返回结构
- 复杂逻辑优先使用 strategy 扩展
- SQL 必须在 mapper 层执行

---

## 4. 修改约束

- 不得破坏已有接口结构
- 不得跳过 service 层访问数据库
- 不得修改统一返回结构
- 不得随意升级依赖版本
- 必须遵守现有线程池/异步规范
- 新接口必须加 Swagger/OpenAPI 注解

---

## 5. 修改后必须检查

- 编译是否通过
- 接口是否正常访问
- 日志是否异常
- SQL 是否正确执行
- 是否影响已有接口

---

## 6. 汇报格式

- 修改模块
- 修改文件
- 修改内容
- 是否影响接口
- 是否涉及数据库
- 风险点
- 是否需要回归测试

---

## 7. 禁止行为

- 禁止删除核心结构
- 禁止绕过 service 层
- 禁止 SQL 写在业务代码
- 禁止修改统一返回结构
- 禁止破坏多数据源逻辑

③ doc/project-map.md(后端开发地图)

go 复制代码
基于你对当前后端仓库的分析结果,生成 doc/project-map.md 草稿内容。

注意:
- 不要写入文件
- 只输出 Markdown 内容
- 必须贴合后端结构

请按以下 8 个部分生成:

---

## 1. 技术栈
- Java 版本
- Spring Boot / Spring Cloud
- MyBatis / MyBatis-Plus / JPA
- 数据源方案(单库 / 多数据源)
- 安全框架(JWT / Security / CAS)
- 接口文档(Swagger / OpenAPI / Knife4j)
- 构建工具(Maven)

---

## 2. 安装 / 启动 / 测试 / 构建
- 启动命令
- 构建命令
- 测试命令
- 打包方式

---

## 3. 后端目录结构
- controller
- service / impl
- mapper
- entity / dto / vo
- config
- util
- strategy
- exception

---

## 4. 后端调用链路
Controller → Service → Strategy → Mapper → Database

---

## 5. 各层职责
- Controller:接口入口
- Service:业务逻辑
- Mapper:数据访问
- DTO:请求结构
- VO:返回结构
- Strategy:扩展逻辑
- Config:系统能力

---

## 6. 高频改动区域
- controller 新接口
- service 逻辑
- mapper SQL
- dto/vo 字段
- strategy 扩展

---

## 7. 高风险区域
- 多数据源
- 事务管理
- 异步线程池
- 安全认证
- SQL性能

---

## 8. 阅读顺序
1. Controller
2. Service
3. Mapper
4. DTO / VO
5. Config
6. Strategy
相关推荐
sinat_255487811 小时前
数组·学习笔记
java·javascript·笔记
Paxon Zhang1 小时前
JavaEE 初阶大师之路之*线程,多线程编程,Thread类,变量捕获,中断线程* 一文全部搞懂!!
java·java-ee
逻辑驱动的ken1 小时前
Java高频面试考点场景题16
java·开发语言·面试·职场和发展·求职招聘
DukeMr.Lee2 小时前
有声书实现
java·开发语言
SamDeepThinking2 小时前
秒杀系统的幂等,只做一层Redis判重远远不够
java·后端·架构
csdn2015_2 小时前
lambdaQuery 加 or
java·linux·服务器
天涯海风2 小时前
写一个录音并保存到手机的工具 安卓工具类
android·java·智能手机
sjsjsbbsbsn2 小时前
RAG 基础学习总结
java·数据库·学习
今天又在写代码2 小时前
Docker部署
java·阿里云·docker