服务配置
在开发过程中需要用到很多配置,为了保持可读性和维护性,配置段不宜过多,控制在4~5段即可,其中第一段为固定段:hzero,第二段为服务/组件段,第三、四段为规则段,最后一段为配置值。例:系统启动是否开启Redis初始化的配置,hzero:platform:init-cache:false
值集数据配置
-
按功能划分(仅本功能使用)
服务模块+功能+用途,如:HPFM.CODE_RULE.FIELD_TYPE
(编码规则字段类型) -
按服务划分(服务内可通用)
服务模块+用途,如:HPFM.FLAG
(标识) -
按全局划分(所有服务通用)
HPFM(平台服务)、HMDM(主数据服务)下的服务级值集,其他服务都可直接使用,如:HPFM.TEXT_TYPE(文本类型) -
值集使用说明
:
由于值集存在共用情况,在创建值集时需要先去判断是否已登记存在,如果存在则与负责人(技术设计者和业务负责人)沟通是否可以直接使用,避免重复造轮子和引起混乱。
查询途径:
1.后台SQL查询(在平台服务数据库hzero_platform中执行以下语句)
SELECT l.lov_code,
lt.description lov_description,
lv.`value`,
lvt.meaning,
lvt.description value_description
FROM hpfm_lov l,
hpfm_lov_tl lt,
hpfm_lov_value lv,
hpfm_lov_value_tl lvt
WHERE l.lov_id = lt.lov_id
AND l.lov_id = lv.lov_id
AND lv.lov_value_id = lvt.lov_value_id
AND l.lov_type_code = 'IDP'
AND lt.description LIKE '%维度%'
2.系统中对应界面的功能查询
3.在项目基础设置登记的Excel中进行查询
LOV应用配置
-
命名规则参考值集命名(1、2、3)
-
注意: 不存在LOV应用配置全局划分情况,每个微服务的LOV应用配置都是服务下,
前端开发引用时需要特别注意,不能跨服务调用,以避免后续拆分造成问题
。
编码规则配置
-
按功能划分(仅本功能使用)
服务模块+功能+用途,如:HPFM.USER.USERNAME
(平台服务.用户管理.用户名) -
按服务划分(服务内可通用)
服务模块+用途,如:HIMP.BATCH_ID
(导入服务.批次号)
以上规范注意事项
编码的代码统一大写
定义代码时尽量用英文或英文简称,并且不宜过长
描述尽量表达清楚
每个段之间用点号“.”隔开
一段中如果存在多个单词,用下划线_
隔开
消息模板代码
-
按功能划分(仅本功能使用)
服务模块+功能+用途,如:HIAM.USER.REGISTER
IAM服务.用户.注册成功通知) -
按服务划分(服务内可通用,HPFM服务下的服务级全局可通用)
服务模块+用途,如:HPFM.VERIFICATION_CODE
(平台服务.验证码)
以上规范注意事项
编码的代码统一大写
定义代码时尽量用英文或英文简称,并且不宜过长
描述尽量表达清楚
每个段之间用点号“.”隔开
一段中如果存在多个单词,用下划线_
隔开
多语言描述维护
多语言标签
-
按功能划分(仅本功能使用)
服务模块+功能+用途,如:hpfm.user.age
(年龄) -
按服务划分(服务内可通用)
服务+用途,如:hiam.common.menu
(菜单) -
按全局划分(所有服务通用)
HPFM(平台服务)、HMDM(主数据服务)下的服务级值集,其他服务都可直接使用,如:hpfm.common.userName
(用户名)
返回消息
-
按功能划分(仅本功能使用)
服务模块+类型+功能+用途,如:hpfm.error.user.ageNull
(年龄不能为空) -
按服务划分(服务内可通用)
服务模块+类型+用途,如:hpfm.error.menuNameNull
(菜单名称不能为空) -
按全局划分(所有服务通用)
HPFM(平台服务)、HMDM(主数据服务)下的服务级值集,其他服务都可直接使用,如:hpfm.error.noAuth
(没有操作权限,请联系管理员)
多语言规范注意事项
快速编码的代码统一小写
定义代码时尽量用英文或英文简称,并且不宜过长
描述尽量表达清楚
每个段之间用点号“.”隔开 一段中如果存在多个单词,使用驼峰
方式
多语言描述,一二段
对应prompt_key,三四段
对应prompt_code
返回消息,第二段的类型只能是error
,info
,warn
,为了与界面返回消息配置对应,请不要随意发挥