07-材料解析.md 7.7 KB

材料解析(需求 / 原型 / 表结构 → 字段清单)

用户通常给三类材料,先解析成字段清单,再生成代码,不要拿着材料直接写页面。

材料 从里面取 权威范围
需求文档(md / doc / docx) 业务规则、必填、校验、默认值、状态流转、按钮 规则与文案
原型(vue + mock.js) 页面结构、查询条件、列、表单分组、控件形态、字段名 控件与布局
表结构(.sql / ER 图) 字段、类型、长度、可空、主键、外键、注释 类型与长度

冲突时按 表结构定类型 → 原型定控件与布局 → 需求定规则与文案 处理,冲突点在交付时列出来让用户拍板。


一、从 mock.js 提字段

mock 里的对象 key 就是字段名,值类型决定控件。

// 原型里的 mock
const list = [
  { id: '1', name: '标准A', dataType: 1, officeName: '总部', status: 1, createDate: '2026-01-01' }
]

const formData = {
  name: '',
  dataType: undefined,
  officeIds: null,
  ownerId: '',
  status: true,
  remark: ''
}
mock 值 推断
'' 文本
0 / 123 数字(sort / *_num 用 a-input-number precision: 0)
0.00 金额,precision: 2
true / false 开关
'2026-01-01' 日期;'2026-01-01 10:00:00' 日期时间
undefined + *Ids 组织树 / 多选
[] 多选或上传,看字段名
嵌套对象 / 数组 关联数据,按 ER 关系处理(见第五节)
  • 列表 mock 的第一条 → 列表列字段与顺序。
  • 表单 mock → 表单字段与初始值。
  • mock 里只有 xxxName 没有 xxxId → 该字段是只读展示,表单里不出现。

二、从 sql 提字段

类型映射

sql 类型 控件 属性
varchar(n) / char(n) a-input :maxlength="n"
text / longtext / mediumtext a-textarea :rows="3" full
int / bigint / smallint a-input-number :precision="0"
decimal(p,2) a-input-number :precision="2"、:step="0.01"
tinyint(1) a-switch 提交转 1 / 0
tinyint / enum a-select 取值看注释,没注释就问
datetime / timestamp a-date-picker show-time、value-format="YYYY-MM-DD HH:mm:ss"
date a-date-picker value-format="YYYY-MM-DD"
time a-time-picker value-format="HH:mm:ss"
json a-textarea 业务明确要结构化再换控件

NOT NULL 且无默认值 → 必填;有 DEFAULT → 非必填并带上默认值。

列名后缀规则

列名特征 判定
office_id / org_id / dept_id / campus_id 组织树 s-data-range-tree-select
user_id / owner_id / create_by / update_by 选人 s-user-select(create_by / update_by 只展示不进表单)
*_url / *_path / file / attachment / image 上传 s-file-upload
status / is_* / enabled / enable_flag 开关 + 列表标签
*_type / *_status / *_category 字典下拉,字典类型优先取字段注释,其次 表名_字段
sort / order_num / seq a-input-number :min="1"
remark / description / memo / content 文本域,full
create_time / update_time / create_by / update_by / del_flag 只展示或不展示,不进表单
id / *_id(主键) 隐藏字段

表名前缀(如 md_standard)去掉后再转驼峰做 api 文件名:md_standard → standard,sys_position → position。


三、从原型 vue 提结构

原型里有 取什么
s-filter-item 顺序 查询区顺序;超过 4 个,前 3~4 个留主行,其余进 #filterMore
columns 列顺序、width、align、哪些列有 template
s-collapses-item 表单分组标题与组内列数
s-form 的 column 每行列数,最大 4
工具栏按钮文案 映射 key:添加 add、导入 import、导出 export、批量删除 remove
操作列按钮 查看 / 修改 / 删除,对应 view / edit / remove
mock.js 的接口名 api 函数命名参照(page / save / getById / deleteById)

原型没写的布局细节按常规来:查询区 3~4 项、表单 2 列、长文本与附件 full。


四、从需求文档提规则

需求里的说法 落到
「必填」「不能为空」 rules 加 required,trigger 输入类 blur、选择类 change
「唯一」「不能重复」 前端不做唯一校验,交给接口;只在交付说明里提一句
「最长 N 字」 :maxlength="N" + rules 的 max: N
「手机号 / 邮箱 / 身份证」 rules 加 pattern
「同一时间只能…」「按 X 联动显示」 computed 生成 rules 或 v-if 控制显隐
「默认启用」「默认当前组织」 defaultForm() 里给默认值
状态流转(草稿→审批) 列表状态列用不同颜色标签,操作列按状态显隐按钮
特殊排版要求 记下来,决定表单是否要分组 / 是否单独出详情文件

五、ER 图关系处理

关系 落地
N:1(明细属于组织) 表单里做成下拉 / 组织树,存 xxxId
1:N(主表带明细行) 用 s-list-table-tree-layout 或子表组件,单独确认后再做
N:N(多对多) 多选控件,提交数组
有外键但原型没有 按外键列名走第二节的后缀规则

ER 图只给了图、没给字段名时,按原型 mock 的字段名走,并在交付时标注「字段名取自原型,需与后端核对」。


六、材料不全时

缺什么 怎么办
表结构 按 mock 字段生成,类型一律文本或数字,交付时标注「类型待后端确认」
原型 按需求字段清单 + 常规列表布局(查询 3 项、表单 2 列)
需求文档 按表结构字段全量生成标准 CRUD,不做业务规则
三者都只有文字描述 只按文字里的字段名生成,缺的字段不编造

七、字段清单产出格式

解析完先在对话里出这张表,用户确认后再生成代码:

字段名 中文 类型 控件 必填 列表 查询 说明
name 数据名称 varchar(50) a-input 是 ✓ ✓ 模糊查询
dataType 数据类型 tinyint 字典 data_type 是 ✓ 标签 ✓ —
officeIds 所属组织 varchar(32) 组织树 是 显示 officeName 左侧树过滤 提交转 officeId
ownerId 负责人 varchar(32) 选人单选 否 显示 ownerName — 同时存 ownerName
status 启用状态 tinyint(1) a-switch 否 ✓ 标签 ✓ 提交转 1/0
fileUrl 附件 varchar(500) s-file-upload 否 — — 逗号分隔多文件
remark 备注 varchar(255) a-textarea 否 — — full
createDate 创建日期 date a-date-picker 否 ✓ 区间进「更多」 —

这张表就是后续 api、列表、表单、详情四处的唯一依据。

字段表下面再跟一段本次产出清单,文件按需求功能项算(判定表见 00-生成流程.md 第四节),不是固定几个:

产出文件 因为需求里有
src/api/master-data.js 全部功能
src/views/master-data/standard/index.vue 列表、查询、导入、导出
src/views/master-data/standard/form.vue 新增、修改、详情(复用只读)
src/views/master-data/i18n.js 页面文案

需求里没有的功能不出文件、不出代码,清单里也不列。