SpringBoot中實現資料字典的示例程式碼
阿新 • • 發佈：2020-09-11
我們在日常的專案開發中，對於資料字典肯定不模糊，它幫助了我們更加方便快捷地進行開發，下面一起來看看在 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": "男"
},"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 '字典編碼',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","statusText": "正常"
}]
}
可以看出，返回的資料中，多出了 sexText，statusText，兩個屬性，也就證明我們的字典功能已經實現成功
六、總結
1、優點
1、在一定程度上，通過系統維護人員即可改變系統的行為（功能），不需要開發人員的介入。使得系統的變化更快，能及時響應客戶和市場的需求。
2、提高了系統的靈活性、通用性，減少了主體和屬性的耦合度 3、簡化了主體類的業務邏輯 4、
能減少對系統程式的改動，使資料庫、程式和頁面更穩定。特別是資料量大的時候，能大幅減少開發工作量
5、使資料庫表結構和程式結構條理上更清楚，更容易理解，在可開發性、可擴充套件性、可維護性、系統強壯性上都有優勢。
2、缺點
1、資料字典是通用的設計，在系統效率上會低一些。
2、程式演算法相對複雜一些。
3、對於開發人員，需要具備一定抽象思維能力，所以對開發人員的要求較高。
3、優化
我們的資料字典資料應該存放在 redis 中，減少與資料庫的互動次數，提高響應速度
到此這篇關於SpringBoot中實現資料字典的示例程式碼的文章就介紹到這了,更多相關SpringBoot 資料字典內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！