代码拉取完成，页面将自动刷新
README ENGLISH | 中文
一个简单的通用的数据字典框架
使用枚举来管理项目中繁杂的数据字典. 让每个实体类都对应一个数据字典接口, 每个数据字典接口内部都有一个枚举类对应实体类的带有数据字典的字段, 涉及到数据字典的获取无需再使用静态变量或魔法值, 统一使用枚举来表示.
通过将枚举作为代理入口, 真实的数据存放在数据字典池中, 极大的减少枚举的代码
使用简单方便, 用到一张表的某个含有数据字典的字段的时候, 能够根据IDE的代码提示轻松获取字段的各个信息.
防止出错, 易于维护, 因为使用的是枚举, 使用的时候不容易出错, 而且如果改动了字典表的值只需要更改对应的枚举类即可.
统一格式, 增添功能, 一般来说枚举中都会需要使用到一些统一的方法, 例如通过value获取label, 通过label获取value, 或者多选字段的值转换, 类似于这种统一的方法就可以通过在 IDictItem 接口中增删方法来调整整体的功能.
方便为单个字段添加额外逻辑, 因为使用的是枚举类, 所以只需要在字段对应的枚举类中添加方法就能很方便的使用和管理字段的处理逻辑.
Apache Maven
<dependency>
<groupId>com.github.cosycode</groupId>
<artifactId>code-dict</artifactId>
<version>1.1</version>
</dependency>
Gradle Groovy DSL
implementation 'com.github.cpfniliu:code-dict:1.0'
假如有两张表(简单一点, 一些非空, 长度什么的就不写了), 两个表都有 gender 和 state , gender 字典项相同, 但 state 字典项不同
学生表 Student
| 字段名(field) | 类型 | 字典项 |
|---|---|---|
| stuNo | INTEGER | |
| name | VARCHAR | |
| gender | VARCHAR | 性别 : {男:1, 女:2} |
| state | VARCHAR | 状态 : {未报到:10, 在读:20, 毕业:30, 结业:40, 肄业:50, 退学:60, 开除:70} |
教师表 Teacher
| 字段名(field) | 类型 | 字典项 |
|---|---|---|
| teaNo | INTEGER | |
| name | VARCHAR | |
| gender | VARCHAR | 性别 : {男:1, 女:2} |
| state | VARCHAR | 状态 : {未报到:10, 在职:20, 离职:30, 开除:40} |
然后你就可以分别为两个表建立一个数据字典接口(之所以用接口是因为里面不需要有成员属性), 用来管理数据字典. 相关代码如下
学生接口
import com.github.cosycode.codedict.core.IDictItem;
/**
* <b>Description : </b> 学生数据字典接口
*
* @author CPF
* @date 2019/12/13 10:43
**/
public interface DicStudent {
/**
* 性别 : {男:1, 女:2}
*/
enum Gender implements IDictItem {
man("1", "男"), woman("2", "女");
Gender(String value, String label) {
putItemBean(value, label);
}
}
/**
* 状态
*/
enum State implements IDictItem {
notReported("10", "未报到"),
reading("20", "在读"),
graduation("30", "毕业"),
defamation("40", "肄业"),
completion ("50", "肄业"),
withdrawal("60", "退学"),
expulsion("70", "开除");
State(String value, String label) {
putItemBean(value, label);
}
}
}
教师接口
import com.github.cosycode.codedict.core.IDictItem;
/**
* <b>Description : </b> 教师数据字典接口
*
* @author CPF
* @date 2019/12/13 10:43
**/
public interface DicTeacher {
/**
* 性别 : {男:1, 女:2}
*/
enum Gender implements IDictItem {
man("1", "男"), woman("2", "女");
Gender(String value, String label) {
putItemBean(value, label);
}
}
/**
* 状态
*/
enum State implements IDictItem {
notReported("10", "未报到"),
work("20", "在职"),
resigned("30", "离职"),
expelled("40", "开除");
State(String value, String label) {
putItemBean(value, label);
}
}
}
数据字典接口的标准格式:
- 接口名称为
Dic+ 表名.- 接口里面有多个枚举类, 每个枚举类对应表中有数据字典的字段. 枚举名是字段名的大写驼峰式字符串.
- 每个枚举都实现了
IDictItem接口, 枚举的每一个字典项对应字段的每一个数据字典项.
使用简单方便, 用到一张表的某个含有数据字典的字段的时候, 能够根据IDE的代码提示轻松获取字段的各个信息.
防止出错, 易于维护, 因为使用的是枚举, 使用的时候不容易出错, 而且如果改动了字典表的值只需要更改对应的枚举类即可.
统一格式, 增添功能, 一般来说枚举中都会需要使用到一些统一的方法, 例如通过value获取label, 通过label获取value, 或者多选字段的值转换, 类似于这种统一的方法就可以通过在 DictItems 中增删方法来调整整体的功能.
import com.github.cosycode.codedict.core.DictItems;
public class Test {
public static void main(String[] args) {
// 获取 Student 表 性别 为 男性的 数据字典代码
DicStudent.Gender.man.value();
// 获取 Teacher 表 状态 表示离职的 数据字典代码
DicTeacher.State.resigned.value();
// 获取 Teacher 表 状态 表示离职的 文本显示标签
DicTeacher.State.resigned.label();
}
@org.junit.Test
public void iDictItemTest() {
// 假如 Teacher 表 状态 的一个value是30, 需要判断当前值是否代表毕业
String teaState = "30";
DicTeacher.State.resigned.isValue(teaState); // true
DicTeacher.State.notReported.isValue(teaState); // false
// 针对 Teacher 表 的 状态 字段, 通过 文本标签:"在职" 获取对应的 数据字典代码
DictItems.getValueByLabel(DicTeacher.State.class, "在职"); // 返回: "20"
// 针对 Teacher 表 的 状态 字段, 通过 数据字典代码 获取对应的 文本标签
DictItems.getLabelByValue(DicTeacher.State.class, "20"); // 返回: "在职"
// 针对 Teacher 表 的 状态 字段, 通过 文本标签 获取对应的 枚举项
DictItems.getByLabel(DicTeacher.State.class, "在职"); // 返回: DicTeacher.State.work
// 针对 Teacher 表 的 状态 字段, 通过 数据字典代码 获取对应的 枚举项
DictItems.getByValue(DicTeacher.State.class, "20"); // 返回: DicTeacher.State.work
}
}
方便为单个字段添加额外逻辑, 因为使用的是枚举类, 所以只需要在字段对应的枚举类中添加方法就能很方便的使用和管理字段的处理逻辑.
例如在开发中难免会遇到对于某个有数据字典的字段需要做一些单独的处理, 而这些处理逻辑直接写在代码里或者单独的类里面都不方便, 遇到这种情况就可以将此种逻辑写道对应的枚举类中.
接下来说一个简单的示例: 例如就上面的教师类的Gender字段, 在内部使用的数据字典是("1", "男"),("2", "女"), 但是由于某种情况, 向外部进行推送的时候需要改成("male", "男"),("female ", "女")的格式, 这样的话就可以在枚举中添加两个方法就可以完方便解决.
/**
* 性别 : {男:1, 女:2}
*/
enum Gender implements IDictItem {
man("1", "男"), woman("2", "女");
Gender(String value, String label) {
putItemBean(value, label);
}
public String innerToOuter(String val) {
if (man.isValue(val)) {
return "male";
}
if (woman.isValue(val)) {
return "female";
}
throw new RuntimeException("转换出现异常");
}
String outerToInner(String val) {
if ("male".equals(val)) {
return man.value();
}
if ("female".equals(val)) {
return woman.value();
}
throw new RuntimeException("转换出现异常");
}
}
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
