Skip to content

hanfangyu/ruoyi-cloud-plus-best-practices

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

RuoYi-Cloud-Plus Best Practices

一个针对 RuoYi-Cloud-Plus 后端开发 的单一 Skill。
安装一次,即可在同一个工作流里同时获得:DDD 建模、基础服务拆分、代码规范落地。

为什么值得安装

如果你在 RuoYi-Cloud-Plus 项目里经常遇到这些问题,这个 Skill 会直接有用:

  • 新需求一上来,不确定该放 ruoyi-commonruoyi-api 还是 ruoyi-modules
  • 服务分层混乱,controller/service/mapper 边界容易串层
  • 跨服务接口经常“先写实现后补契约”,导致返工
  • PR review 时,代码风格和注解使用标准不一致
  • 想做 DDD,但又不想推翻现有项目结构

一次安装,覆盖三类核心能力

  1. DDD 服务建模
  • 在现有 RuoYi-Cloud-Plus 分层里落地 DDD(不强行重构成另一套架构)
  • 明确聚合边界、服务职责、依赖方向、跨服务契约
  1. 基础服务拆分与复用
  • 指导 ruoyi-commonruoyi-apiruoyi-modules 的正确归位
  • 统一处理共享能力沉淀、RPC 契约定义、Provider/Consumer 接入
  1. 代码规范与评审对齐
  • 统一 controller/service/domain/mapper/dubbo 的命名和写法
  • 强化权限、日志、幂等、事务、分页、返回体等关键规范

你会得到什么输出

使用这个 Skill 执行任务时,会要求产出:

  1. 影响范围与模块归属
  2. 架构与依赖决策
  3. 文件级改动计划(或直接改动结果)
  4. 规范一致性与风险检查清单

这意味着它不仅告诉你“怎么写”,还会告诉你“为什么这么放”。

适用场景

  • 新增业务微服务或重大功能模块
  • 现有模块做架构整理、分层治理、技术债清理
  • 抽取通用能力到 ruoyi-common
  • 新增跨服务能力到 ruoyi-api + Dubbo Provider
  • PR 提交前做一次“项目风格对齐”

技能结构(单 Skill)

ruoyi-cloud-plus-best-practices/
  SKILL.md
  references/
    ddd.md
    basic-service.md
    code-convention.md
  • SKILL.md:统一入口(安装一次即可)
  • references/ddd.md:DDD 分层与边界规则
  • references/basic-service.md:基础服务拆分和依赖规则
  • references/code-convention.md:代码规范与评审清单

使用方式(示例)

在对话里直接说明你要做的事,并显式提到 Skill 名称:

  • 请使用 ruoyi-cloud-plus-best-practices,帮我新增一个订单域服务并给出模块归属
  • 请使用 ruoyi-cloud-plus-best-practices,帮我把这段逻辑从业务模块抽到 ruoyi-common
  • 请使用 ruoyi-cloud-plus-best-practices,对这个 PR 做规范和分层审查

仓库地址

如果你想要,我可以继续补一版:

  • 面向团队 onboarding 的“30 分钟上手模板”
  • 适配你们团队的 PR 检查项(可直接复制到仓库模板)

About

Best-practice Codex skills for RuoYi-Cloud-Plus

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors