跳到主要内容

数据字典

数据字典用于维护一组「标签 - 映射值」的枚举项,供平台其他配置引用与翻译。

概述​

数据字典是应用级别的一组键值对集合:每一项包含一个对用户可见的标签(label)和一个程序使用的映射值(value)。当表单、视图列表、审批流等配置需要固定的下拉选项,或需要在存储值与展示文案之间转换时,可以引用数据字典统一维护。

入口:开发中心 → 应用 → 数据字典。数据字典以应用为维度管理,列表展示当前应用下的全部数据字典。

数据字典列表支持:

操作说明
新建数据字典填写名称、描述与字典项后创建
编辑修改名称、描述与字典项
查看详情以抽屉展示数据字典属性与其全部字典项

配置项​

配置项说明
名称数据字典名称,必填,长度受限
描述数据字典用途说明,可选
字典项一组「标签 - 映射值」,至少包含一项,详见 数据字典属性配置

列表与查询​

列说明
名称数据字典名称,支持按名称模糊查询
描述数据字典描述
最近修改时间最后一次修改时间,支持排序
操作查看详情、编辑

列表按应用隔离,仅展示当前应用下的数据字典,默认按修改时间倒序排列。

字典项​

字典项是数据字典的核心内容,每个字典项包含:

字段说明
标签展示给用户看的文案,必填
映射值程序使用的值,必填;新增时自动生成一个 GUID 作为默认值,可修改

字典项支持拖拽排序与行内编辑,并提供 JSON 模式编辑用于批量维护。详细说明见 数据字典属性配置。

谨慎删除字典项

删除已存在的字典项后,历史数据中依赖该项的记录将无法正确翻译为标签。在未明确该项已不再被使用时,请勿删除历史字典项。

下一步​

数据字典数据模型​

以下内容面向技术实现与 AI 检索。

实体属性​

数据字典实体 DataDictionary:

属性名类型含义取值/存储值
_idstring(GUID)主键例:7c1d2e3f-...
AppIdstring(GUID)所属应用,必填应用 _id
Namestring名称,必填VerifyLengthLimit 校验
Itemsstring字典项 JSON 字符串DicLabelValue[] 序列化串
Descriptionstring描述纯文本,可为空
Customizedbool是否被租户自定义过非开发租户修改内置字典后为 true
CustomCreatedbool是否由租户自定义创建客户租户新建时为 true

数据字典继承自 AppEntityBase,同时具备 IsDeleted、CreatedBy / CreatedTime、ModifiedBy / ModifiedTime、Organization、WorkflowDataId、ApprovalStatus、Shared 等通用属性。

字典项结构​

前端字典项为 LabelValue:

属性名类型含义
labelstring标签(用户可见文案)
valuestring映射值(程序使用)
keystring可选,前端项标识
childrenLabelValue[]子项(数据字典当前为扁平结构)

服务端持久化时仅序列化 label 与 value 两个字段。

存储示例​

数据字典存储在数据表 system_datadictionary 中,Items 为 JSON 字符串:

{
"_id": "7c1d2e3f-4a56-4b78-9c0d-1e2f3a4b5c6d",
"AppId": "9f1c0b2e-2d3a-4e6f-9c11-0f7a5b8d2e10",
"Name": "订单状态",
"Items": "[{\"label\":\"草稿\",\"value\":\"draft\"},{\"label\":\"已提交\",\"value\":\"submitted\"}]",
"Description": "订单的流转状态",
"Customized": false,
"CustomCreated": true,
"IsDeleted": false,
"CreatedBy": "admin",
"CreatedTime": "2026-02-18T10:05:00"
}

服务端校验​

保存数据字典(Create / Edit)时,服务端会校验并规整 Items:

规则说明
格式校验Items 必须是合法的 JSON 数组,否则报错
空映射值补全映射值为空时自动生成一个 GUID
去空格label 与 value 均去除首尾空格
映射值唯一同一字典内映射值不可重复,重复则报错

相关接口​

接口说明
POST /api/DataDictionary/GetList分页获取数据字典列表(BizTable 契约,通常按 appid 过滤),仅返回有应用权限的数据
POST /api/DataDictionary/Create新建数据字典
POST /api/DataDictionary/Edit编辑数据字典
GET /api/DataDictionary/Get获取数据字典详情