SpringBoot中实现数据字典的示例代码

我们在日常的项目开发中,对于数据字典肯定不模糊,它帮助了我们更加方便快捷地进行开发,下面一起来看看在 SpringBoot 中如何实现数据字典功能的

一、简介

1、定义

数据字典是指对数据的数据项、数据结构、数据流、数据存储、处理逻辑等进行定义和描述,其目的是对数据流程图中的各个元素做出详细的说明,使用数据字典为简单的建模项目。简而言之,数据字典是描述数据的信息集合,是对系统中使用的所有数据元素的定义的集合。

数据字典(Data dictionary)是一种用户可以访问的记录数据库和应用程序元数据的目录。主动数据字典是指在对数据库或应用程序结构进行修改时,其内容可以由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、数据表设计

主表:

drop table if exists sys_dict;

/*==============================================================*/
/* Table: sys_dict                       */
/*==============================================================*/
create table sys_dict
(
  id          bigint(20) not null auto_increment comment '主键id',
  code         varchar(32) comment '编码',
  name         varchar(32) comment '名称',
  descript       varchar(64) comment '描述',
  status        tinyint(1) default 0 comment '状态(0--正常1--冻结)',
  create_time     datetime comment '创建时间',
  create_user     bigint(20) comment '创建人',
  del_flag       tinyint(1) default 0 comment '删除状态(0,正常,1已删除)',
  primary key (id)
)
type = InnoDB;

alter table sys_dict comment '字典管理表';

副表:

drop table if exists sys_dict_detail;

/*==============================================================*/
/* Table: sys_dict_detail                    */
/*==============================================================*/
create table sys_dict_detail
(
  id          bigint(20) not null comment '主键id',
  dict_code      varchar(32) comment '字典编码',
  code         varchar(32) comment '编码',
  name         varchar(32) comment '名称',
  primary key (id)
)
type = InnoDB;

alter table sys_dict_detail comment '字典配置表';

它们的关系如图所示:

2、数据字典配置

三、开发前戏

1、引入 maven 依赖

<!-- web支持 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- thymeleaf模板引擎 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- aop依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- lombok插件 -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <optional>true</optional>
</dependency>

我们引入了 aop 切面所需依赖,我们的数据字典也是基于 aop 切面实现的

2、创建实体类

用户信息表 SysUserInfo.java:

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.zyxx.common.annotation.Dict;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.io.Serializable;

/**
 * <p>
 * 用户信息表
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("sys_user_info")
@ApiModel(value="SysUserInfo对象", description="用户信息表")
public class SysUserInfo extends Model<SysUserInfo> {

  @ApiModelProperty(value = "ID")
  @TableId(value = "id", type = IdType.AUTO)
  private Long id;

  @ApiModelProperty(value = "登录账号")
  @TableField("account")
  private String account;

  @ApiModelProperty(value = "登录密码")
  @TableField("password")
  private String password;

  @ApiModelProperty(value = "姓名")
  @TableField("name")
  private String name;

  @ApiModelProperty(value = "性别(0--未知1--男2--女)")
  @TableField("sex")
  @Dict(dictCode = "sex")
  private Integer sex;

  @ApiModelProperty(value = "状态(0--正常1--冻结)")
  @TableField("status")
  @Dict(dictCode = "status")
  private Integer status;
}

3、返回结果通用实体类

返回结果通用实体类 LayTableResult.java:

import lombok.Getter;
import lombok.Setter;

import java.util.List;

/**
 * @param <T> 返回的实体类
 * @author lizhou
 * @描述 后台返回给LayUI的数据格式
 */
@Getter
@Setter
public class LayTableResult<T> {

  /**
   * 接口状态
   */
  private Integer code;

  /**
   * 提示信息
   */
  private String msg;

  /**
   * 接口数据长度
   */
  private Long count;

  /**
   * 接口数据
   */
  private List<T> data;

  /**
   * 无参构造函数
   */
  public LayTableResult() {
    super();
  }

  /**
   * 返回数据给表格
   */
  public LayTableResult(Long count, List<T> data) {
    super();
    this.count = count;
    this.data = data;
    this.code = 0;
  }
}

由于我用的是 layui 前端框架,我写了一个返给 layui 表格的通用实体类,这是在实现数据字典需要用到的,判断响应返回实体类的类型来判断是否需要注入字典

四、开发实现

1、创建自定义注解

我们创建一个自定义注解 @Dict 来实现数据字典

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 数据字典注解
 *
 * @author Tellsea
 * @date 2020/6/23
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Dict {

  /**
   * 字典类型
   *
   * @return
   */
  String dictCode();

  /**
   * 返回属性名
   *
   * @return
   */
  String dictText() default "";
}

2、注解实现

我们使用 aop 切面来实现什么的自定义注解 @Dict

import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.zyxx.common.annotation.Dict;
import com.zyxx.common.utils.LayTableResult;
import com.zyxx.common.utils.ObjConvertUtils;
import com.zyxx.sbm.entity.SysDictDetail;
import com.zyxx.sbm.service.SysDictService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * 数据字典切面
 *
 * @author Tellsea
 * @date 2020/6/23
 */
@Aspect
@Component
@Slf4j
public class DictAspect {

	/**
	* 字典后缀
	*/
  private static String DICT_TEXT_SUFFIX = "Text";

  @Autowired
  private SysDictService sysDictService;

	/**
	* 切点,切入 controller 包下面的所有方法
	*/
  @Pointcut("execution( * com.zyxx.*.controller.*.*(..))")
  public void dict() {

  }

  @Around("dict()")
  public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    long time1 = System.currentTimeMillis();
    Object result = pjp.proceed();
    long time2 = System.currentTimeMillis();
    log.debug("获取JSON数据 耗时:" + (time2 - time1) + "ms");
    long start = System.currentTimeMillis();
    this.parseDictText(result);
    long end = System.currentTimeMillis();
    log.debug("解析注入JSON数据 耗时" + (end - start) + "ms");
    return result;
  }

  private void parseDictText(Object result) {
    if (result instanceof LayTableResult) {
      List<JSONObject> items = new ArrayList<>();
      LayTableResult rr = (LayTableResult) result;
      if (rr.getCount() > 0) {
        List<?> list = (List<?>) rr.getData();
        for (Object record : list) {
          ObjectMapper mapper = new ObjectMapper();
          String json = "{}";
          try {
            // 解决@JsonFormat注解解析不了的问题详见SysAnnouncement类的@JsonFormat
            json = mapper.writeValueAsString(record);
          } catch (JsonProcessingException e) {
            log.error("Json解析失败:" + e);
          }
          JSONObject item = JSONObject.parseObject(json);
          // 解决继承实体字段无法翻译问题
          for (Field field : ObjConvertUtils.getAllFields(record)) {
            //解决继承实体字段无法翻译问题
            // 如果该属性上面有@Dict注解,则进行翻译
            if (field.getAnnotation(Dict.class) != null) {
              // 拿到注解的dictDataSource属性的值
              String dictType = field.getAnnotation(Dict.class).dictCode();
              // 拿到注解的dictText属性的值
              String text = field.getAnnotation(Dict.class).dictText();
              //获取当前带翻译的值
              String key = String.valueOf(item.get(field.getName()));
              //翻译字典值对应的text值
              String textValue = translateDictValue(dictType, key);
              // DICT_TEXT_SUFFIX的值为,是默认值:
              // public static final String DICT_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) {
              SimpleDateFormat aDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
              item.put(field.getName(), aDate.format(new Date((Long) item.get(field.getName()))));
            }
          }
          items.add(item);
        }
        rr.setData(items);
      }
    }
  }

  /**
   * 翻译字典文本
   *
   * @param dictType
   * @param key
   * @return
   */
  private String translateDictValue(String dictType, String key) {
    if (ObjConvertUtils.isEmpty(key)) {
      return null;
    }
    StringBuffer textValue = new StringBuffer();
    String[] keys = key.split(",");
    for (String k : keys) {
      if (k.trim().length() == 0) {
        continue;
      }
      /**
      * 根据 dictCode 和 code 查询字典值,例如:dictCode:sex,code:1,返回:男
      * 应该放在redis,提高响应速度
      */
      SysDictDetail dictData = 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());
    }
    return textValue.toString();
  }
}

3、注解使用

我们只需要在实体类的属性上加入我们实现的自定义注解即可

@ApiModelProperty(value = "性别(0--未知1--男2--女)")
@TableField("sex")
@Dict(dictCode = "sex")
private Integer sex;

@ApiModelProperty(value = "状态(0--正常1--冻结)")
@TableField("status")
@Dict(dictCode = "status")
private Integer status;

我们对 sex,status 都加入了 @Dict(dictCode = “”) 注解,那么我们在获取用户信息的时候,就能获取到对应的字典值了

五、测试

1、编写 API 查询

我们在 controller 层开放一个 API 实现查询用户列表

/**
 * 分页查询
 */
@PostMapping("list")
@ResponseBody
public LayTableResult list(Integer page, Integer limit, SysUserInfo userInfo) {
  QueryWrapper<SysUserInfo> queryWrapper = new QueryWrapper<>();
  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");
  IPage<SysUserInfo> iPage = sysUserInfoService.page(new Page<>(page, limit), queryWrapper);
  return new LayTableResult<>(iPage.getTotal(), iPage.getRecords());
}

注意: 这里我们使用了 LayTableResult 作为相应实体类,与上面我们编写的返回通用实体类是一致的,必须一直,才能实现数据字典功能

2、调用 API

返回结果如下:

{
	"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 数据字典内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2020-09-08

springboot整合redis进行数据操作(推荐)

redis是一种常见的nosql,日常开发中,我们使用它的频率比较高,因为它的多种数据接口,很多场景中我们都可以用到,并且redis对分布式这块做的非常好. springboot整合redis比较简单,并且使用redistemplate可以让我们更加方便的对数据进行操作. 1.添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starte

Spring Boot中使用Spring-data-jpa实现数据库增删查改

在实际开发过程中,对数据库的操作无非就"增删改查".就最为普遍的单表操作而言,除了表和字段不同外,语句都是类似的,开发人员需要写大量类似而枯燥的语句来完成业务逻辑. 为了解决这些大量枯燥的数据操作语句,我们第一个想到的是使用ORM框架,比如:Hibernate.通过整合Hibernate之后,我们以操作Java实体的方式最终将数据改变映射到数据库表中. 为了解决抽象各个Java实体基本的"增删改查"操作,我们通常会以泛型的方式封装一个模板Dao来进行抽象简化,但是这

通过Spring Boot配置动态数据源访问多个数据库的实现代码

之前写过一篇博客<Spring+Mybatis+Mysql搭建分布式数据库访问框架>描述如何通过Spring+Mybatis配置动态数据源访问多个数据库.但是之前的方案有一些限制(原博客中也描述了):只适用于数据库数量不多且固定的情况.针对数据库动态增加的情况无能为力. 下面讲的方案能支持数据库动态增删,数量不限. 数据库环境准备 下面一Mysql为例,先在本地建3个数据库用于测试.需要说明的是本方案不限数据库数量,支持不同的数据库部署在不同的服务器上.如图所示db_project_001.d

详解SpringBoot 创建定时任务(配合数据库动态执行)

序言:创建定时任务非常简单,主要有两种创建方式:一.基于注解(@Scheduled) 二.基于接口(SchedulingConfigurer). 前者相信大家都很熟悉,但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务,这时候基于接口的定时任务就大派用场了. 一.静态定时任务(基于注解) 基于注解来创建定时任务非常简单,只需几行代码便可完成. @Scheduled 除了支持灵活的参数表达式cron之外,还支持简单的延时操作,例如 fixedDelay ,fixedRate 填写相应

Spring Boot整合MyBatis连接Oracle数据库的步骤全纪录

前言 本文主要分享了Spring Boot整合MyBatis连接Oracle数据库的相关内容,下面话不多说了,直接来详细的步骤吧. 步骤如下: 1.Spring Boot项目添加MyBatis依赖和Oracle驱动: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <ver

springboot配置内存数据库H2教程详解

业务背景:因soa系统要供外网访问,处于安全考虑用springboot做了个前置模块,用来转发外网调用的请求和soa返回的应答.其中外网的请求接口地址在DB2数据库中对应专门的一张表来维护,要是springboot直接访问数据库,还要专门申请权限等,比较麻烦,而一张表用内置的H2数据库维护也比较简单,就可以作为替代的办法. 环境:springboot+maven3.3+jdk1.7 1.springboot的Maven工程结构 说明一下,resource下的templates文件夹没啥用.我忘记

SpringBoot生产环境和测试环境配置分离的教程详解

第一步:项目中资源配置文件夹(resources文件夹)下先新增测试环境application-dev.yml和application-prod.yml两个配置文件,分别代表测试环境配置和生产环境配置 第二步:在application.yml配置文件中设置如下配置(PS:active后定义的名字要和配置文件-后的名字一致,如下则系统执行application-dev.yml) spring: profiles: active: dev 第三步:启动项目 启动方式一:idea中 springboo

Ubuntu 用vsftpd 配置FTP服务器教程详解

本文在Ubuntu Server 14.04 amd64系统测试. 安装ftp sudo apt-get install vsftpd 配置vsftpd.conf sudo nano /etc/vsftpd.conf #禁止匿名访问 anonymous_enable=NO #接受本地用户 local_enable=YES #允许上传 write_enable=YES #用户只能访问限制的目录 chroot_local_user=YES #设置固定目录,在结尾添加.如果不添加这一行,各用户对应自己

Ubuntu下安装配置Docker的教程详解

获取Docker 1.准备 Docker要求64位Linux且内核版本在3.10以上,在终端里输入uname -r查看,如图: 接下来更新源并查看是否有https方法: sudo apt-get update sudo apt-get install apt-transport-https ca-certificates 2.添加key 输入以下命令添加GPG key: sudo apt-key adv \ --keyserver hkp://ha.pool.sks-keyservers.net

springboot配置logback日志管理过程详解

这篇文章主要介绍了springboot配置logback日志管理过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 首先书写logback-spring.xml文件为: <?xml version="1.0" encoding="UTF-8"?> <configuration> <springProperty scope="context" name="

TensorFlow的环境配置与安装教程详解(win10+GeForce GTX1060+CUDA 9.0+cuDNN7.3+tensorflow-gpu 1.12.0+python3.5.5)

记录一下安装win10+GeForce GTX1060+CUDA 9.0+cuDNN7.3+tensorflow-gpu 1.12.0+python3.5.5 之前已经安装过pycharm.Anaconda以及VS2013,因此,安装记录从此后开始 总体步骤大致如下: 1.确认自己电脑显卡型号是否支持CUDA(此处有坑) 此处有坑!不要管NVIDIA控制面板组件中显示的是CUDA9.2.148. 你下载的CUDA不一定需要匹配,尤其是CUDA9.2,最好使用CUDA9.0,我就在此坑摔的比较惨.

IDEA 搭建maven 安装、下载、配置的图文教程详解

1.下载 maven 压缩包 输入网址 www.apache.org 会看到以下界面 住下划看到以下界面 然后看到这个界面 选择下载这个版本 下载后 解压 maven 压缩包 (文件路径不建议用有中文的,最好自己新建一个那样方便好多) 然后创建本地仓库MavenRepository 然后 打开 conf文件夹中 修改里面的 settings.xml 文件 (Notepad++.记事本.等等打开修改) 加上这段 <localRepository>E:/ideaMaven/MavenReposit

python virtualenv虚拟环境配置与使用教程详解

概述 python开发过程中,我们可能需要同时开发多款应用,这些应用可能公用同一个版本的Python程序,但是使用不同版本的第三方库,比如A应用使用six 1.12.0,而B应用需要使用six 1.15.0.这种情况下,virtualenv就派上用场了,它能为每个应用提供一套"相对独立"的Python虚拟运行环境. 注意,这里为啥是"相对独立"而不是"绝对独立"呢?针对一些.exe依赖程序,默认安装时,不会安装在虚拟环境中,安装后为各个应用共享,

PyCharm2020.1.2社区版安装,配置及使用教程详解(Windows)

本文内容皆为作者原创,码字不易,如需转载,请注明出处:https://www.cnblogs.com/temari/p/13048977.html 前提:本篇为PyCharm2020.1.2社区版安装,配置及使用教程,建议阅读本篇教程前先安装python,未安装的小伙伴可参看上一篇博客,链接:https://www.cnblogs.com/temari/p/13044416.html 下面开始本次安装教程: PyCharm分为专业版,教育版和社区版,专业版是收费的,教育版和社区版免费.专业版适用

在IntelliJ IDEA 搭建springmvc项目配置debug的教程详解

1.添加一个maven 2.选择maven 3.配置好需要debug的父工程 4.配置maven 5.最后就可以打断点debug了 到此这篇关于在IntelliJ IDEA 搭建springmvc项目配置debug的教程详解的文章就介绍到这了,更多相关IDEA 搭建springmvc项目配置debug内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!