用户一般给「需求文件 + 原型 + 表结构 + 项目目录」四样,按本文顺序走完即可产出可运行代码。
用户的实际提示词长这样:
项目根目录:D:\xxx\业务项目
需求文件:xxx.doc / xxx.md # 业务规则、必填、状态流转
原型图:vue + mock.js # 页面结构、查询条件、列、表单分组
表结构:ER 图 或 xxx.sql # 字段、类型、长度、外键
其他要求:…
槽位不齐时按第三节处理,不要凭空编字段。
| 步 | 做什么 | 查哪份 |
|---|---|---|
| 1 | 读表结构 → 字段、类型、长度、外键 | 07-材料解析.md 第二节 |
| 2 | 读原型 → 查询条件、列、表单分组、控件、字段名 | 07-材料解析.md 第一节、第三节 |
| 3 | 读需求 → 必填、校验、默认值、按钮、特殊排版 | 07-材料解析.md 第四节 |
| 4 | 合成字段清单,先在对话里出表让用户确认 | 07-材料解析.md 第七节 |
| 5 | 确认后按第四、七节生成文件 | — |
字段清单没确认就写代码,返工概率很高。
| 槽位 | 缺失时怎么处理 |
|---|---|
| 页面中文名 | 取表名或菜单 hrefs 最后一段转中文(deviceLedger → 设备台账) |
| 菜单 hrefs | 必须问,决定 src/views/ 下的目录名 |
| 接口路径前缀 | 默认按表名转 kebab(md_standard → /md-standard),集中写在 api 顶部便于一处改 |
| 接口网关 | 默认 VITE_APP_SYS_SERVER_NAME;组织/用户/角色/字典/文件用 VITE_APP_PORTAL_SERVER_NAME |
| 功能范围 | 默认全套:分页查询、新增、修改、删除、导入、导出、详情 |
| 权限码 | 默认 add / edit / remove / export / import |
| 字段必填 | 表结构 NOT NULL 且无默认值 → 必填;需求里写「必填」覆盖表结构 |
| 字典类型 | 优先字段注释,其次 表名_字段;两者都没有就停下来问 |
| 表结构缺失 | 按 mock 字段生成,类型一律文本/数字,交付时标注「类型待后端确认」 |
| 原型缺失 | 按字段清单 + 常规布局(查询 3 项、表单 2 列、长文本 full) |
| 后端接口未就绪 | api 顶部 const USE_MOCK = false,置 true 页面可先跑通 |
必须停下来问的只有三处:菜单 hrefs 未知、字段清单为空、字典类型查不到。
需求没特殊说明时,列表页默认做全套(分页查询、新增、修改、删除、导入、导出、详情)。
产物文件数量不固定,先按需求列功能项,再据此推文件。 下面是判定表,逐条过一遍需求,命中的才生成:
| 需求里出现 | 产物 | 备注 |
|---|---|---|
| 任何页面 | src/api/<api文件>.js |
只写这次真正调用的接口,用不到的接口不留空壳 |
| 列表 / 查询 / 分页 | src/views/<模块>/<页面>/index.vue |
|
| 新增 | form.vue 的 add() |
|
| 修改 | form.vue 的 edit(id) |
|
| 查看 / 详情 | form.vue 的 view(id) 只读模式 |
排版、字段与表单一致就复用 |
| 详情排版或内容与表单明显不一致 | 另加 <页面>/detail.vue |
抄 assets/detail-page.vue |
| 无任何表单入口,纯列表 | 不出 form.vue |
|
| 需求是纯表单页 / 纯详情页,没有列表 | 只出 form.vue / detail.vue |
不出 index.vue |
| 导入 | index.vue 导入按钮 + api 四个导入接口 + 上传地址 |
不做就整块不生成 |
| 导出 | index.vue 导出按钮 + api 导出函数 |
|
| 删除 | 操作列删除 + api 删除函数 | 只做逻辑删除时按钮文案按需求写 |
| 左侧组织/分类树 | 不外挂文件:index.vue 启用 #tree + api 左树两段 |
|
| 主表带明细子表 | 不外挂文件:form.vue 内嵌子表 |
子表要独立维护成单独接口/页面时才拆 |
| 页内多个分组/标签页 | 不外挂文件:s-tab 或 s-collapses 分区 |
分区体量大且独立时才拆 |
| 字段多需要整页编辑 | 不外挂页面:form.vue 换 s-form-layout |
判定完把「本次产出文件清单」写进字段清单确认表一起给用户,确认后再写代码。
路由不用写:菜单配好 hrefs 后自动匹配 src/views/**/<hrefs>/index.vue,page-entries.js 保持空。
模板里 __全大写__ 是待替换标记:
| 占位符 | 替换成 | 示例 |
|---|---|---|
__MODULE__ |
模块目录名(= i18n 命名空间) | master-data |
__PAGE__ |
页面目录名(= 菜单 hrefs 最后一段) | standard |
__NAME__ |
页面中文名 | 数据标准 |
__API__ |
api 文件名 / 上传 path | master-data |
__PATH__ |
接口路径前缀 | /master-data |
__COMPONENT__ |
组件 name 前缀 | Standard |
__DICT_TYPE__ / __DICT_KEY__ |
字典类型 / 驼峰键 | data_type / dataType |
替换完在生成目录里搜 __,必须零命中;xxx 这类示例值同样要清掉。
| 对象 | 规范 | 示例 |
|---|---|---|
| 列表组件 name | __COMPONENT__List |
StandardList |
| 表单组件 name | __COMPONENT__FormModal |
StandardFormModal |
| 详情组件 name | __COMPONENT__DetailModal |
StandardDetailModal |
| api 函数 | page / getById / save / deleteById / deleteByIds / exportExcel / templateDownload / importPreview / importData / exportExceptionData |
— |
| 页面内 api 别名 | page as pageApi |
避免和分页变量重名 |
| 查询条件 | queryParam |
— |
| 表单对象 | form,初始值收敛到 defaultForm() |
— |
| i18n 命名空间 | 等于模块目录名 | window.useI18n('master-data') |
按第四节判定出的文件清单逐个生成,顺序按依赖走:
src/api/<api文件>.js —— 从 assets/api.js 起,只留用得上的接口,先定函数名src/views/<模块>/<页面>/index.vue —— 有列表才出,从 assets/list-page.vue 起src/views/<模块>/<页面>/form.vue —— 有新增/修改/查看才出,从 assets/form-modal.vue 起(三模式)src/views/<模块>/<页面>/detail.vue —— 仅详情排版或内容不一致时src/views/<模块>/i18n.js —— 模块词条,格式见 01-说明文档.md 第四节需求里没有的条目直接跳过,不建空文件、不留 TODO 注释。
src/views/<模块>/<页面>/index.vue,目录名 = 菜单 hrefs 最后一段__ 占位符、无 xxx 示例残留page() 返回 { list, total };区间字段在 api 层拆成起止日期form.vue 暴露的方法与列表里的入口对得上(有修改才有 edit,有详情才有 view)s-form-item 都有 name,rules 键与之一致value;组织树提交转 officeId;开关转 1/0;附件 join(',')$l('中文'),模块词条在 views/<模块>/i18n.js