SpringBoot中实现数据字典的示例代码
我们在日常的项目开发中，对于数据字典肯定不模糊，它帮助了我们更加方便快捷地进行开发，下面一起来看看在SpringBoot中如何实现数据字典功能的
一、简介
1、定义
数据字典是指对数据的数据项、数据结构、数据流、数据存储、处理逻辑等进行定义和描述，其目的是对数据流程图中的各个元素做出详细的说明，使用数据字典为简单的建模项目。简而言之，数据字典是描述数据的信息集合，是对系统中使用的所有数据元素的定义的集合。
数据字典（Datadictionary）是一种用户可以访问的记录数据库和应用程序元数据的目录。主动数据字典是指在对数据库或应用程序结构进行修改时，其内容可以由DBMS自动更新的数据字典。被动数据字典是指修改时必须手工更新其内容的数据字典。
2、理解
数据字典是一种通用的程序设计思想，将主体与分支存于两张数据表中，他们之间靠着唯一的code相互联系，且code是唯一存在的，分支依附主体而存在，每一条分支都有它唯一对应的属性值
例如：性别（sex）,分为（0–保密1–男2–女），那么数据字典的设计就应该是
主表：
{
"code":"sex",
"name":"性别"
}
副表：
[{
"dictCode":"sex",
"code":"0",
"text":"保密"
},
{
"dictCode":"sex",
"code":"1",
"text":"男"
},
{
"dictCode":"sex",
"code":"2",
"text":"女"
}
]
那么我们在使用数据字典的时候，只需要知道dictCode，再使用code找到唯一的字典值
二、数据表设计
1、数据表设计
主表：
droptableifexistssys_dict; /*==============================================================*/ /*Table:sys_dict*/ /*==============================================================*/ createtablesys_dict ( idbigint(20)notnullauto_incrementcomment'主键id', codevarchar(32)comment'编码', namevarchar(32)comment'名称', descriptvarchar(64)comment'描述', statustinyint(1)default0comment'状态（0--正常1--冻结）', create_timedatetimecomment'创建时间', create_userbigint(20)comment'创建人', del_flagtinyint(1)default0comment'删除状态（0，正常，1已删除）', primarykey(id) ) type=InnoDB; altertablesys_dictcomment'字典管理表';
副表：
droptableifexistssys_dict_detail; /*==============================================================*/ /*Table:sys_dict_detail*/ /*==============================================================*/ createtablesys_dict_detail ( idbigint(20)notnullcomment'主键id', dict_codevarchar(32)comment'字典编码', codevarchar(32)comment'编码', namevarchar(32)comment'名称', primarykey(id) ) type=InnoDB; altertablesys_dict_detailcomment'字典配置表';
它们的关系如图所示：
2、数据字典配置
三、开发前戏
1、引入maven依赖
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-thymeleaf org.springframework.boot spring-boot-starter-aop org.projectlombok lombok true
我们引入了aop切面所需依赖，我们的数据字典也是基于aop切面实现的
用户信息表SysUserInfo.java：
importcom.baomidou.mybatisplus.annotation.*; importcom.baomidou.mybatisplus.extension.activerecord.Model; importcom.zyxx.common.annotation.Dict; importio.swagger.annotations.ApiModel; importio.swagger.annotations.ApiModelProperty; importlombok.Data; importlombok.EqualsAndHashCode; importlombok.experimental.Accessors; importjava.io.Serializable; /** **用户信息表 *
* *@authorlizhou *@since2020-07-06 */ @Data @EqualsAndHashCode(callSuper=false) @Accessors(chain=true) @TableName("sys_user_info") @ApiModel(value="SysUserInfo对象",description="用户信息表") publicclassSysUserInfoextendsModel{ @ApiModelProperty(value="ID") @TableId(value="id",type=IdType.AUTO) privateLongid; @ApiModelProperty(value="登录账号") @TableField("account") privateStringaccount; @ApiModelProperty(value="登录密码") @TableField("password") privateStringpassword; @ApiModelProperty(value="姓名") @TableField("name") privateStringname; @ApiModelProperty(value="性别（0--未知1--男2--女）") @TableField("sex") @Dict(dictCode="sex") privateIntegersex; @ApiModelProperty(value="状态（0--正常1--冻结）") @TableField("status") @Dict(dictCode="status") privateIntegerstatus; }
3、返回结果通用实体类
返回结果通用实体类LayTableResult.java：
importlombok.Getter; importlombok.Setter; importjava.util.List; /** *@param返回的实体类 *@authorlizhou *@描述后台返回给LayUI的数据格式 */ @Getter @Setter publicclassLayTableResult { /** *接口状态 */ privateIntegercode; /** *提示信息 */ privateStringmsg; /** *接口数据长度 */ privateLongcount; /** *接口数据 */ privateList data; /** *无参构造函数 */ publicLayTableResult(){ super(); } /** *返回数据给表格 */ publicLayTableResult(Longcount,List data){ super(); this.count=count; this.data=data; this.code=0; } }
由于我用的是layui前端框架，我写了一个返给layui表格的通用实体类，这是在实现数据字典需要用到的，判断响应返回实体类的类型来判断是否需要注入字典
四、开发实现
1、创建自定义注解
我们创建一个自定义注解@Dict来实现数据字典
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
/**
*数据字典注解
*
*@authorTellsea
*@date2020/6/23
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceDict{
/**
*字典类型
*
*@return
*/
StringdictCode();
/**
*返回属性名
*
*@return
*/
StringdictText()default"";
}
2、注解实现
我们使用aop切面来实现什么的自定义注解@Dict
importcom.alibaba.fastjson.JSONObject;
importcom.fasterxml.jackson.annotation.JsonFormat;
importcom.fasterxml.jackson.core.JsonProcessingException;
importcom.fasterxml.jackson.databind.ObjectMapper;
importcom.zyxx.common.annotation.Dict;
importcom.zyxx.common.utils.LayTableResult;
importcom.zyxx.common.utils.ObjConvertUtils;
importcom.zyxx.sbm.entity.SysDictDetail;
importcom.zyxx.sbm.service.SysDictService;
importlombok.extern.slf4j.Slf4j;
importorg.apache.commons.lang3.StringUtils;
importorg.aspectj.lang.ProceedingJoinPoint;
importorg.aspectj.lang.annotation.Around;
importorg.aspectj.lang.annotation.Aspect;
importorg.aspectj.lang.annotation.Pointcut;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Component;
importjava.lang.reflect.Field;
importjava.text.SimpleDateFormat;
importjava.util.ArrayList;
importjava.util.Date;
importjava.util.List;
/**
*数据字典切面
*
*@authorTellsea
*@date2020/6/23
*/
@Aspect
@Component
@Slf4j
publicclassDictAspect{
/**
*字典后缀
*/
privatestaticStringDICT_TEXT_SUFFIX="Text";
@Autowired
privateSysDictServicesysDictService;
/**
*切点，切入controller包下面的所有方法
*/
@Pointcut("execution(*com.zyxx.*.controller.*.*(..))")
publicvoiddict(){
}
@Around("dict()")
publicObjectdoAround(ProceedingJoinPointpjp)throwsThrowable{
longtime1=System.currentTimeMillis();
Objectresult=pjp.proceed();
longtime2=System.currentTimeMillis();
log.debug("获取JSON数据耗时："+(time2-time1)+"ms");
longstart=System.currentTimeMillis();
this.parseDictText(result);
longend=System.currentTimeMillis();
log.debug("解析注入JSON数据耗时"+(end-start)+"ms");
returnresult;
}
privatevoidparseDictText(Objectresult){
if(resultinstanceofLayTableResult){
Listitems=newArrayList<>();
LayTableResultrr=(LayTableResult)result;
if(rr.getCount()>0){
Listlist=(List)rr.getData();
for(Objectrecord:list){
ObjectMappermapper=newObjectMapper();
Stringjson="{}";
try{
//解决@JsonFormat注解解析不了的问题详见SysAnnouncement类的@JsonFormat
json=mapper.writeValueAsString(record);
}catch(JsonProcessingExceptione){
log.error("Json解析失败："+e);
}
JSONObjectitem=JSONObject.parseObject(json);
//解决继承实体字段无法翻译问题
for(Fieldfield:ObjConvertUtils.getAllFields(record)){
//解决继承实体字段无法翻译问题
//如果该属性上面有@Dict注解，则进行翻译
if(field.getAnnotation(Dict.class)!=null){
//拿到注解的dictDataSource属性的值
StringdictType=field.getAnnotation(Dict.class).dictCode();
//拿到注解的dictText属性的值
Stringtext=field.getAnnotation(Dict.class).dictText();
//获取当前带翻译的值
Stringkey=String.valueOf(item.get(field.getName()));
//翻译字典值对应的text值
StringtextValue=translateDictValue(dictType,key);
//DICT_TEXT_SUFFIX的值为，是默认值：
//publicstaticfinalStringDICT_TEXT_SUFFIX="_dictText";
log.debug("字典Val:"+textValue);
log.debug("翻译字典字段："+field.getName()+DICT_TEXT_SUFFIX+"："+textValue);
//如果给了文本名
if(!StringUtils.isBlank(text)){
item.put(text,textValue);
}else{
//走默认策略
item.put(field.getName()+DICT_TEXT_SUFFIX,textValue);
}
}
//date类型默认转换string格式化日期
if("java.util.Date".equals(field.getType().getName())
&&field.getAnnotation(JsonFormat.class)==null
&&item.get(field.getName())!=null){
SimpleDateFormataDate=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");
item.put(field.getName(),aDate.format(newDate((Long)item.get(field.getName()))));
}
}
items.add(item);
}
rr.setData(items);
}
}
}
/**
*翻译字典文本
*
*@paramdictType
*@paramkey
*@return
*/
privateStringtranslateDictValue(StringdictType,Stringkey){
if(ObjConvertUtils.isEmpty(key)){
returnnull;
}
StringBuffertextValue=newStringBuffer();
String[]keys=key.split(",");
for(Stringk:keys){
if(k.trim().length()==0){
continue;
}
/**
*根据dictCode和code查询字典值，例如：dictCode:sex,code:1，返回:男
*应该放在redis，提高响应速度
*/
SysDictDetaildictData=sysDictService.getDictDataByTypeAndValue(dictType,key);
if(dictData.getName()!=null){
if(!"".equals(textValue.toString())){
textValue.append(",");
}
textValue.append(dictData.getName());
}
log.info("数据字典翻译:字典类型：{}，当前翻译值：{}，翻译结果：{}",dictType,k.trim(),dictData.getName());
}
returntextValue.toString();
}
}
3、注解使用
我们只需要在实体类的属性上加入我们实现的自定义注解即可
@ApiModelProperty(value="性别（0--未知1--男2--女）")
@TableField("sex")
@Dict(dictCode="sex")
privateIntegersex;
@ApiModelProperty(value="状态（0--正常1--冻结）")
@TableField("status")
@Dict(dictCode="status")
privateIntegerstatus;
我们对sex，status都加入了@Dict(dictCode=“”)注解，那么我们在获取用户信息的时候，就能获取到对应的字典值了
五、测试
1、编写API查询
我们在controller层开放一个API实现查询用户列表
/**
*分页查询
*/
@PostMapping("list")
@ResponseBody
publicLayTableResultlist(Integerpage,Integerlimit,SysUserInfouserInfo){
QueryWrapperqueryWrapper=newQueryWrapper<>();
if(StringUtils.isNotBlank(userInfo.getName())){
queryWrapper.like("name",userInfo.getName());
}
if(null!=userInfo.getSex()){
queryWrapper.eq("sex",userInfo.getSex());
}
if(null!=userInfo.getStatus()){
queryWrapper.eq("status",userInfo.getStatus());
}
queryWrapper.orderByDesc("create_time");
IPageiPage=sysUserInfoService.page(newPage<>(page,limit),queryWrapper);
returnnewLayTableResult<>(iPage.getTotal(),iPage.getRecords());
}
注意：这里我们使用了LayTableResult作为相应实体类，与上面我们编写的返回通用实体类是一致的，必须一直，才能实现数据字典功能
返回结果如下：
{
"code":0,
"msg":null,
"count":3,
"data":[{
"id":2,
"account":"15286779045",
"name":"周杰伦",
"sex":1,
"sexText":"男",
"status":0,
"statusText":"正常"
},{
"id":1,
"name":"超级管理员",
"account":"15286779044",
"sex":1,
"sexText":"男",
"status":0,
"statusText":"正常"
}]
}
可以看出，返回的数据中，多出了sexText，statusText，两个属性，也就证明我们的字典功能已经实现成功
六、总结
1、优点
1、在一定程度上，通过系统维护人员即可改变系统的行为（功能），不需要开发人员的介入。使得系统的变化更快，能及时响应客户和市场的需求。
2、提高了系统的灵活性、通用性，减少了主体和属性的耦合度3、简化了主体类的业务逻辑4、
能减少对系统程序的改动，使数据库、程序和页面更稳定。特别是数据量大的时候，能大幅减少开发工作量
5、使数据库表结构和程序结构条理上更清楚，更容易理解，在可开发性、可扩展性、可维护性、系统强壮性上都有优势。
2、缺点
1、数据字典是通用的设计，在系统效率上会低一些。
2、程序算法相对复杂一些。
3、对于开发人员，需要具备一定抽象思维能力，所以对开发人员的要求较高。
3、优化
我们的数据字典数据应该存放在redis中，减少与数据库的交互次数，提高响应速度
到此这篇关于SpringBoot中实现数据字典的示例代码的文章就介绍到这了,更多相关SpringBoot数据字典内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。