Skip to content

字典管理

字典管理负责维护系统中可枚举的业务选项,例如通用状态、用户性别、短信渠道、支付状态等。RuoYi Office 的管理端把字典拆成“字典类型”和“字典数据”两层:类型定义一组枚举的唯一编码,数据定义该编码下的标签、键值、排序、状态和展示样式。

本地实现位置

位置
PC 页面ruoyi-office-vben/apps/web-antd/src/views/system/dict
PC APIsrc/api/system/dict/typesrc/api/system/dict/data
后端 ControllerDictTypeController.javaDictDataController.java
前端使用@vben/constantsDICT_TYPE@vben/hooksgetDictOptions

页面结构

views/system/dict/index.vue 使用左右两栏:左侧维护字典类型,右侧显示选中类型下的字典数据。

字典类型

字典类型是业务枚举的命名空间。新增后,前端和后端通常通过 type 字段引用。

字段说明
name字典名称,面向管理员展示
type字典类型编码,创建后前端禁用编辑,避免影响已有引用
status启用/禁用
remark备注说明

后端接口:

操作接口权限标识
创建类型POST /system/dict-type/createsystem:dict:create
修改类型PUT /system/dict-type/updatesystem:dict:update
删除类型DELETE /system/dict-type/deletesystem:dict:delete
类型分页GET /system/dict-type/page页面查询使用
精简列表GET /system/dict-type/list-all-simple/simple-list前端下拉使用
导出类型GET /system/dict-type/export-excel导出 字典类型.xls

字典数据

字典数据是某个字典类型下的具体选项。

字段说明
dictType归属字典类型
label页面展示文案
value业务存储键值,通常与后端枚举值对应
sort展示排序
status是否启用
colorTypeAnt Design Vue 标签颜色类型
cssClass自定义颜色或样式,例如 #108ee9

后端接口:

操作接口权限标识
新增数据POST /system/dict-data/createsystem:dict:create
修改数据PUT /system/dict-data/updatesystem:dict:update
删除数据DELETE /system/dict-data/deletesystem:dict:delete
数据分页GET /system/dict-data/page页面查询使用
精简数据GET /system/dict-data/list-all-simple/simple-list前端全局字典缓存使用
导出数据GET /system/dict-data/export-excelsystem:dict:export

使用建议

  1. 字典类型编码要稳定:一旦被 DICT_TYPE、后端枚举或表字段引用,不建议直接修改。
  2. 字典键值要和后端类型匹配:前端 getDictOptions(type, 'number') 会把值转为数字,后端字段为字符串时不要误用。
  3. 禁用优先于删除:线上已有业务数据引用某个字典值时,建议禁用而不是删除。
  4. 展示样式只影响前端colorTypecssClass 用于标签渲染,不应承载业务含义。

排查清单

现象排查方向
下拉没有选项字典数据是否启用,前端 DICT_TYPE 是否与字典类型一致
标签显示原始值字典值类型是否匹配,是否忘记加载字典缓存
修改类型后页面异常检查前端常量和后端枚举是否仍引用旧 type
导出为空检查筛选条件、权限和当前租户下是否有数据
联系我们

获取报价、演示和二开方案

微信咨询二维码

微信咨询

17156169080

添加时备注「RuoYi Office」

在线体验商业版