SpringBoot + Cursor 最佳提示词工程手册
(资深后端自用版,直接复制可用,越用越顺手)
一、通用规则(先看这个,AI 更听话)
- 角色指定:开头先定义 AI 身份,输出更专业
- 技术栈明确:SpringBoot、MyBatis-Plus、MySQL、Swagger、Junit5
- 规范要求:阿里规范、RESTful、统一返回、注释完整
- 禁止废话:不要解释,只给代码;不要多余封装
- 多文件场景:明确文件名、包路径、结构
二、基础架构类(项目初始化必用)
1. 生成统一返回结果类
作为资深Java后端开发,生成一个通用返回对象 Result<T>,满足:
- 字段:code、msg、data
- 提供静态方法:success()、success(data)、fail()、fail(msg)
- code 200成功,500失败
- 实现序列化
- 加上完整注释
2. 生成全局异常处理器
生成 @RestControllerAdvice 全局异常处理:
- 捕获 Exception、RuntimeException、Validation 参数异常
- 每种异常返回统一 Result 格式
- 打印日志
- 自定义 BusinessException 业务异常
- 加上注释
3. 生成分页统一参数/返回
生成通用分页查询类 PageQuery、分页返回类 PageResult:
- pageNum、pageSize
- 支持 MyBatis/MyBatis-Plus 分页
- 字段规范,注释完整
4. 生成 MyBatis 分页助手配置
生成 MyBatis-Plus 分页配置类
加上 @Configuration 注解
只给代码,不要多余解释
三、业务模块生成类(最高频)
1. 一键生成完整 CRUD 模块
根据下面的 User 实体,生成一整套标准 SpringBoot 业务模块:
Controller、Service、ServiceImpl、Mapper、XML
要求:
1. RESTful 风格
2. 使用统一返回 Result
3. 包含:增、删、改、单查、列表、分页、条件查询
4. MyBatis XML 动态 SQL
5. 方法加注释,遵循阿里规范
6. 不需要多余封装,简洁可用
2. 仅生成 MyBatis XML(条件查询)
根据 User 实体,生成动态条件查询 XML:
- 姓名模糊查询
- 年龄范围
- 时间区间
- 按创建时间倒序
- 支持分页
3. 生成 MyBatis Cursor 流式查询(防 OOM)
将当前查询方法改造成 MyBatis Cursor 流式查询:
- 返回 Cursor<T>
- 加上 @Transactional(readOnly = true)
- resultSetType=FORWARD_ONLY
- fetchSize=1000
- JDBC URL 带上 useCursorFetch=true
- 给出完整 Mapper + Service 代码
4. 生成校验逻辑(非空/长度/范围)
给当前 DTO 加上 Validation 校验:
- @NotBlank/@NotNull/@Length/@Range
- 异常能被全局异常捕获
- 给出完整代码
四、接口与文档类
1. 给 Controller 生成 Swagger 注解
给当前 Controller 所有接口加上完整 Swagger3 注解:
- @Tag、@Operation、@Parameter
- 注释清晰,前端可直接看懂
- 保持原有代码不变,只加注解
2. 生成接口文档(Markdown)
根据 Controller 生成 Markdown 接口文档:
- 接口地址、请求方式、入参、出参
- 成功示例、失败示例
- 字段说明
五、工具类 & 通用组件
1. 生成 JWT 工具类
生成 JWT 工具类:
- 生成 token、解析 token
- 过期时间配置
- 加入工具包 util
- 简洁可用
2. 生成 Redis 工具类
生成 RedisUtil 工具类:
- set、get、delete、expire、lock
- 泛型方法
- 注释完整
3. 生成雪花算法 ID 工具
生成分布式 ID 雪花算法工具类
线程安全,直接可用
六、优化 & 重构类(Cursor 最强场景)
1. 代码优化(规范+可读性)
优化这段代码:
1. 遵循阿里Java开发规范
2. 提取重复逻辑
3. 加必要注释
4. 不改变原有业务逻辑
5. 简化冗余写法
2. 批量处理优化(防 OOM)
这段批量查询会OOM,优化成:
- 分页分批处理
- 或 MyBatis Cursor 流式读取
- 给出完整可运行代码
3. 加日志
给 Service 加上规范 Slf4j 日志
关键点打印入参、出参、耗时、异常
七、测试类(一键生成单测)
1. 生成 Service 单元测试
给当前 Service 生成 JUnit5 单元测试:
- Mock Mapper
- 覆盖正常/异常/边界场景
- 使用 AssertJ 断言
- 可直接运行
2. 生成 Controller 测试
给当前 Controller 生成 MockMvc 测试
测试接口参数合法性、返回格式
八、Bug 修复类(直接甩异常)
1. 异常分析 + 修复
分析以下异常,定位原因并给出修复后代码:
【粘贴异常栈】
2. SQL 错误修复
这段 MyBatis XML 报错,修复并解释原因:
【粘贴 XML】
3. 事务失效问题
这段代码事务不生效,帮我定位原因并修复
九、AI 对话增强指令(让 AI 更懂你)
固定前缀(每次对话可复制)
你是资深Java后端架构师,只输出简洁可运行代码,遵循阿里规范,不加多余解释,不写废话,结构清晰。
强制约束
- 不使用 lambok 过度依赖
- 不使用冷门技术
- 不封装过度
- 可直接复制到项目运行
十、高级进阶:多文件联动指令
1. 按分层架构生成整套文件
在 com.example.project 包下生成 user 模块:
controller:com.example.project.user.controller
service:com.example.project.user.service
mapper:com.example.project.user.mapper
xml:resources/mapper/user
实体:com.example.project.user.entity
直接生成完整文件结构与代码。
2. 按业务流程生成代码
根据"用户注册 → 校验手机号 → 生成账号 → 记录日志 → 发送消息"的流程,
生成一套 Service 层逻辑,事务控制、异常捕获、日志完整。