数据字典服务端采集方案-基于Springboot Starter开发

1 插件的开发

待补充

2 插件的使用

2.1 功能说明

扫描模型字段的字典值定义，集中存储各服务数据库字段的字典值信息，以便日常查询及脚本转换使用。

<dependency>
    <groupId>com.carson</groupId>
    <artifactId>carson‐common‐dtos</artifactId>
</dependency>

2.2 基本配置

继承抽象工具类 com.carson.common.dict.AbstractDataDictManager ，并且注入 Spring 容器。实现抽象方法，其中packageNamePrefifixList 方法返回当前应用的数据库模型所在的包路径，支持配置多个路径。 getDbName方法返回当前应用的生产数据库的数据库名。例如：

@Configuration
public class ChargeDataDictConfig extends AbstractDataDictManager {

//待扫描的模型定义路径
@Override
public List<String> packageNamePrefixList() {
return Arrays.asList("com.tencent.travel.charge.model");
}

//生产数据库名
@Override
public String getDbName() {
return "gac_charge";
}
}

2.3 具体字段配置

根据需要，在上述指定的包路径下的 model 中，使用 DataDict 注解定义字段的字典值。 DataDict 的字段说明如下所示，前面四项（keys 及 descriptions 字段 / enumClass / cls / inferredClass 及 inferredStaticMethod 字段）分别对应了四种映射字段值和字段值描述的方法，只需要根据具体需要，按照其中一个方法实现即可。后面三项 （dbName / tableName / fifieldName ）提供了覆盖修改库名 / 表名 / 字段名的能力。 keys 及 descriptions 字段

用于定义依次定义字段值及对应的字段值值说明，例如：

@DataDict(keys = {"‐1", "1"}, descriptions = {"删除", "正常"})
private Short status;

enumClass

用于指定字段对应的枚举类，且该类需要实现 DataDictEnumInterface 接口

@DataDict(enumClass = ChargeStatusEnum.class)
private Short status;

cls

用于指定字典值接口 DataDictInterface 的实现类，接口有一个返回字典值映射 map 的方法

getFieldValueDescMap 。

inferredClass 及 inferredStaticMethod 字段

inferredStaticMethod 字段指定某个能获取字段字典值的静态方法，且该方法的返回类型为 Map 。 inferredClass

用于指定前述静态方法所在的普通类。

dbName

用于设置该字段对应数据就的库名。各个应用可以根据环境动态返回，或则固定返回生产数据库的库名。默认值为

上述配置类 getDbName()

的返回值。

tableName

用于设置字段对应的表名。如果没有设置，会判断是否有使用使用 javax.persistence.Table 注解定义了表名，有则

使用定义的表名。如果仍然没有，则默认为模型名字转换成下划线格式名称。

fieldName

用于设置字段名。如果没有设置工具类会判断是否有通过 javax.persistence.Column 注解定义字段名。如果仍然没

有，则使用字段名转换成下划线格式的名称。

配置示例：

/**
* 这是上述技术配置里面packageNamePrefixList方法返回路径下的一个数据库模型定义
*/
@Data
public class PunishPackageItem {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private Long packageId;
@DataDict(enumClass = EnumExtendsDataDictEnumInterface.class)
// @DataDict(enumClass = EnumExtendsDataDictEnumInterface.class, dbName ="resetDbName")
// @DataDict(enumClass = EnumExtendsDataDictEnumInterface.class, tableName ="manualSettingTableName")
// @DataDict(enumClass = EnumExtendsDataDictEnumInterface.class, fieldName ="manualSettingFieldName")
// @DataDict(cls = EnumExtendsDataDictInterface.class)
// @DataDict(inferredClass=SomeClassGotSpecialMethod.class,inferredStaticMethod="SpecialStaticMethodName")
// @DataDict(keys = {"1", "2"}, descriptions = {"1的描述", "2的描述"})
private String punishType;
private Date createTime;
private Integer expireTimeNum;
private String expireTimeUnit;
}

2.4 结果验证

应用启动时，工具类自动将扫描得到的字典值定义写到各个环境的 gac_common 数据库下的表 data_dict 。正常情

况下也可见 info 级别的日志输出信息 “data dict scanning result:”

补充：

里面一些包名和数据库名这些配置 可以考虑在yml去加 数据字典的采集如果网络不通，无法jdbc直连，可以考虑用restful-api或者mq去接收也是可以。