配置(业务)

配置模块讲两件事:枚举主数据(数据字典/值集两族,业务租户 + default 兜底合并的读取合同)与翻译(i18n 词条的维护、导入与缺失上报)。

本页是 data-service configuration 模块接口的业务说明,非业务说明不在本页复述:

  • OpenAPI JSON(可直接导入 Postman 等工具):https://zxs.netbodycamera.com/main-service/v3/api-docs/configuration
  • 在线 Swagger 视图:data-service · 配置
  • 端点全量清单(含权限点与中文说明):清单层 · configuration

参数、请求/响应字段、错误码等契约事实一律见上述 Swagger 与清单层;本页只讲业务语义与动线。

data-dictionary 数据字典

字典条目主档。重点在读取合同与导入语义:

  • listCache:读取「业务租户 + default 兜底」的合并列表,供前端选择器整段加载。该入口按租户显式条件寻址缓存并在租户豁免作用域执行,是任意已登录用户可跨业务租户读取的既定合同,不是普通 list 的别名;结果来自带 TTL 的缓存,不承诺与最新写入实时一致。
  • importList:异步导入(JMS 发布受理)——受理成功只代表消息已发布;消费方在仓外(JmsChannelContractTest 显式列为仓外消费边界),落库语义、逐行结果与失败回传全部缺证,不得当作导入完成信号(场景领域页按关键缺口口径收录)。
  • 其余 count/getById/list/page/save/updateById/removeById* 为常规 CRUD。

场景页:配置与翻译域 · data-dictionary(含异步导入、缓存读取两个子流程小节)。契约见清单层 · data-dictionary

data-dictionary-map 数据字典映射

字典条目的映射关系 CRUD(无独立业务子流程);场景领域页:配置与翻译域 · data-dictionary-map。契约见清单层

data-dictionary-table 数据字典表

字典表维度主档 CRUD;契约见清单层

data-dictionary-type 数据字典类型

字典类型维度主档 CRUD;listCachedata-dictionary 同款「业务租户 + default 合并」缓存读取合同(类型缓存 TTL 10 秒)。场景页:配置与翻译域 · data-dictionary-type。契约见清单层

translation 翻译

i18n 词条主档,三条动线:

  • 正式维护save/updateById 新增/修改词条,list/page/getById 查询,removeById* 删除。
  • 批量导入importList 从 XLSX 导入——「受理即返回」,逐行落库、自然键 upsert 与视图刷新由仓内 JMS 消费者异步完成(不提供逐行回执;校验失败在消费端以日志记录,具体行为未联调核验)。
  • 缺失上报saveMissing 匿名上报(permitAll)前端缺失的 i18n 词条草稿——只落 default 租户的待处理队列,不是翻译读取或写入通道。边界:队列满员 10000 时词条被静默丢弃而 ACK 不变;词条何时落库、何时进入翻译视图均异步,本操作不提供查询。词条的批量入库节奏见运行时关联

场景页:配置与翻译域 · translation(含批量导入、缺失上报两个子流程小节)。契约见清单层 · translation

v1-general 通用接口(v1)

getCloudServiceInfo:读取中心配置的云服务节点列表与推荐节点域名,供设备/采集服务器管理页的「云服务域名」下拉与新建表单默认值。匿名放行(未登录引导阶段也可调用),响应内容完全由服务端部署配置决定(绑定 cloud-service.* 环境配置,客户端无法用参数影响结果);只读无副作用。配置缺 cloud-service.nodes 或为空时,服务端用部署参数 ES_CENTER_SERVER_DOMAIN_NAME/ES_CENTER_SERVER_EXTERNAL_IP 构造单个 master 兜底节点——nodes 至少一项,recommendNodeDomainName 可为空串/缺失(取决于配置),客户端应做空值兼容。契约见清单层 · v1-general

场景页:查询云服务节点信息(getCloudServiceInfo)

value-set 值集

值集条目主档 CRUD(值集是与数据字典同构的另一套枚举体系:type 分型、table 挂表、map 做映射);契约见清单层 · value-set

value-set-map 值集映射

值集映射关系 CRUD;契约见清单层

value-set-table 值集表

值集表维度主档 CRUD;契约见清单层

value-set-type 值集类型

值集类型维度主档 CRUD;契约见清单层

本模块相关的定时任务 / 缓存(全量表见 data-service 定时任务缓存,此处只点名不复述):

  • 定时任务 TranslationScheduling#processTranslationQueue(PT6S):翻译队列处理——用最终翻译视图过滤已发布 key,按批量阈值落库减少频繁写库(translation/importListsaveMissing 入队词条的消化端)。
  • 定时任务 TranslationDirtyDataScheduling#cleanupExistingDirtyData(PT1H):翻译脏数据独立小时周期清理。
  • 缓存 dataDictionaryListCache(90 天):数据字典列表缓存——data-dictionary listCache 合同的后端载体。