Skip to content
OpenAgentSkill
Browsing is open · Catalog captured 2026-11-21 · Automatic updates and account services are paused.
Development

jeecg-codegen-new

Use when user asks to generate JeecgBoot CRUD code, create a new module, add/modify fields on existing module, or says "代码生成", "生成代码", "创建模块", "新增功能", "建表", "加字段", "加一个字段", "增加字段", "新增字段", "修改字段", "删除字段", "generate code", "new entity", "add field"

jeecgboot · AI review on file

Installation

Read the source and dependencies before running a command. Copying does not install or execute anything.

npx skills add jeecgboot/skills --skill jeecg-codegen-new

About this skill


name: jeecg-codegen-new description: Use when user asks to generate JeecgBoot CRUD code, create a new module, add/modify fields on existing module, or says "代码生成", "生成代码", "创建模块", "新增功能", "建表", "加字段", "加一个字段", "增加字段", "新增字段", "修改字段", "删除字段", "generate code", "new entity", "add field" disable-model-invocation: true

JeecgBoot 代码生成器(Freemarker 驱动)

把用户的自然语言需求转成 Freemarker 上下文 JSON,交给 scripts/codegen.py 调用模板生成全套 CRUD(后端 Java + 前端 Vue3 + 菜单 SQL)。

核心原则

AI 不再从零写代码。 基础代码全部由 jeecg 官方 Freemarker 模板生成,AI 只做三件事:

  1. 拼参数 — 把用户需求映射成 ctx.json
  2. 调脚本 — 跑 scripts/codegen.py 让 Freemarker 出基础代码
  3. 改产物 — 用户提了模板不覆盖的特殊需求时,用 Edit 改已生成的代码

⛔ 禁止修改 templates/ 目录下任何模板文件。模板由 jeecg 官方维护,改了就脱离了升级路径。 ⛔ 禁止绕开脚本直接手写 Entity / Controller / data.ts 等基础文件。

主数据复用

涉及字典、角色、用户、部门时遵循"先查后建",使用 jeecg-system skill。详见 ../jeecg-system/SKILL.md。

接口禁止猜测

所有接口路径/参数必须来自用户提供、jeecg-system skill 文档、或经查询确认。猜测命中也算违规。


模板覆盖范围

不是所有"表类型 × 前端风格"的组合都有模板。先选表类型 → 决定可选的前端风格:

表类型模板 stylePath支持前端风格触发关键词
单表default/onevue3 vue3Native默认
树表default/treevue3 vue3Native分类/层级/树/上下级
一对多 — Tab-in-Modaltab/onetomanyvue3tab风格 / radio切换 / 标题栏切换
一对多 — 内嵌子表inner-table/onetomanyvue3内嵌子表 / 行展开 / expandedRowRender
一对多 — ERPerp/onetomanyvue3 vue3NativeERP风格 / 独立编辑

不支持的组合: 一对多 + 默认布局(即旧 SKILL 中的"原始布局")目前没有 vue3 模板,jeecg 官方枚举 CgformEnum.MANY 仅支持 vue2。 如果用户要"默认/原始布局"的 vue3 一对多,改推荐 tab 或 inner-table,并向用户说明原因。


交互流程

Step 0 — 判断操作类型

  • 关键词 "加字段 / 删字段 / 改字段 / 给XX加" → 增量修改(跳到本文末"增量修改"章节)
  • 其他 → 全量生成

Step 1 — 收集参数(一次性问完)

⛔ **铁律:**Step 2 摘要被用户明确确认前,禁止调脚本、禁止落地任何文件、禁止执行任何 SQL。 "需求很清楚了""都用默认值""先生成再改" 都是合理化跳过确认的借口,全部无效。

向用户一次问全所有缺失项(已知项可填默认值并标注"如无异议保留"):

项默认值 / 提示
后端模块根<backend_root>(如 D:/jeecgboot/jeecg-module-system/jeecg-system-biz)
前端项目根<frontend_root>(如 D:/jeecgboot-vue3)
Flyway SQL 目录<backend>/jeecg-module-system/jeecg-system-start/src/main/resources/flyway/sql/mysql
bussiPackageorg.jeecg.modules
entityPackage由用户给(如 biz / edu)
entityName / tableName由用户给或推导(如 BizGoods / biz_goods)
描述(中文)用户业务名(如"商品管理")
表类型单表 / 树表 / 一对多
一对多风格仅一对多需要:tab / inner-table / erp
前端风格vue3 或 vue3Native(结合表类型用上表校验是否支持)
字段清单已有表 → 查 DDL 自动取;新建表 → 由用户描述
字典自动匹配默认是。开启后会查 sys_dict 自动套字典编码(见下方"字典匹配")
目标数据库名仅"已有表/字典查询/本地执行 SQL"时需要,必须由用户确认

Step 2 — 展示摘要

把构造好的 ctx.json 用表格展示给用户:

  • 表头:表名、实体名、风格、前端风格、字段数
  • 字段表:fieldName / fieldDbName / 注释 / fieldDbType / classType / 字典 / 必填 / 列表显示 / 表单显示 / 查询
  • 不要 dump 整个 JSON,太冗长

明确询问 "是否生成?" — 收到 "确认 / ok / 可以 / 没问题" 等表述后才进入 Step 3。

Step 3 — 调用脚本

调用前先把构造好的 JSON 写到临时目录(路径规则见下方"临时配置文件规则"),然后用绝对路径调脚本。

SKILL 路径定位: 脚本永远在 <SKILL_ROOT>/scripts/codegen.py。<SKILL_ROOT> 就是包含 SKILL.md 的那个目录,比如 C:\Users\moe\.claude\skills\jeecg-codegen-new 或 E:\Projects\BJGJ\jeecg-skills\jeecg-codegen-new——你能加载 SKILL.md 就能得出这个路径,不要再去 Read codegen.py 来确认任何东西,下面的 CLI 参考就是脚本的完整契约。

完整 CLI 参考

python <SKILL_ROOT>/scripts/codegen.py [OPTIONS]
参数必填默认取值说明
--style✅—default/one default/tree default/onetomany tab/onetomany inner-table/onetomany erp/onetomany模板风格,见"模板覆盖范围"表
--ctx✅—文件路径ctx.json 路径,必须在 {tempdir}/jeecg-codegen-new/<表名>_ctx.json
--frontend-style🟡vue3vue3 vue3Native必须与 --style 兼容,否则脚本拒绝(详见"模板覆盖范围"表)
--backend-root🟡—后端模块根比如 D:/jeecgboot/jeecg-module-system/jeecg-system-biz,脚本会自动拼 /src/main/java/<bussiPackage>/<entityPackage>/
--frontend-root🟡—前端项目根比如 D:/jeecgboot-vue3,脚本会自动拼 /src/views/<entityPackage>/
--mobile-root❌—uniapp 项目根不传则跳过 uniapp/uniapp3 产物——常规需求都不需要传
--flyway-dir🟡—Flyway SQL 目录菜单 SQL 落到这里;同名 SQL 自动去重
--out❌—任意目录调试用:渲染产物原样落到此目录,跳过分发。设了它就不需要 backend/frontend/flyway-root
--dry-run❌falseflag打印分发计划但不写文件

🟡 = 在没有 --out 的"正常模式"下,至少要传 --backend-root 或 --frontend-root 或 --flyway-dir 之一(任何没传的目录类型对应的产物都被跳过);正常代码生成场景三个都该传。

✅ = 任何模式都必填。

退出码 & 输出

  • 退出码 0 = 成功;其他都失败(参数非法、Java 编译失败、Freemarker 渲染异常)
  • 标准输出每行一个事件:[codegen] WROTE <绝对路径>、[codegen] WOULD WRITE ...(dry-run 时)、[codegen] running FtlRunner … 等
  • 失败时 stderr 含完整 Java 栈或 [codegen] xxx 错误信息

典型调用(复制后改 4 个值即可)

python E:/Projects/BJGJ/jeecg-skills/jeecg-codegen-new/scripts/codegen.py \
  --style default/one \
  --ctx /c/Users/moe/AppData/Local/Temp/jeecg-codegen-new/biz_goods_ctx.json \
  --backend-root D:/jeecgboot/jeecg-module-system/jeecg-system-biz \
  --frontend-root D:/jeecgboot-vue3 \
  --frontend-style vue3 \
  --flyway-dir D:/jeecgboot/jeecg-module-system/jeecg-system-start/src/main/resources/flyway/sql/mysql

临时配置文件规则(强制)

所有传给脚本的 --ctx <xxx.json> 必须写到 {系统临时目录}/jeecg-codegen-new/ 下,由操作系统自动清理;skill 与脚本均不主动删除该目录或文件。

import tempfile, os, json

SKILL_NAME = "jeecg-codegen-new"
skill_dir = os.path.join(tempfile.gettempdir(), SKILL_NAME)
os.makedirs(skill_dir, exist_ok=True)          # 确保目录存在,不主动检查

config_path = os.path.join(skill_dir, 'biz_goods_ctx.json')   # 示例文件名:<表名>_ctx.json
with open(config_path, 'w', encoding='utf-8') as f:
    json.dump(cfg, f, ensure_ascii=False, indent=2)

tempfile.gettempdir() 自动适配:Windows %TEMP%、Linux /tmp、macOS /var/folders/.../T(注意 macOS 并非 /tmp)。 文件名建议使用 <表名>_<步骤>.json(如 biz_goods_ctx.json / biz_goods_alter.json),无需重复技能前缀,因路径已包含技能名称,便于排错。

❌ 禁止:

  • 写到 <skill>/tmp/ 或当前工作目录(污染 skill / 用户项目)
  • 硬编码 /tmp、C:\Temp 或任何固定路径(不跨平台)
  • 每步完成后主动 rm / Remove-Item(操作系统会清理,属多余 tool call)
  • 主动 os.path.exists() 检查(其本身即为一次 tool call) (使用 os.makedirs(…, exist_ok=True) 满足需求,不算主动检查)

**临时文件可能被操作

Read the complete source ↗