Skip to main content

数据字典属性配置

数据字典的名称、描述与字典项的配置方法,以及字典项的编辑方式与存储格式。

概述​

数据字典的属性在「新增 / 编辑」弹窗中维护。每条数据字典包含基础信息(名称、描述)与字典项两部分。

配置项​

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

名称与描述​

  • 名称:数据字典的显示名称,必填且受长度限制,用于在引用时识别该字典。
  • 描述:用途说明,可选,建议写明字典的业务范围与适用场景。

字典项配置​

字典项是一个有序的「标签 - 映射值」列表,每一项包含两个必填字段:

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

操作方式:

操作说明
添加字典项点击「添加」按钮追加一个空项
删除字典项点击字典项右侧的删除按钮移除该项
拖拽排序拖动字典项左侧的拖拽手柄可调整顺序
行内编辑直接在标签与映射值的输入框中修改
谨慎删除字典项

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

JSON 模式编辑​

点击「JSON 模式编辑」按钮可打开 JSON 编辑器,用于批量维护字典项:

  • 编辑内容是一个 JSON 数组,每项形如 { "label": "...", "value": "..." }。
  • 保存时会把 JSON 解析后的结果写回字典项列表,与行内列表共用同一份数据。
  • JSON 格式不正确(无法解析或不是数组)时会提示「JSON 格式不正确」,不写回。

查看字典项​

数据字典详情抽屉在属性下方以表格展示字典项,列为「字典项(label)」与「映射值(value)」。

下一步​

  • 数据字典 - 返回总览,了解列表、操作与接口
  • 实体对象 - 数据字典所属应用下的实体对象

属性与存储明细​

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

属性表​

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

前端字段与持久化字段​

前端字段持久化字段说明
DicItemsItems前端使用 DicItems(LabelValue[])编辑,提交时序列化为 Items(JSON 字符串)
labelItems[].label标签
valueItems[].value映射值

字典项 JSON 格式​

[
{ "label": "草稿", "value": "draft" },
{ "label": "已提交", "value": "submitted" },
{ "label": "已完结", "value": "closed" }
]

存储到 system_datadictionary.Items 时为该 JSON 的字符串形式:

"[{\"label\":\"草稿\",\"value\":\"draft\"},{\"label\":\"已提交\",\"value\":\"submitted\"},{\"label\":\"已完结\",\"value\":\"closed\"}]"

服务端校验规则​

规则说明失败表现
名称必填Name 非空且长度受限保存失败
JSON 合法Items 可解析为 JSON 数组抛出「数据字典项格式不正确」
空值补全value 为空时自动生成 GUID自动补全,不报错
去空格label、value 去除首尾空格自动规整
映射值唯一同一字典内 value 去重后数量与项数一致抛出「数据字典项映射值重复」

存储示例​

{
"AppId": "9f1c0b2e-2d3a-4e6f-9c11-0f7a5b8d2e10",
"Name": "订单状态",
"Items": "[{\"label\":\"草稿\",\"value\":\"draft\"},{\"label\":\"已提交\",\"value\":\"submitted\"},{\"label\":\"已完结\",\"value\":\"closed\"}]",
"Description": "订单的流转状态",
"Customized": false,
"CustomCreated": true
}

相关接口​

接口说明
POST /api/DataDictionary/Create新建数据字典(AppId、Name 必填,Items 参与校验)
POST /api/DataDictionary/Edit编辑数据字典(部分更新 Name、Items、Description)
GET /api/DataDictionary/Get获取数据字典详情(返回 Items 字符串)