新聞中心
數(shù)據(jù)字典是系統(tǒng)中基本的必不可少的功能,在多種多樣的系統(tǒng)中,數(shù)據(jù)字典表的設(shè)計(jì)都大同小異。但是使用方式確是多種多樣,設(shè)計(jì)好一套易用的數(shù)據(jù)字典功能模塊,可以使開發(fā)事半功倍。

成都創(chuàng)新互聯(lián)專注于城西企業(yè)網(wǎng)站建設(shè),自適應(yīng)網(wǎng)站建設(shè),成都商城網(wǎng)站開發(fā)。城西網(wǎng)站建設(shè)公司,為城西等地區(qū)提供建站服務(wù)。全流程按需求定制制作,專業(yè)設(shè)計(jì),全程項(xiàng)目跟蹤,成都創(chuàng)新互聯(lián)專業(yè)和態(tài)度為您提供的服務(wù)
常用的數(shù)據(jù)字典使用方式:
- 直接在SQL語(yǔ)句中LEFT JOIN (當(dāng)然是不推薦這樣用的)
- 查詢出原始數(shù)據(jù),然后再根據(jù)原始數(shù)據(jù)需要的字典編碼,批量查詢字典表,并賦值到原始數(shù)據(jù)的字典值字段。
- 后臺(tái)提供通用數(shù)據(jù)字典接口,前端根據(jù)需求統(tǒng)一查詢數(shù)據(jù)字典數(shù)據(jù)并緩存在前臺(tái)。當(dāng)業(yè)務(wù)返回后臺(tái)原始數(shù)據(jù)時(shí),前臺(tái)通過(guò)類似于Filter(VUE)功能,進(jìn)行字典值對(duì)應(yīng)。
- 自定義數(shù)據(jù)字典注解,當(dāng)接口返回原始數(shù)據(jù)時(shí),通過(guò)切面分析返回對(duì)象中的數(shù)據(jù)字典字段,并將數(shù)據(jù)字典賦值到數(shù)據(jù)字典值字段。
- 提供數(shù)據(jù)字典通用工具,手動(dòng)處理單個(gè)或批量需要進(jìn)行數(shù)據(jù)字典轉(zhuǎn)換的數(shù)據(jù)。
??我們?yōu)榱烁玫臐M足多樣的業(yè)務(wù)需求,那么我們肯定是需要支持多種多樣的方式,來(lái)實(shí)現(xiàn)數(shù)據(jù)字典轉(zhuǎn)換的功能,接下來(lái),我們以1注解+2工具+3前端轉(zhuǎn)換的方式來(lái)支持?jǐn)?shù)據(jù)字典轉(zhuǎn)換。三種方式相輔相成、可以單獨(dú)使用,也可以結(jié)合起來(lái)使用。
- 可注解在Controller。
- 可注解在Service。
- 支持的集合類型:List、Set、Queue ,引用類型:Array一維數(shù)組。
- 單獨(dú)的bean支持遞歸賦值,不支持復(fù)雜數(shù)據(jù)遞歸。
- 后臺(tái)提供通用數(shù)據(jù)字典接口,前端頁(yè)面提供通用轉(zhuǎn)換方法。
- 只注解在普通字段上,不要注解到復(fù)雜對(duì)象上。
數(shù)據(jù)字典轉(zhuǎn)換流程:
- 在Service或者Controller添加@DictAuto注解,用于切面判斷此方法是需要進(jìn)行數(shù)據(jù)字典轉(zhuǎn)換的方法。
- 切面發(fā)現(xiàn)此方法是需要數(shù)據(jù)字典轉(zhuǎn)換的方法之后,那么解析方法的返回參數(shù),返回參數(shù)有多種數(shù)據(jù)類型,這里只處理集合類型:List、Set、Queue ,引用類型:Array一維數(shù)組還有普通對(duì)象類型(自定義實(shí)體bean)。
- 無(wú)論是集合類型還是普通對(duì)象類型都需要進(jìn)行遍歷、遞歸等操作,因?yàn)長(zhǎng)ist里面是普通對(duì)象,對(duì)象中也有可能是集合類型。(此處需要注意,請(qǐng)不要在對(duì)象中的字段嵌套自己,這樣會(huì)造成死循環(huán)。當(dāng)然,對(duì)象中可以嵌套自己的對(duì)象類型,可以引用非自己的對(duì)象實(shí)例,因?yàn)檫f歸操作中,我們會(huì)判斷如果是null,那么終止遞歸)
- 對(duì)返回類型進(jìn)行遞歸時(shí),通過(guò)注解獲取到數(shù)據(jù)字典類型(system、business等)、數(shù)據(jù)字典CODE(一級(jí)數(shù)據(jù)字典CODE,作為數(shù)據(jù)字典的分類),通過(guò)此條件去Redis數(shù)據(jù)庫(kù)查詢數(shù)據(jù)字典列表。將查詢的數(shù)據(jù)字典列表存儲(chǔ)在Map中。在循環(huán)遍歷過(guò)程中,增加判斷,如果Map中有了,那么不再查詢Redis數(shù)據(jù)庫(kù),而是直接從Map中取。
- 在遍歷遞歸對(duì)象的同時(shí),根據(jù)數(shù)據(jù)字典注解,獲取本對(duì)象中用于映射數(shù)據(jù)字典的字段值作為數(shù)據(jù)字典的CODE值(二級(jí)數(shù)據(jù)字典CODE,對(duì)應(yīng)具體的數(shù)據(jù)字典),然后賦值到數(shù)據(jù)字典值上。
一、通過(guò)注解實(shí)現(xiàn)數(shù)據(jù)字典轉(zhuǎn)換功能
1、新增數(shù)據(jù)字典注解定義
package com.gitegg.platform.base.annotation.dict;
import java.lang.annotation.*;
/**
* 數(shù)據(jù)字典注解,注解在方法上,自動(dòng)設(shè)置返回參數(shù)的字典數(shù)據(jù)
* 1、可以注解在 service和 controller上,只注解返回值,支持引用類型和常用的集合類型
* 2、具體的實(shí)體類中,如果是引用類型,那么遞歸賦值
* 3、支持的集合類型:List Set Queue ,引用類型:Array一維數(shù)組,普通對(duì)象類型(自定義實(shí)體bean)。
* @author GitEgg
*/
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DictAuto {
}
package com.gitegg.platform.base.annotation.dict;
import java.lang.annotation.*;
/**
* 數(shù)據(jù)字典注解,注解在字段上
* 如果dictCode為空,且此字段是對(duì)象類型,那么表示此字段對(duì)象中擁有字典類型,
* 也就是只有注解了此字段的數(shù)據(jù)才會(huì)去遞歸設(shè)置字典值,不去隨便做無(wú)所謂的遍歷
*
* @author GitEgg
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DictField {
/**
* 數(shù)據(jù)字典類型 :系統(tǒng)字典 system 業(yè)務(wù)字典 business 地區(qū)字典 areas 其他字典:直接表名,例: t_sys_role
* 1、確定選擇哪種類型的數(shù)據(jù)字典
*/
String dictType() default "business";
/**
* 數(shù)據(jù)字典編碼,就是取哪些數(shù)據(jù)字典的值
* 2、確定需要匹配數(shù)據(jù)字典的集合
*/
String dictCode() default "";
/**
* 要最終轉(zhuǎn)換最終數(shù)據(jù)字典的鍵,是實(shí)體類中的一個(gè)字段,通常配置為此字段的定義名稱,通過(guò)此字段作為key來(lái)轉(zhuǎn)換數(shù)據(jù)字典的值
* 3、確定需要把實(shí)體中哪個(gè)字段轉(zhuǎn)換為字典值
*/
String dictKey() default "";
/**
* 如果是自定義表數(shù)據(jù)時(shí),此字段作為字典code,對(duì)應(yīng)數(shù)據(jù)表的字段
* 4、表中作為數(shù)據(jù)字典的鍵
*/
String dictFiled() default "";
/**
* 如果是自定義表數(shù)據(jù)時(shí),此字段作為字典value,對(duì)應(yīng)數(shù)據(jù)表的字段
* 5、表中作為數(shù)據(jù)字典的值
*/
String dictValue() default "";
}
2、新增切面,處理數(shù)據(jù)字典注解
package com.gitegg.platform.boot.aspect;
import cn.hutool.core.util.ArrayUtil;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.gitegg.platform.base.annotation.dict.DictAuto;
import com.gitegg.platform.base.annotation.dict.DictField;
import com.gitegg.platform.base.constant.DictConstant;
import com.gitegg.platform.base.constant.GitEggConstant;
import com.gitegg.platform.base.result.Result;
import com.gitegg.platform.boot.util.GitEggAuthUtils;
import com.gitegg.platform.redis.lock.IDistributedLockService;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import jodd.util.StringPool;
import lombok.RequiredArgsConstructor;
import lombok.extern.log4j.Log4j2;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.lang.NonNull;
import org.springframework.stereotype.Component;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.math.BigDecimal;
import java.util.*;
import java.util.function.Consumer;
/**
* 數(shù)據(jù)字典切面
* @author GitEgg
* @date 2022-4-10
*/
@Log4j2
@Component
@Aspect
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@ConditionalOnProperty(name = "enabled", prefix = "dict", havingValue = "true", matchIfMissing = true)
public class DictAspect {
/**
* 是否開啟租戶模式
*/
@Value("${tenant.enable}")
private Boolean enable;
private final RedisTemplate redisTemplate;
/**
* 后置通知 解析返回參數(shù),進(jìn)行字典設(shè)置
* @AfterReturning 只有存在返回值時(shí)才會(huì)執(zhí)行 @After 無(wú)論有沒(méi)有返回值都會(huì)執(zhí)行 所以這里使用 @AfterReturning 只有存在返回值時(shí)才執(zhí)行字典值注入操作
* @param dictAuto 注解配置
*/
@AfterReturning(pointcut = "@annotation(dictAuto)", returning = "returnObj")
public void doAfterReturning( DictAuto dictAuto, Object returnObj){
// 返回不為null時(shí),進(jìn)行數(shù)據(jù)字典處理
if (null != returnObj) {
doDictAuto(dictAuto, returnObj);
}
}
/**
* key的組成為: dict:userId:sessionId:uri:method:(根據(jù)spring EL表達(dá)式對(duì)參數(shù)進(jìn)行拼接)
* 此處要考慮多種返回類型,集合類型、引用類型、對(duì)象類型和基本數(shù)據(jù)類型,這里只處理 集合類型:List Set Queue ,引用類型:Array數(shù)組,Array只支持一維數(shù)組。
* 對(duì)于對(duì)象中的子對(duì)象,為了提升性能,同樣需要加@DictField注解才去填充,否則每個(gè)子對(duì)象都去遞歸判斷,影響性能
* 我們要考慮此處的邏輯:
* 1、判斷返回?cái)?shù)據(jù)類型,如果是集合類型,那么取出包含實(shí)體對(duì)象的集合類,然后進(jìn)行對(duì)象解析
* 2、如果是對(duì)象類型,那么直接進(jìn)行對(duì)象解析
* 3、如果是IPage類型,那么取出其中的list數(shù)據(jù),判斷是否為空,不為空,執(zhí)行 1 步驟
* 4、如果是Result類型,判斷Result的data是IPage還是集合類型,分別執(zhí)行對(duì)應(yīng)的 1 步驟 或 3 步驟,如果不是IPage也不是集合類型,直接執(zhí)行第 2 步驟
* @param dictAuto 注解
* @param objectReturn 方法返回值
*/
private void doDictAuto(@NonNull DictAuto dictAuto, Object objectReturn) {
// 臨時(shí)存儲(chǔ)數(shù)據(jù)字典map
Map> dictMap = new HashMap<>();
this.translationObjectDict(objectReturn, dictMap);
}
/**
* 找到實(shí)際的對(duì)象或?qū)ο罅斜?br> * 此處要考慮多種返回類型,集合類型、引用類型、對(duì)象類型和基本數(shù)據(jù)類型,這里只處理 集合類型:List Set Queue ,引用類型:Array一維數(shù)組。
* @param objectReturn
* @param dictMap
* @return
*/
private void translationObjectDict(Object objectReturn, Map> dictMap) {
if (Objects.isNull(objectReturn))
{
return;
}
// 判斷返回值類型是Result、IPage、List、Object
if (objectReturn instanceof Result) {
Object objectTarget = ((Result) objectReturn).getData();
translationObjectDict(objectTarget, dictMap);
} else if (objectReturn instanceof IPage) {
List
二、實(shí)現(xiàn)自定義工具,手動(dòng)進(jìn)行數(shù)據(jù)字典轉(zhuǎn)換
比較靈活,選擇需要轉(zhuǎn)換的數(shù)據(jù)即可。
三、前端轉(zhuǎn)換數(shù)據(jù)字典
定義通用接口,首先從緩存查,緩存沒(méi)有再查詢數(shù)據(jù)庫(kù),在登錄后重置數(shù)據(jù)字典。
1、前端新增dictUtils,用于dictCode的查詢、緩存等操作。
import { getAuthCache, setAuthCache } from '/@/utils/auth';
import { DICT_SYSTEM_CACHE_KEY, DICT_BUSSINESS_CACHE_KEY } from '/@/enums/cacheEnum';
import { listDict, batchListDict } from '/@/api/system/base/dict';
import { listDictBusiness, batchListDictBusiness } from '/@/api/system/base/dictBusiness';
// System default cache time
export const DICT_CACHE_TIME = 60 * 60 * 2 * 1000;
// Dict
export interface Dict {
// dictCode
dictCode: string;
// dictList
dictList?: [];
// filterMap
filterMap?: {};
}
// DictMap
export interface DictMap {
// dictList
dictMap: {};
}
export function getDictCacheOnly(dict: Dict) {
let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
if (!dictMap) {
dictMap = {};
}
if (dictMap[dict.dictCode]) {
return dictMap[dict.dictCode] as Dict;
} else {
getDict(dict).then(function (dictReturn) {
dictMap[dict.dictCode] = dictReturn;
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
});
return dict;
}
}
export function getDictBusinessCacheOnly(dict: Dict) {
let dictBusinessMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
if (!dictBusinessMap) {
dictBusinessMap = {};
}
if (dictBusinessMap[dict.dictCode]) {
return dictBusinessMap[dict.dictCode] as Dict;
} else {
getDictBusiness(dict).then(function (dictReturn) {
dictBusinessMap[dict.dictCode] = dictReturn;
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictBusinessMap);
});
return dict;
}
}
export async function getDictCache(dict: Dict) {
let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
if (!dictMap) {
dictMap = {};
}
if (dictMap[dict.dictCode]) {
return dictMap[dict.dictCode] as Dict;
} else {
const dictReturn = await getDict(dict);
dictMap[dict.dictCode] = dictReturn;
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
return dictReturn;
}
}
export async function getDictBusinessCache(dict: Dict) {
let dictBusinessMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
if (!dictBusinessMap) {
dictBusinessMap = {};
}
if (dictBusinessMap[dict.dictCode]) {
return dictBusinessMap[dict.dictCode] as Dict;
} else {
const dictReturn = await getDictBusiness(dict);
dictBusinessMap[dict.dictCode] = dictReturn;
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictBusinessMap);
return dictReturn;
}
}
// 批量初始化系統(tǒng)字典
export async function initDictCache(dictCodeList: string[]) {
let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
if (!dictMap) {
dictMap = {};
}
const dictResultMap = await batchListDict(dictCodeList);
if (dictResultMap) {
dictCodeList.forEach(function (dictCode) {
if (dictResultMap[dictCode]) {
const dict = {} as Dict;
dict.dictList = dictResultMap[dictCode];
dict.filterMap = {};
dict.dictList.forEach((item) => {
const itemDict = item as any;
dict.filterMap[itemDict.dictCode] = itemDict.dictName;
});
dictMap[dictCode] = dict;
}
});
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
}
}
// 批量初始化業(yè)務(wù)字典
export async function initDictBusinessCache(dictCodeList: string[]) {
let dictMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
if (!dictMap) {
dictMap = {};
}
const dictResultMap = await batchListDictBusiness(dictCodeList);
if (dictResultMap) {
dictCodeList.forEach(function (dictCode) {
if (dictResultMap[dictCode]) {
const dict = {} as Dict;
dict.dictList = dictResultMap[dictCode];
dict.filterMap = {};
dict.dictList.forEach((item) => {
const itemDict = item as any;
dict.filterMap[itemDict.dictCode] = itemDict.dictName;
});
dictMap[dictCode] = dict;
}
});
// 數(shù)據(jù)字典默認(rèn)緩存2小時(shí),重新登陸后失效
setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictMap);
}
}
export async function getDict(dict: Dict) {
const dictList = await listDict(dict.dictCode);
if (dictList && dictList.length > 0) {
dict.dictList = dictList;
dict.filterMap = {};
dictList.forEach((item) => {
dict.filterMap[item.dictCode] = item.dictName;
});
}
return dict;
}
export async function getDictBusiness(dict: Dict) {
const dictBusinessList = await listDictBusiness(dict.dictCode);
if (dictBusinessList && dictBusinessList.length > 0) {
dict.dictList = dictBusinessList;
dict.filterMap = {};
dictBusinessList.forEach((item) => {
dict.filterMap[item.dictCode] = item.dictName;
});
}
return dict;
}
2、登錄成功后重新數(shù)據(jù)字典緩存,也就是每次在后臺(tái)數(shù)據(jù)字典修改之后,前端需要重新登錄才能刷新數(shù)據(jù)字典緩存。
// 重新初始化系統(tǒng)數(shù)據(jù)字典
setAuthCache(DICT_SYSTEM_CACHE_KEY, {});
// 重新初始化業(yè)務(wù)數(shù)據(jù)字典
setAuthCache(DICT_BUSSINESS_CACHE_KEY, {});
3、在需要用到數(shù)據(jù)字典時(shí),直接調(diào)用即可,根據(jù)utils的實(shí)現(xiàn),首先會(huì)從緩存查詢,如果緩存中沒(méi)有,才會(huì)從后臺(tái)查詢。
import { getDictBusinessCache } from '/@/utils/gitegg/dictUtils';
......
{
label: '狀態(tài)',
field: 'status',
component: 'ApiRadioGroup',
required: true,
defaultValue: '2',
componentProps: {
api: getDictBusinessCache,
params: { dictCode: 'USER_STATUS' },
resultField: 'dictList',
// use name as label
labelField: 'dictName',
// use id as value
valueField: 'dictCode',
},
},
......
數(shù)據(jù)字典在系統(tǒng)中的使用非常頻繁,所以在設(shè)計(jì)和使用時(shí),既要保證實(shí)時(shí)更新獲取最新配置,又要保證不能引發(fā)系統(tǒng)性能問(wèn)題。在系統(tǒng)設(shè)計(jì)的時(shí)候,既要考慮到后臺(tái)數(shù)據(jù)字典轉(zhuǎn)換,還需要考慮到前端數(shù)據(jù)字典轉(zhuǎn)換,這兩種轉(zhuǎn)換方式在使用過(guò)程中,我們根據(jù)具體業(yè)務(wù)需求和使用條件具體選擇其中一種即可。
網(wǎng)站標(biāo)題:SpringCloud—數(shù)據(jù)字典注解的設(shè)計(jì)與實(shí)現(xiàn)
鏈接分享:http://m.fisionsoft.com.cn/article/dhpjisj.html


咨詢
建站咨詢
