Claude Code 深度集成文档
介绍
Claude Code 在 ruoyi-plus-uniapp 中不是单点工具,而是一套贯穿开发、文档与协作的工程化体系。它通过 CLAUDE.md 与 AGENTS.md 双配置沉淀语言规范、架构约束与技能激活流程,并结合 .claude/skills、.claude/commands、.claude/hooks 形成可执行的工作流。开发者给出目标后,Claude Code 先做技能评估,再按命令流程执行扫描、设计、生成和同步,确保产出严格贴合 plus.ruoyi 架构与四层分层设计。本文档基于 workflow 项目真实文件整理,系统化说明技能体系、命令体系、钩子机制与实战方法,帮助团队在复杂业务下保持一致性与可追溯性。
写作进度跟踪
- [x] 介绍内容已完成,覆盖双配置与三大机制的整体定位
- [x] 核心特性已完成,包含技能规模、命令入口与钩子机制
- [x] 上下文工程已完成,说明
CLAUDE.md与AGENTS.md协同方式 - [x] 技能系统已完成,包含 32 个技能的场景与示例
- [x] 命令系统已完成,按 12 个使用入口拆解
- [x] 钩子系统已完成,覆盖三类 JS 钩子的触发与输出
- [x] 最佳实践已完成,强调规范优先与流程闭环
- [x] 实战案例已完成,覆盖新功能、文档同步、工作流同步
- [x] 行数目标已完成,全文行数不少于 1000 行
- [x] 续写提示已保留,如需扩展可追加更多技能场景或案例
核心特性
- 技能体系:
.claude/skills目录现有 32 个技能目录,覆盖架构、后端、前端、移动端、AI、协作与工程规范 - 命令体系:
.claude/commands提供 11 个命令文件,/init-docs内含两种模式,sync-local提供本地工作流同步变体,合计 12 个使用入口 - 钩子体系:
.claude/hooks提供 3 个 JavaScript 钩子,分别负责技能强制评估、工具安全拦截与结束收尾 - 配置入口:
.claude/settings.json统一绑定UserPromptSubmit、PreToolUse、Stop三类触发点 - 规则底座:
CLAUDE.md与AGENTS.md约束语言、架构、流程、命令与文档生成边界
上下文工程
CLAUDE.md 的职责
- 统一中文输出要求,确保所有响应、解释与技术讨论为中文
- 约定术语映射:前端为
plus-ui,移动端为plus-uniapp,后端为ruoyi-modules - 声明 MCP 工具触发条件,包含
sequential-thinking、context7、chrome-devtools - 强调四层架构规范与核心约束:
plus.ruoyi包名、Service 不继承基类、DAO 构建查询 - 固化页面开发前的阅读要求,强调参考模块与封装组件使用方式
AGENTS.md 的职责
- 再次强调本项目不是 ruoyi-vue-plus,禁止引用其架构和包名风格
- 给出强制技能评估流程说明,要求评估、逐个激活、再实现
- 规定文档生成边界,文档必须输出到
docs/目录 - 给出标准代码模板示例,明确 Entity、BO、VO、Controller、DAO 的正确写法
- 列出快捷命令入口与参考代码路径,便于快速进入正确流程
双配置协同流程
CLAUDE.md作为每次对话的底座规则,保证一致的语言与架构语义AGENTS.md补充项目禁令、模板与流程,覆盖更细的工程约束skill-forced-eval.js在用户输入时注入技能评估流程,强制激活匹配技能- 动态技能与命令只在需要时加载,减少上下文噪音并保持执行稳定
MCP 工具触发规则
sequential-thinking:用于复杂问题拆解、多步推理与深度分析context7:用于获取框架最佳实践和官方规范,但 WD UI 仍以项目源码为准chrome-devtools:用于浏览器调试、截图与元素检查
关键禁令与一致性约束
- 包名必须是
plus.ruoyi,禁止使用com.ruoyi - Service 实现类不继承任何基类,DAO 层必须存在并实现
buildQueryWrapper() - Entity 继承
TenantEntity,对象转换统一使用MapstructUtils - 前端使用 AForm、AModal 等封装组件,移动端使用 WD UI
wd-*组件 - API 路径必须包含实体名,例如
pageAds而不是page
技能系统
技能加载与目录规范
- 每个技能位于
.claude/skills/{skill-name}/SKILL.md - 技能文件包含 YAML 头部,记录
name、description、触发场景与触发词 - 强制技能评估流程由钩子注入,未匹配技能时需明确说明
分类总览
- 业务与架构:crud-development、api-development、architecture-design、workflow-engine
- 后端能力:backend-annotations、data-permission、error-handler、security-guard
- 前端与移动:ui-pc、ui-mobile、ui-design-mobile、store-pc、store-mobile、uniapp-platform
- 工程与质量:code-patterns、git-workflow、project-navigator、utils-toolkit、performance-doctor
- AI 与协作:ai-langchain4j、collaborating-with-codex、collaborating-with-gemini、banana-image、task-tracker
- 业务集成:payment-integration、wechat-integration、file-oss-management、media-processing
- 诊断与规划:bug-detective、brainstorm、tech-decision
ai-langchain4j
定位
- 当需要集成 AI 大模型、智能对话功能时自动使用此 Skill。支持 DeepSeek、通义千问、OpenAI、Claude、Ollama。
触发场景
- AI 对话功能开发
- 流式响应处理
- 多轮对话管理
- 知识库 RAG 集成
- 函数调用实现
触发词
AI大模型ChatGPTDeepSeek通义千问Claude流式对话RAG知识库Embeddinglangchain4j
示例
- 用户: 需要AI 对话功能开发
- 用户: 需要流式响应处理
api-development
定位
- API 接口设计规范、RESTful 设计、前后端对接约定。(与 crud-development 区别:本 Skill 专注于"接口设计规范",crud-development 用于"完整业务模块开发")
触发场景
- 设计新的 API 接口路径
- 定义 RESTful 规范
- 前后端接口对接约定
- 接口命名规范
R<T> 响应格式设计
触发词
API设计接口规范RESTfulURL设计接口路径请求响应R<T>统一响应接口命名端点设计
注意事项
- 注意:如果是开发完整的 CRUD 业务模块(Entity/Service/DAO/Controller),请使用 crud-development。
示例
- 用户: 需要设计新的 API 接口路径
- 用户: 需要定义 RESTful 规范
architecture-design
定位
- 系统架构设计、模块划分、代码重构、技术栈选型。包含本项目四层架构、领域划分、依赖管理、技术栈优先级。
触发场景
- 系统架构设计
- 新模块划分规划
- 代码重构策略
- 依赖关系梳理
- 四层架构(Controller/Service/DAO/Mapper)设计
- 领域边界划分
- 技术栈选型咨询
触发词
架构设计模块划分四层架构领域划分重构解耦依赖管理分层设计系统设计代码组织技术栈技术选型
注意事项
- 注意:如果是具体技术方案对比(如Redis vs本地缓存),请使用 tech-decision。如果是开发具体 CRUD 模块,请使用 crud-development。
示例
- 用户: 需要系统架构设计
- 用户: 需要新模块划分规划
backend-annotations
定位
- 当需要使用后端高级注解时自动使用此 Skill。包含 SerialMap、RateLimiter、RepeatSubmit、Sensitive、DataPermission 等注解。
触发场景
- 数据序列化映射(ID转名称、字典转标签)
- 接口限流配置
- 防重复提交
- 敏感数据脱敏
- 数据权限控制
触发词
SerialMap限流RateLimiter防重复RepeatSubmit脱敏Sensitive数据权限DataPermissionID转名称字典转换OSS转URL
示例
- 用户: 需要数据序列化映射(ID转名称、字典转标签)
- 用户: 需要接口限流配置
banana-image
定位
- 【触发条件】当用户要求生成图片、创建海报、制作缩略图、编辑图片时使用。
触发场景
- 以技能描述中声明的场景为准
触发词
生成图片/image产品图海报缩略图4K高清。
示例
- 用户: 生成图片相关需求怎么落地
- 用户: /image相关需求怎么落地
brainstorm
定位
- 当需要探索方案、头脑风暴、创意思维时自动使用此 Skill。
触发场景
- 不知道怎么设计
- 需要多种方案
- 创意探索
- 架构讨论
- 功能规划
- 业务扩展
触发词
头脑风暴方案怎么设计有什么办法创意讨论探索想法建议怎么做如何实现有哪些方式能不能做可以实现吗
示例
- 用户: 需要不知道怎么设计
- 用户: 需要需要多种方案
bug-detective
定位
- 排查已发生的问题、定位 Bug 原因。(与 error-handler 区别:本 Skill 用于"排查问题",error-handler 用于"设计异常处理机制")
触发场景
- 代码运行报错,需要定位原因
- 功能不正常,需要排查
- 接口返回错误,需要分析
- 日志分析、调试代码
- "为什么不工作"、"怎么不生效"
触发词
Bug报错不工作调试排查为什么出问题失败不生效无效找不到原因定位问题
注意事项
- 注意:如果是要设计异常处理机制(try-catch、全局异常、错误码),请使用 error-handler。
示例
- 用户: 需要代码运行报错,需要定位原因
- 用户: 需要功能不正常,需要排查
code-patterns
定位
- 全栈代码禁令和通用编码规范速查(后端 + 前端 + 移动端)。
触发场景
- 查看项目禁止事项(后端/前端/移动端)
- 命名规范速查
- Git 提交规范
- 避免过度工程
- 代码风格检查
触发词
规范禁止命名Git提交代码风格前端规范移动端规范不能用不允许
注意事项
- 注意:具体的 UI 组件用法请激活 ui-pc 或 ui-mobile,Store 规范请激活 store-pc 或 store-mobile,CRUD 规范请激活 crud-development。
示例
- 用户: 需要查看项目禁止事项(后端/前端/移动端)
- 用户: 需要命名规范速查
collaborating-with-codex
定位
- 与 OpenAI Codex CLI 协同开发。将编码任务委托给 Codex 进行原型开发、调试分析和代码审查。
触发场景
- 需要算法实现或复杂逻辑分析
- 需要代码审查和 Bug 分析
- 需要生成 Unified Diff 补丁
- 用户明确要求使用 Codex 协作
- 复杂后端逻辑的原型设计
触发词
Codex协作多模型原型Diff算法分析代码审查codex协同
注意事项
- 前置要求:
示例
- 用户: 需要需要算法实现或复杂逻辑分析
- 用户: 需要需要代码审查和 Bug 分析
collaborating-with-gemini
定位
- 与 Google Gemini CLI 协同开发。将编码任务委托给 Gemini 进行前端原型、UI设计和代码审查。
触发场景
- 需要前端/UI/样式原型设计
- 需要 CSS/React/Vue 组件设计
- 需要代码审查和 Bug 分析
- 用户明确要求使用 Gemini 协作
- 复杂前端逻辑的原型设计
触发词
Gemini协作多模型前端原型UI设计CSS样式gemini协同
注意事项
- 前置要求:
- 注意:Gemini 对后端逻辑理解有缺陷,后端任务优先使用 Codex。
示例
- 用户: 需要需要前端/UI/样式原型设计
- 用户: 需要需要 CSS/React/Vue 组件设计
crud-development
定位
- 开发 CRUD 功能、创建业务模块。包含完整全栈规范:后端四层架构 + 前端 API/Types。
触发场景
- 创建新的业务模块(如"用户反馈"、"优惠券")
- 编写后端代码:Entity、BO、VO、Service、DAO、Controller、Mapper
- 编写前端 API 和 TypeScript 类型定义
- 任何涉及"增删改查"的全栈开发
触发词
CRUD增删改查新建模块EntityServiceDAOControllerBOVOMapper业务模块后端代码Java代码xxxApi.tsxxxTypes.ts
注意事项
- 核心警告:本项目不是 ruoyi-vue-plus!
- 注意:如果只是写前端页面 UI,请使用 ui-pc 或 ui-mobile。
示例
- 用户: 需要创建新的业务模块(如"用户反馈"、"优惠券")
- 用户: 需要编写后端代码:Entity、BO、VO、Service、DAO、Controller、Mapper
data-permission
定位
- 数据权限开发指南。实现行级数据隔离,支持部门权限、本人权限、自定义权限等 6 种权限类型。
触发场景
- 为业务模块添加数据权限过滤
- 配置部门级数据隔离
- 扩展自定义数据权限类型
- 临时忽略数据权限查询全量数据
- 排查数据权限不生效问题
触发词
数据权限@DataPermissionDataScope行级权限数据隔离部门权限本人权限自定义权限权限过滤数据过滤按部门过滤按创建人过滤
注意事项
- 注意:如果是认证授权(登录、Token、Sa-Token)或菜单/按钮权限,请使用 security-guard。
示例
- 用户: 需要为业务模块添加数据权限过滤
- 用户: 需要配置部门级数据隔离
database-ops
定位
- 当需要进行数据库相关操作时自动使用此 Skill:连接数据库、设计表结构、执行 SQL、管理字典、优化查询。
触发场景
- 连接数据库、查看表结构
- 设计新表、修改表结构
- 编写 SQL 查询、执行 DDL/DML
- 创建/管理字典数据
- SQL 性能优化、索引设计
- 查询最大 ID、查询菜单
触发词
数据库MySQLSQL表字段索引字典连接查询DDL建表SHOWDESCINSERTSELECTdictOraclePostgreSQLSQLServer
示例
- 用户: 需要连接数据库、查看表结构
- 用户: 需要设计新表、修改表结构
error-handler
定位
- 设计异常处理机制、错误码、日志规范。(与 bug-detective 区别:本 Skill 用于"设计处理机制",bug-detective 用于"排查已发生的问题")
触发场景
- 设计 try-catch 异常处理
- 定义错误码体系
- 配置日志记录规范
- 设计全局异常处理器
- ServiceException 使用方法
- 错误提示文案优化
触发词
异常处理ServiceExceptiontry-catch全局异常错误码日志规范log.info@Slf4j错误提示设计
注意事项
- 注意:如果是排查已发生的 Bug(代码报错、功能异常),请使用 bug-detective。
示例
- 用户: 需要设计 try-catch 异常处理
- 用户: 需要定义错误码体系
file-oss-management
定位
- 当需要进行文件上传、下载、存储管理时自动使用此 Skill。支持本地存储、阿里云OSS、腾讯云COS、七牛云、MinIO等。
触发场景
- 文件上传下载
- 云存储配置
- 预签名URL生成
- 文件元数据管理
- 图片处理
触发词
文件上传OSS云存储MinIO阿里云腾讯云七牛图片上传文件下载预签名presigned
示例
- 用户: 需要文件上传下载
- 用户: 需要云存储配置
git-workflow
定位
- 当需要进行 Git 版本控制操作时自动使用此 Skill。
触发场景
- 提交代码
- 创建/合并分支
- 查看提交历史
- 解决冲突
- 回滚代码
触发词
git提交commit分支合并pushpull冲突回滚版本历史
示例
- 用户: 需要提交代码
- 用户: 需要创建/合并分支
media-processing
定位
- 当需要处理图片、生成二维码、制作海报、导入导出Excel时自动使用此 Skill。
触发场景
- 图片处理(缩放、水印、滤镜)
- 二维码生成
- GIF 动画制作
- 海报生成
- Excel 导入导出
- 文件类型判断
触发词
图片缩放水印二维码QrCodeGIF海报Excel导入导出ImageBuilderExcelUtil
示例
- 用户: 需要图片处理(缩放、水印、滤镜)
- 用户: 需要二维码生成
payment-integration
定位
- 当需要集成支付功能时自动使用此 Skill。包含微信支付、支付宝、银联、余额支付的完整对接流程。
触发场景
- 对接支付渠道
- 发起支付请求
- 处理支付回调
- 退款操作
- 查询支付状态
触发词
支付付款微信支付支付宝银联余额支付退款回调notifyPayService支付配置
示例
- 用户: 需要对接支付渠道
- 用户: 需要发起支付请求
performance-doctor
定位
- 性能问题诊断与优化。包含 SQL 优化、缓存策略、前端渲染优化、内存泄漏排查。
触发场景
- 页面/接口响应慢
- SQL 慢查询优化
- 缓存策略设计
- 分页查询优化
- N+1 查询问题
- 内存泄漏排查
- 前端渲染卡顿
触发词
性能优化慢查询SQL优化索引优化缓存Redis缓存N+1分页优化EXPLAIN内存泄漏卡顿加载慢响应慢渲染优化
注意事项
- 注意:如果是排查功能性 Bug(代码报错、逻辑错误),请使用 bug-detective。
示例
- 用户: 需要页面/接口响应慢
- 用户: 需要SQL 慢查询优化
project-navigator
定位
- 当需要了解项目结构、查找文件、定位代码时自动使用此 Skill。提供项目结构导航和资源索引。
触发场景
- 不知道文件在哪里
- 想了解项目结构
- 查找某个功能的代码位置
- 了解模块职责
- 查看已有的工具类、组件、API、Store
- 寻找参考代码
触发词
项目结构文件在哪目录模块代码位置找定位结构在哪里哪个文件参考已有
示例
- 用户: 需要不知道文件在哪里
- 用户: 需要想了解项目结构
security-guard
定位
- 安全开发规范。包含 Sa-Token 认证授权、数据脱敏、数据加密、接口安全、漏洞防护。
触发场景
- Sa-Token 权限控制配置
- 登录认证、Token 管理
- 数据脱敏处理(@Sensitive)
- 数据加密处理(@EncryptField、@ApiEncrypt)
- 接口限流(@RateLimiter)
- 防重复提交(@RepeatSubmit)
- XSS/SQL注入防护
- 前端权限指令(v-permi、v-role)
触发词
安全Sa-Token@SaCheckPermission@SaCheckLogin@SaCheckRole登录认证Token数据脱敏@Sensitive加密解密@EncryptField@ApiEncrypt限流@RateLimiter防重复@RepeatSubmitXSSSQL注入CSRF漏洞防护敏感数据LoginHelperv-permiv-roleuseAuth
注意事项
- 注意:
示例
- 用户: 需要Sa-Token 权限控制配置
- 用户: 需要登录认证、Token 管理
store-mobile
定位
- 移动端(plus-uniapp)状态管理与 Composables 完整指南。
触发场景
- 在移动端创建/使用 Store(Pinia)
- 使用 Composables(useAuth、useDict、usePayment、useHttp 等)
- 跨页面数据共享(移动端)
- 持久化存储(uni.storage)
- HTTP 请求与链式调用
- 认证与权限检查
- 滚动管理与返回顶部
触发词
移动端StoreuseAuthuseDictusePaymentuseDictStore移动端状态管理ComposableuseHttphttp请求链式调用useScroll滚动管理useAppInit应用初始化cache缓存持久化useToken
注意事项
- 适用目录:plus-uniapp/**
示例
- 用户: 需要在移动端创建/使用 Store(Pinia)
- 用户: 需要使用 Composables(useAuth、useDict、usePayment、useHttp 等)
store-pc
定位
- PC 端(plus-ui)状态管理与 Composables 指南。包含 Pinia Store、Composables 组合式函数的创建和使用规范。
触发场景
- 在 PC 后台创建/使用 Store
- Pinia 状态管理
- 跨组件数据共享(PC端)
- 持久化存储(localCache/sessionCache)
- HTTP 请求链式调用
- 权限判断
- 字典数据加载
触发词
PCStorePiniadefineStoreuseUserStoreuseDictStorePC状态管理useHttphttp链式调用useAuthuseTokenuseDictuseTableHeightlocalCachesessionCache缓存持久化
注意事项
- 适用目录:plus-ui/**
示例
- 用户: 需要在 PC 后台创建/使用 Store
- 用户: 需要Pinia 状态管理
task-tracker
定位
- 开发任务进度跟踪系统。当用户需要记录复杂开发任务的需求、步骤、进度时自动使用此 Skill。
触发场景
- 多步骤功能开发(需要跨会话)
- 复杂需求的步骤分解与跟踪
- 任务进度记录与更新
- 中断后的任务恢复
- 历史任务查询与归档
触发词
创建任务跟踪任务记录进度任务跟踪继续任务恢复任务查看任务归档任务任务列表
示例
- 用户: 需要多步骤功能开发(需要跨会话)
- 用户: 需要复杂需求的步骤分解与跟踪
tech-decision
定位
- 当需要进行技术选型、对比方案时自动使用此 Skill。
触发场景
- 选择用什么技术/库
- 对比不同方案
- 技术决策
- 评估优缺点
- 选择 ruoyi-common 模块
触发词
选型用什么对比哪个好优缺点选择技术方案库框架工具模块
示例
- 用户: 需要选择用什么技术/库
- 用户: 需要对比不同方案
ui-design-mobile
定位
- 移动端页面设计指南,追求「简洁、大气、专业」的视觉体验。
触发场景
- 设计移动端页面布局
- 页面看起来不够简洁/大气/专业
- 不知道用什么组件布局
- 页面信息太多太乱
- 想让页面更有质感
触发词
页面设计布局怎么排版放在哪里看起来乱不够简洁不够大气太拥挤留白间距颜色搭配视觉设计UI设计界面设计
注意事项
- 适用目录:plus-uniapp/**
- 注意:本 Skill 专注于「设计思维」,具体组件用法请激活 ui-mobile。
示例
- 用户: 需要设计移动端页面布局
- 用户: 需要页面看起来不够简洁/大气/专业
ui-mobile
定位
- 移动端(plus-uniapp)组件库完整指南。包含 99+ WD UI 组件、14 个 Composables、4 个 Store 模块、多平台适配。
触发场景
- 开发移动端页面(小程序、H5、APP)
- 使用 WD UI 组件(wd-*)
- 移动端列表、表单、弹窗、分页
- useToast、useMessage、usePayment 等
- 平台条件编译(#ifdef)
触发词
wd-WDUI移动端组件小程序组件wd-buttonwd-cellwd-formwd-popupwd-paginguseToastuseMessageusePaymentplus-uniapp
注意事项
- 适用目录:plus-uniapp/**
示例
- 用户: 需要开发移动端页面(小程序、H5、APP)
- 用户: 需要使用 WD UI 组件(wd-*)
ui-pc
定位
- 前端(plus-ui)组件库完整指南。包含 71 个自定义组件、17 个 Composables、18 个工具模块。
触发场景
- 开发前端后台管理页面
- 使用 AForm*、AModal、ADetail、ACard*、AChart*、AAi* 等组件
- 使用 Element Plus 组件
- 表格、表单、弹窗、图表、卡片等前端 UI
- 使用 Composables(useDict、useTableHeight 等)
- 使用 Utils(format、crypto 等)
触发词
el-AFormAModalADetailASearchFormACardAChartAAiTableToolbarPaginationDictTag前端组件后台页面管理端useDictuseTableHeightuseI18n国际化i18nt()
注意事项
- 适用目录:plus-ui/**
示例
- 用户: 需要开发前端后台管理页面
- 用户: 需要使用 AForm*、AModal、ADetail、ACard*、AChart*、AAi* 等组件
uniapp-platform
定位
- 当需要进行多端开发、条件编译、平台适配时自动使用此 Skill。涵盖小程序、H5、APP 的差异化开发。
触发场景
- 条件编译使用
- 平台特性判断
- 跨平台代码适配
- 原生能力调用
触发词
条件编译ifdef平台判断isMpWeixinisH5isApp跨平台小程序公众号H5原生能力多端
示例
- 用户: 需要条件编译使用
- 用户: 需要平台特性判断
utils-toolkit
定位
- 工具类智能匹配助手 - 根据上下文自动提供后端/前端/移动端对应的工具类和最佳实践。
触发场景
- 以技能描述中声明的场景为准
触发词
工具类日期时间字符串集合数组转换校验加密格式化处理工具utilsHutooldayjslodash树结构tree权限下载打印弹窗消息toastmodalwebsocketssecomposablehook
示例
- 用户: 工具类相关需求怎么落地
- 用户: 日期相关需求怎么落地
wechat-integration
定位
- 当需要对接微信生态功能时自动使用此 Skill。包含小程序登录、公众号分享、消息订阅、手机号验证等。
触发场景
- 微信小程序登录
- 微信公众号H5分享
- 订阅消息推送
- 获取微信手机号
- 微信JS-SDK配置
触发词
微信小程序公众号分享订阅消息openid手机号授权wx.loginJSSDK微信登录
示例
- 用户: 需要微信小程序登录
- 用户: 需要微信公众号H5分享
workflow-engine
定位
- 工作流引擎开发、流程管理、任务办理。基于 WarmFlow 实现审批流、业务流程集成。
触发场景
- 启动工作流程(发起审批、提交申请)
- 办理任务(审批通过、驳回、转办、委派)
- 流程定义管理(设计流程、配置节点)
- 业务模块集成工作流(订单审批、请假申请)
- 监听工作流事件(流程状态变更通知)
- 配置办理人(用户、角色、部门、岗位、SpEL表达式)
触发词
工作流流程审批WarmFlowFlowEngine任务办理驳回转办委派加签减签抄送流程实例流程定义办理人GlobalListenerProcessEvent
示例
- 用户: 需要启动工作流程(发起审批、提交申请)
- 用户: 需要办理任务(审批通过、驳回、转办、委派)
技能触发词索引
以下索引用于快速定位触发词,便于在大规模任务中快速匹配技能。
ai-langchain4j
AI大模型ChatGPTDeepSeek通义千问Claude流式对话RAG知识库Embeddinglangchain4j
api-development
API设计接口规范RESTfulURL设计接口路径请求响应R<T>统一响应接口命名端点设计
architecture-design
架构设计模块划分四层架构领域划分重构解耦依赖管理分层设计系统设计代码组织技术栈技术选型
backend-annotations
SerialMap限流RateLimiter防重复RepeatSubmit脱敏Sensitive数据权限DataPermissionID转名称字典转换OSS转URL
banana-image
生成图片/image产品图海报缩略图4K高清。
brainstorm
头脑风暴方案怎么设计有什么办法创意讨论探索想法建议怎么做如何实现有哪些方式能不能做可以实现吗
bug-detective
Bug报错不工作调试排查为什么出问题失败不生效无效找不到原因定位问题
code-patterns
规范禁止命名Git提交代码风格前端规范移动端规范不能用不允许
collaborating-with-codex
Codex协作多模型原型Diff算法分析代码审查codex协同
collaborating-with-gemini
Gemini协作多模型前端原型UI设计CSS样式gemini协同
crud-development
CRUD增删改查新建模块EntityServiceDAOControllerBOVOMapper业务模块后端代码Java代码xxxApi.tsxxxTypes.ts
data-permission
数据权限@DataPermissionDataScope行级权限数据隔离部门权限本人权限自定义权限权限过滤数据过滤按部门过滤按创建人过滤
database-ops
数据库MySQLSQL表字段索引字典连接查询DDL建表SHOWDESCINSERTSELECTdictOraclePostgreSQLSQLServer
error-handler
异常处理ServiceExceptiontry-catch全局异常错误码日志规范log.info@Slf4j错误提示设计
file-oss-management
文件上传OSS云存储MinIO阿里云腾讯云七牛图片上传文件下载预签名presigned
git-workflow
git提交commit分支合并pushpull冲突回滚版本历史
media-processing
图片缩放水印二维码QrCodeGIF海报Excel导入导出ImageBuilderExcelUtil
payment-integration
支付付款微信支付支付宝银联余额支付退款回调notifyPayService支付配置
performance-doctor
性能优化慢查询SQL优化索引优化缓存Redis缓存N+1分页优化EXPLAIN内存泄漏卡顿加载慢响应慢渲染优化
project-navigator
项目结构文件在哪目录模块代码位置找定位结构在哪里哪个文件参考已有
security-guard
安全Sa-Token@SaCheckPermission@SaCheckLogin@SaCheckRole登录认证Token数据脱敏@Sensitive加密解密@EncryptField@ApiEncrypt限流@RateLimiter防重复@RepeatSubmitXSSSQL注入CSRF漏洞防护敏感数据LoginHelperv-permiv-roleuseAuth
store-mobile
移动端StoreuseAuthuseDictusePaymentuseDictStore移动端状态管理ComposableuseHttphttp请求链式调用useScroll滚动管理useAppInit应用初始化cache缓存持久化useToken
store-pc
PCStorePiniadefineStoreuseUserStoreuseDictStorePC状态管理useHttphttp链式调用useAuthuseTokenuseDictuseTableHeightlocalCachesessionCache缓存持久化
task-tracker
创建任务跟踪任务记录进度任务跟踪继续任务恢复任务查看任务归档任务任务列表
tech-decision
选型用什么对比哪个好优缺点选择技术方案库框架工具模块
ui-design-mobile
页面设计布局怎么排版放在哪里看起来乱不够简洁不够大气太拥挤留白间距颜色搭配视觉设计UI设计界面设计
ui-mobile
wd-WDUI移动端组件小程序组件wd-buttonwd-cellwd-formwd-popupwd-paginguseToastuseMessageusePaymentplus-uniapp
ui-pc
el-AFormAModalADetailASearchFormACardAChartAAiTableToolbarPaginationDictTag前端组件后台页面管理端useDictuseTableHeightuseI18n国际化i18nt()
uniapp-platform
条件编译ifdef平台判断isMpWeixinisH5isApp跨平台小程序公众号H5原生能力多端
utils-toolkit
工具类日期时间字符串集合数组转换校验加密格式化处理工具utilsHutooldayjslodash树结构tree权限下载打印弹窗消息toastmodalwebsocketssecomposablehook
wechat-integration
微信小程序公众号分享订阅消息openid手机号授权wx.loginJSSDK微信登录
workflow-engine
工作流流程审批WarmFlowFlowEngine任务办理驳回转办委派加签减签抄送流程实例流程定义办理人GlobalListenerProcessEvent
技能触发场景索引
以下索引用于快速浏览技能场景,帮助在任务拆解时做初步匹配。
ai-langchain4j
- AI 对话功能开发
- 流式响应处理
- 多轮对话管理
- 知识库 RAG 集成
- 函数调用实现
api-development
- 设计新的 API 接口路径
- 定义 RESTful 规范
- 前后端接口对接约定
- 接口命名规范
R<T> 响应格式设计
architecture-design
- 系统架构设计
- 新模块划分规划
- 代码重构策略
- 依赖关系梳理
- 四层架构(Controller/Service/DAO/Mapper)设计
- 领域边界划分
- 技术栈选型咨询
backend-annotations
- 数据序列化映射(ID转名称、字典转标签)
- 接口限流配置
- 防重复提交
- 敏感数据脱敏
- 数据权限控制
banana-image
- 场景以技能描述为准
brainstorm
- 不知道怎么设计
- 需要多种方案
- 创意探索
- 架构讨论
- 功能规划
- 业务扩展
bug-detective
- 代码运行报错,需要定位原因
- 功能不正常,需要排查
- 接口返回错误,需要分析
- 日志分析、调试代码
- "为什么不工作"、"怎么不生效"
code-patterns
- 查看项目禁止事项(后端/前端/移动端)
- 命名规范速查
- Git 提交规范
- 避免过度工程
- 代码风格检查
collaborating-with-codex
- 需要算法实现或复杂逻辑分析
- 需要代码审查和 Bug 分析
- 需要生成 Unified Diff 补丁
- 用户明确要求使用 Codex 协作
- 复杂后端逻辑的原型设计
collaborating-with-gemini
- 需要前端/UI/样式原型设计
- 需要 CSS/React/Vue 组件设计
- 需要代码审查和 Bug 分析
- 用户明确要求使用 Gemini 协作
- 复杂前端逻辑的原型设计
crud-development
- 创建新的业务模块(如"用户反馈"、"优惠券")
- 编写后端代码:Entity、BO、VO、Service、DAO、Controller、Mapper
- 编写前端 API 和 TypeScript 类型定义
- 任何涉及"增删改查"的全栈开发
data-permission
- 为业务模块添加数据权限过滤
- 配置部门级数据隔离
- 扩展自定义数据权限类型
- 临时忽略数据权限查询全量数据
- 排查数据权限不生效问题
database-ops
- 连接数据库、查看表结构
- 设计新表、修改表结构
- 编写 SQL 查询、执行 DDL/DML
- 创建/管理字典数据
- SQL 性能优化、索引设计
- 查询最大 ID、查询菜单
error-handler
- 设计 try-catch 异常处理
- 定义错误码体系
- 配置日志记录规范
- 设计全局异常处理器
- ServiceException 使用方法
- 错误提示文案优化
file-oss-management
- 文件上传下载
- 云存储配置
- 预签名URL生成
- 文件元数据管理
- 图片处理
git-workflow
- 提交代码
- 创建/合并分支
- 查看提交历史
- 解决冲突
- 回滚代码
media-processing
- 图片处理(缩放、水印、滤镜)
- 二维码生成
- GIF 动画制作
- 海报生成
- Excel 导入导出
- 文件类型判断
payment-integration
- 对接支付渠道
- 发起支付请求
- 处理支付回调
- 退款操作
- 查询支付状态
performance-doctor
- 页面/接口响应慢
- SQL 慢查询优化
- 缓存策略设计
- 分页查询优化
- N+1 查询问题
- 内存泄漏排查
- 前端渲染卡顿
project-navigator
- 不知道文件在哪里
- 想了解项目结构
- 查找某个功能的代码位置
- 了解模块职责
- 查看已有的工具类、组件、API、Store
- 寻找参考代码
security-guard
- Sa-Token 权限控制配置
- 登录认证、Token 管理
- 数据脱敏处理(@Sensitive)
- 数据加密处理(@EncryptField、@ApiEncrypt)
- 接口限流(@RateLimiter)
- 防重复提交(@RepeatSubmit)
- XSS/SQL注入防护
- 前端权限指令(v-permi、v-role)
store-mobile
- 在移动端创建/使用 Store(Pinia)
- 使用 Composables(useAuth、useDict、usePayment、useHttp 等)
- 跨页面数据共享(移动端)
- 持久化存储(uni.storage)
- HTTP 请求与链式调用
- 认证与权限检查
- 滚动管理与返回顶部
store-pc
- 在 PC 后台创建/使用 Store
- Pinia 状态管理
- 跨组件数据共享(PC端)
- 持久化存储(localCache/sessionCache)
- HTTP 请求链式调用
- 权限判断
- 字典数据加载
task-tracker
- 多步骤功能开发(需要跨会话)
- 复杂需求的步骤分解与跟踪
- 任务进度记录与更新
- 中断后的任务恢复
- 历史任务查询与归档
tech-decision
- 选择用什么技术/库
- 对比不同方案
- 技术决策
- 评估优缺点
- 选择 ruoyi-common 模块
ui-design-mobile
- 设计移动端页面布局
- 页面看起来不够简洁/大气/专业
- 不知道用什么组件布局
- 页面信息太多太乱
- 想让页面更有质感
ui-mobile
- 开发移动端页面(小程序、H5、APP)
- 使用 WD UI 组件(wd-*)
- 移动端列表、表单、弹窗、分页
- useToast、useMessage、usePayment 等
- 平台条件编译(#ifdef)
ui-pc
- 开发前端后台管理页面
- 使用 AForm*、AModal、ADetail、ACard*、AChart*、AAi* 等组件
- 使用 Element Plus 组件
- 表格、表单、弹窗、图表、卡片等前端 UI
- 使用 Composables(useDict、useTableHeight 等)
- 使用 Utils(format、crypto 等)
uniapp-platform
- 条件编译使用
- 平台特性判断
- 跨平台代码适配
- 原生能力调用
utils-toolkit
- 场景以技能描述为准
wechat-integration
- 微信小程序登录
- 微信公众号H5分享
- 订阅消息推送
- 获取微信手机号
- 微信JS-SDK配置
workflow-engine
- 启动工作流程(发起审批、提交申请)
- 办理任务(审批通过、驳回、转办、委派)
- 流程定义管理(设计流程、配置节点)
- 业务模块集成工作流(订单审批、请假申请)
- 监听工作流事件(流程状态变更通知)
- 配置办理人(用户、角色、部门、岗位、SpEL表达式)
命令系统
命令入口总览
命令文件位于 .claude/commands/,当前共 11 个文件。以下按 12 个使用入口展开,覆盖不同模式与同步变体。
| 使用入口 | 定位 | 关键输入 | 主要输出 |
|---|---|---|---|
/start | 快速了解项目状态 | 无 | 项目概况与下一步建议 |
/dev | 新功能开发全流程 | 功能名称、模块 | 代码生成配置与执行计划 |
/crud | 基于已有表快速 CRUD | 表名、模板类型 | 标准 CRUD 代码与菜单 SQL |
/check | 全栈规范检查 | 全量或指定范围 | 规范检查报告与修复建议 |
/init-docs 空白模板 | 新项目文档初始化 | 项目名称、简述 | 空白模板文档 |
/init-docs 扫描模式 | 现有项目文档初始化 | 模式选择 | 扫描生成的现状报告 |
/progress | 项目进度梳理 | 无 | 进度报告与待办建议 |
/next | 下一步建议 | 无 | 分级开发建议清单 |
/add-todo | 快速添加待办 | 任务描述 | 待办清单与状态联动 |
/update-status | 增量更新状态 | 无 | 三文档联动更新报告 |
/sync | 文档全量同步 | 无 | 三文档一致性同步 |
/sync-local | 工作流代码同步 | 起始点与提交选择 | 工作流改动适配与合并建议 |
/start
定位
- 新窗口快速了解项目,区分框架模块与业务模块 输入
- 无显式参数,自动读取
.claude/framework-config.json与最近提交 流程 - 扫描
ruoyi-modules/ruoyi-*,排除框架模块ruoyi-system与ruoyi-generator - 判断项目阶段:全新项目或开发中项目
- 检查
docs/文档是否存在,必要时建议/init-docs输出 - 简洁项目报告,提供
/dev、/crud、/progress等入口
/dev
定位
- 新功能开发的全流程助手,自动生成代码生成器配置 输入
- 功能名称与所属模块(base、mall、iot、crm、marketing 或自定义) 流程
- 检查功能是否已存在,扫描后端、前端与数据库表
- 读取
ruoyi-admin/src/main/resources/application-dev.yml获取数据库配置 - 依据字段后缀规则设计表结构并生成配置方案
- 一次确认后执行建表、菜单、字典与代码生成配置
- 若创建新字典,自动同步前端
DictTypes枚举 输出 - 完整方案与执行结果,包含菜单、字典、表结构与生成入口
/crud
定位
- 基于已存在的数据库表快速生成标准 CRUD 输入
- 表名、模板类型(
crud、tree、sub) 流程 - 自动读取数据库配置并解析表结构
- 根据表结构提取功能名称与接口路径
- 树表与主子表模板支持自动检测与确认 输出
- 生成 CRUD 代码、菜单 SQL 与示例接口清单
/check
定位
- 全栈规范检查,支持全量、模块与文件级检查 输入
/check、/check mall、/check XxxServiceImpl.java流程- 后端检查包名、Service 继承、DAO 层、API 路径与对象转换
- 前端检查 API 目录结构、组件封装、导入规范与样式策略
- 移动端检查 WD UI 导入、字典使用与单位规范 输出
- 规范检查报告与修复建议清单
/init-docs(空白模板模式)
定位
- 面向新项目的空白文档初始化 输入
- 项目名称与简述 流程
- 基于
.claude/templates创建docs/项目状态.md、docs/需求文档.md、docs/待办清单.md输出 - 空白模板文档,便于后续手工完善
/init-docs(扫描现有代码模式)
定位
- 面向已有项目的进度梳理与文档初始化 输入
- 模式选择为扫描现有代码 流程
- 扫描业务 Maven 模块与前端、移动端业务页面
- 排除系统模块与工具目录,仅统计业务域
- 生成现状报告并写入三类管理文档 输出
- 项目进度、需求与待办的初始状态文档
/progress
定位
- 生成项目实现进度报告 输入
- 无显式参数 流程
- 按 Maven 模块统计后端完整度
- 统计前端页面与移动端页面完成情况 输出
- 包含模块、页面、待办与建议的进度报告
/next
定位
- 提供下一步建议与任务优先级 输入
- 无显式参数 流程
- 扫描最近 Git 提交与 TODO/FIXME 标记
- 结合项目阶段输出高、中、低优先级建议 输出
- 下一步行动清单与待确认问题
/add-todo
定位
- 快速添加待办任务并同步项目状态 输入
- 任务描述,支持优先级、预计时间与模块信息 流程
- 自动创建
docs/待办清单.md(如缺失) - 解析任务并写入对应优先级区域
- 若存在
docs/项目状态.md则联动更新待办区域 输出 - 待办新增确认与统计信息
/update-status
定位
- 增量更新项目管理文档 输入
- 无显式参数 流程
- 检测并创建缺失的三类文档
- 扫描业务模块、Git 提交与 TODO 标记
- 更新
项目状态、待办清单、需求文档三文档 输出 - 更新报告,包含新增完成与新增待办
/sync
定位
- 文档全量同步,保证三类文档一致性 输入
- 无显式参数 流程
- 扫描业务模块与 Git 提交作为唯一事实来源
- 同步已完成、进行中与待办任务,并检测冲突 输出
- 同步报告与冲突提示
/sync-local
定位
- 工作流代码同步助手,仅同步 warm-flow 相关改动 输入
- 起始日期或提交 ID,或从
.claude/sync-history-local.json恢复 流程 - 拉取上游
plus-admin/dev与plus-ui/dev的工作流提交 - 分类提交并逐条分析,提供适配建议
- 强制用户确认后再执行合并 输出
- 提交分类报告与适配清单,避免非工作流改动混入
钩子系统
钩子注册方式
- 钩子在
.claude/settings.json中注册 UserPromptSubmit触发技能评估流程PreToolUse仅匹配Bash与Write工具Stop在 Claude 输出结束时执行收尾逻辑
UserPromptSubmit - skill-forced-eval.js
机制
- 从 stdin 读取用户输入,识别恢复会话并跳过评估
- 对以
/开头的命令输入跳过评估,避免干扰命令执行 - 注入强制技能评估指令,要求逐个调用 Skill 工具 要点
- 明确列出可用技能清单,包含 task-tracker 与 workflow-engine
- 规定评估、激活、实现三步流程,禁止并行调用 输出
- 通过 stdout 输出强制评估文本,进入下一步执行
PreToolUse - pre-tool-use.js
机制
- 对
Bash命令进行危险模式识别并阻止 - 拦截
> nul等错误重定向,避免 Windows 生成nul文件 - 对
Write写入敏感文件时给出提醒 要点 - 阻止
rm -rf /、drop database、git push --force等高风险命令 - 对
npm publish、docker system prune等敏感操作给出警告 - 命令阻止使用
decision: block与reason输出说明
Stop - stop.js
机制
- 汇总
git diff、已暂存与未跟踪文件,生成变更提示 - 递归清理误创建的
nul文件(限制深度并排除node_modules) - 根据系统播放
.claude/audio/completed.wav完成提示音 要点 - macOS 使用
afplay,Windows 使用 PowerShell 播放,Linux 使用aplay或paplay - 变更统计以
systemMessage输出,便于后续动作
最佳实践
- 先用
/start识别项目阶段,再决定/dev或/crud - 新功能开发优先使用
/dev,避免遗漏菜单、字典与生成配置 - 已有表且仅需标准 CRUD 时使用
/crud提升速度 - 每次开发前阅读现有模块代码,避免风格偏移
- 严格遵守
plus.ruoyi包名与四层架构约束 - Service 实现类不继承基类,DAO 必须包含
buildQueryWrapper() - 对象转换统一使用
MapstructUtils,避免BeanUtil - 前端页面必须使用 AForm、AModal 等封装组件
- 移动端必须使用 WD UI 组件与
@/wd的 Composables - API 路径与方法名需包含实体名,确保全局唯一
- 每次提交前运行
/check,提前暴露规范问题 - 使用
/add-todo记录任务,避免临时口头约定 - 频繁更新时使用
/update-status,阶段性整理用/sync - 工作流同步必须走
/sync-local,确保只合并 warm-flow 相关提交 - 技能评估必须完整执行,严禁跳过 Skill 激活步骤
- 遇到性能与 Bug 问题时分别使用 performance-doctor 与 bug-detective
- 任务复杂且需跨会话时使用 task-tracker 记录上下文
实战案例
案例一:商城优惠券管理新功能
场景
- 需要新增业务模块,包含菜单、字典与完整 CRUD 使用命令
/start获取项目状态/dev进入新功能开发流程 触发技能- crud-development、database-ops、api-development 关键步骤
- 输入功能名与模块
mall,自动推断表前缀与包名 - 检查数据库是否已有表,避免重复开发
- 生成表结构、菜单与字典配置并一次确认
- 执行配置 SQL 并提示前端字典同步 示例对话
用户: /dev
用户: 功能名称 优惠券管理,模块 mall
Claude: 输出配置方案与建表 SQL,确认后自动生成配置产出
- 新增菜单、字典与生成配置,前端 API 与类型定义同步
案例二:已有表快速生成标准 CRUD
场景
- 数据库已有
b_feedback表,需要快速生成 CRUD 使用命令 /crud触发技能- crud-development、database-ops 关键步骤
- 输入表名并读取
application-dev.yml获取连接配置 - 自动解析表结构并确认模板类型
- 输出 CRUD 代码生成结果与接口清单 示例对话
用户: /crud
用户: 表名 b_feedback,模板 crud
Claude: 输出表结构分析与生成结果产出
- 标准 CRUD 后端与前端代码、菜单 SQL 与接口路径
案例三:文档初始化与持续同步
场景
- 项目已有代码但缺少管理文档,需要统一状态 使用命令
/init-docs扫描模式/add-todo添加待办/update-status增量更新/sync全量同步 触发技能- task-tracker、project-navigator、code-patterns 关键步骤
- 扫描业务模块与页面生成初始文档
- 添加待办任务并同步到项目状态
- 日常使用
/update-status保持三文档联动 - 阶段性使用
/sync做一致性核对 示例对话
用户: /init-docs
用户: 选择扫描现有代码模式
Claude: 输出项目状态、需求与待办文档产出
docs/项目状态.md、docs/需求文档.md、docs/待办清单.md
案例四:工作流代码同步
场景
- 需要从上游仓库同步 warm-flow 相关改动 使用命令
/sync-local触发技能- workflow-engine、architecture-design、code-patterns 关键步骤
- 拉取上游提交并筛选工作流相关改动
- 分类提交并逐条分析需要适配的内容
- 用户确认后再合并,确保只同步工作流改动 示例对话
用户: /sync-local
用户: 起始点 2025-11-01
Claude: 输出提交分类与适配建议清单产出
- 仅引入 warm-flow 相关更新,保留本项目架构一致性
