Skip to content

数据字典

数据字典用于维护枚举选项值,如状态、类型、等级等。字典以"统一数据源"的方式实现,供表单设计和运行时组件使用。

功能说明

数据字典是系统数据源的一种类型(类型为"字典")。管理员创建字典数据源后,表单设计器中的选择类字段可以引用它作为选项来源。

当前字典能力:

  • 在数据源管理中创建字典类型的数据源
  • 在 JSON 配置中维护选项列表
  • 支持级联选项(父子级关系)
  • 支持禁用特定选项

推荐命名

  • 字典编码:dict.<业务含义>,例如 dict.invoice_status
  • 字段元数据编码:object.field,例如 invoice.status

配置方法

  1. 进入数据源管理(/sys/data-source),点击新增
  2. 数据源类型选择"字典"
  3. 编码填写全局唯一值(如 dict.invoice_status
  4. 状态设为启用
  5. 在源配置 JSON 中填写选项列表(参考下方示例)
  6. 保存后,表单设计器即可引用该字典数据源

示例配置:

json
{
  "options": [
    { "label": "待处理", "value": "pending" },
    { "label": "处理中", "value": "processing" },
    { "label": "已完成", "value": "completed" }
  ]
}

数据源与字段绑定

如需在字段元数据中复用字典,进入字段元数据页面(/sys/field-metadata),将枚举字段的选项源编码设置为该数据源编码即可。表单设计器在选择业务字段后可自动填充选项源。

权限说明

  • 数据源管理需要管理员权限(普通业务用户不可访问)
  • 运行时选项查询公开可用,但只返回已启用的数据源

注意事项

  • 编码全局唯一;改编码后,已引用旧编码的表单字段需同步调整。
  • 禁用数据源后,运行时不再返回其选项;设计器中已引用处需另行处理。
  • 选项的 value 一旦被业务数据引用,不宜随意改名,可改 label 或新增选项。

常见问题

表单里选不到刚建的字典?
确认数据源类型为「字典」、状态为启用,并在设计器中按数据源编码引用。

需要级联(省市区一类)怎么配?
在选项中维护父子关系字段(以页面/示例约定为准);先做小范围验证再接到正式表单。

和字段元数据什么关系?
字段元数据可把枚举字段的选项源指向该字典编码,设计器选用业务字段时能自动带上选项源。