Aop+自定义注解实现数据字典映射

news2024/11/27 20:58:33

数据字典

    Web项目开发中,字典表的一般都会存在,主要用来给整个系统提供基础服务。

  比如男女性别的类型可以使用0和1来进行表示,在存储数据和查询数据的时候,就可以使用字典表中的数据进行翻译处理。

   再比如之前做的一个项目中宠物类型包含老虎-1、海豚-2、大象-3、长颈鹿-4等等;做答题处理时的答题类型,比如单选题、多选题、填空题等等;

   比较常用的有用户类型,普通用户还是VIP用户等等;这些类型的数据也可以存储在数据字典中进行统一处理。

数据结构以及业务

举例:

在业务表中使用的是业务目录,而其中的“数据结构”,“数据目录类型”,“数据来源”使用的是字典表中的id,但我们在页面显示的时候,想用字典表中的value值,即我们在库里相应的业务表的外键存字典表的ID,查询的时候返回给前端在字典表中的value字段。

如以下表以及内容的展示:

目录表:

内容: 外键,字典的ID

如图所示:(字典表)需要我们在表中拿出外键所对应的Label

列举方法

   那有什么办法可以让我们查询出key的同时,将value值也查询出来,当时处理问题的时候想了三种解决方法:

1.要么就写sql 匹配。(在SQL查询的时候做字段的匹配,但是增加了SQL的复杂性不易维护)

2.要么就业务处理。得写个工具类(针对当时的情况感觉可以实现,然后查找了一些资料比如,自定义注解啥的)

3.再就是前端调两次接口,查询一次数据,再查询一次字典表做转译。(所涉及到的字段有四五个甚至更多,这是我问的别的同学,他们公司采用的就是这种方法)

根据查找资料以及实际考虑,最终采用了使用自定义注解的方式去做字段映射。

实现步骤:

首先展示项目的目录结构

总共三个,自定义注解,切面,具体实现

一 ,创建自定义注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Dict {

    /**
	 * 字典类型,对应数据库的类型,下方展示
	 */
	String dictType();

	/**
	 * 实体类内对应的中文字段名,默认为“当前字段+Text”
	 * <p>
     *  例如当前字段为“type”,则对应中文字段默认为“typeText”
	 * 就是你在实体中想要给某个字段赋值,这个字段就要写成那个字段
	 */
	String dictField() default "";

}

二,创建切面


@Slf4j
@Aspect
@Component
public class BydDaoDictAspect {
//  * `@Pointcut` 注解用于定义一个切点,切点是决定哪些方法应该被通知(advice)的表达式。
//	* `execution(* com.wiseom.asset.manage.service..*.*(..))` 是一个切点表达式,它表示匹配 `com.wiseom.asset.manage.service` 包及其子包下的所有类的所有方法。
//	* `doPointcut()` 方法本身没有执行任何操作,它只是为切点提供了一个标识符。
	@Pointcut("execution(* com.wiseom.asset.manage.service..*.*(..))")
	public void doPointcut() {
	}
//  * `@AfterReturning` 注解表示在匹配的方法成功执行并返回结果后执行通知。
//  * `pointcut = "doPointcut()"` 表示这个通知应用于之前定义的 `doPointcut` 切点。
//	* `returning = "result"` 捕获返回的结果,并将其作为 `result` 参数传递给通知方法。
//	* 在 `doAfterReturning` 方法中,`DictUtils.convertDict(result)` 是将返回的 `result` 对象转换为字典格式。如果在转换过程中发生异常,它会被捕获并记录到日志中。

	@AfterReturning(pointcut = "doPointcut()", returning = "result")
	public void doAfterReturning(JoinPoint pjp, Object result) {
		try {
			DictUtils.convertDict(result);
		} catch (Exception e) {
			log.error(String.valueOf(e));
		}
	}
}

备注:

1:切点在com.wiseom.asset.manage.service的原因,因为我们使用了mybitsplus ,在我们处理查询,或者执行SQL的时候大多都在service层就被处理了,所以切点设在了service层。

2:如果切点设置在Controller,则需要修改下方实现三中的 方法 convertDict,因为 Controller的返回值拿到的是 R 包裹的内容,返回值对象是R,而不是实体,具体问题查看下方的扩展四

三,创建实现


@Component
public class DictUtils {

	private static final String DICT_FIELD_SUFFIX = "Text";

	/**
	 * 统一获取当前实体类涉及到的字典表数据,避免多次查询数据库造成的性能消耗
     * 这个工具类主要的改动就是这个,所以我就把这一段放在上面了
	 * @param dictNames 字典表type值
	 * @return 字典表数据
	 */
	@SneakyThrows
	private static  Map<String, Map<Long, String>> getDictMap(List<String> dictNames) {
		//创建fegin的实例,调用系统的sys_dict_item表,需要新写一个接口
		final 	RemoteDictService remoteDictService = SpringContextHolder.getBean(RemoteDictService.class);
		//把注解里的所有字典的类型查出来,具体根据需求做查询
		List<SysDictItem> dictList = remoteDictService.getDictItemByType(dictNames);
		//根据类型做一个分组,这里对应的是 Map<DictType, Map<ID, Label>>
		return dictList.stream().collect(Collectors.groupingBy(
				SysDictItem::getDictType, Collectors.toMap(SysDictItem::getId, SysDictItem::getLabel, (v1, v2) -> v2)));
	}

	/**
	 * 这是主方法主要是判断AOP后返回的内容,并根据判断条件拿到里面的内容
     *  然后先判断有哪些带有注解,根据注解拿到对应的dictType去库里查找对应的内容 
     *  根据拿到内容在对指定的字段dictField进行赋值
	 */
	public static void convertDict(Object target) {
		//判断对象是不是分页的
		if (target instanceof Page) {
             //拿到分页中的records对象里边包含实体的内容
			for(Object object : ((Page<?>)target).getRecords()){
				//拿到实体
				List<DictDefinition> dictDefinitions = getMetadata(object);
				// 如果没有注解,则直接返回
				if (CollectionUtils.isEmpty(dictDefinitions)) return;
				// 从字典定义中提取所有的注解的 dictType(数据库字典的类型)
				List<String> dictNames = dictDefinitions.stream().map(d -> d.getDict().dictType()).collect(Collectors.toList());
				// 根据字典类型获取字典映射
				Map<String, Map<Long, String>> dictMapMap = getDictMap(dictNames);
				// 转换target对象的字典字段
				doConvertDict(object, dictDefinitions, dictMapMap);
			}
		} else
		if (target instanceof List) {
			// 将target强制转换为List<?>类型
			List<?> objectList = ((List<?>) target);

			// 使用CollectionUtils.isNotEmpty来检查列表是否非空
			if (CollectionUtils.isNotEmpty(objectList)) {
				// 获取列表中第一个元素的字典定义
				List<DictDefinition> dictDefinitions = getMetadata(objectList.get(0));
				// 如果没有注解,则直接返回
				if (CollectionUtils.isEmpty(dictDefinitions)) return;
				// 从字典定义中提取所有的注解的 dictType(数据库字典的类型)
				List<String> dictNames = dictDefinitions.stream().map(d -> d.getDict().dictType()).collect(Collectors.toList());
				// 根据字典类型获取字典映射
				Map<String, Map<Long, String>> dictMapMap = getDictMap(dictNames);
				// 遍历列表中的每个元素,并转换其字典字段
				objectList.forEach(t -> doConvertDict(t, dictDefinitions, dictMapMap));
			}
		} else {
			// 如果target不是List,则直接获取其字典定义
			List<DictDefinition> dictDefinitions = getMetadata(target);
			// 如果没有注解,则直接返回
			if (CollectionUtils.isEmpty(dictDefinitions)) return;
			// 从字典定义中提取所有的注解的 dictType(数据库字典的类型)
			List<String> dictNames = dictDefinitions.stream().map(d -> d.getDict().dictType()).collect(Collectors.toList());
			// 根据字典类型获取字典映射
			Map<String, Map<Long, String>> dictMapMap = getDictMap(dictNames);
			// 转换target对象的字典字段
			doConvertDict(target, dictDefinitions, dictMapMap);
		}
	}

	/**
	 * 仅获取一次Dict元数据,降低多次反射造成的性能消耗
	 * @param target 目标实体类
	 * @return Dict元数据
	 */
	private static List<DictDefinition> getMetadata(Object target) {
		//这一段是判断存在注解的字段
		List<DictDefinition> dictDefinitions = new ArrayList<>();
		if (ClassUtils.isPrimitiveOrWrapper(target.getClass())
				|| target instanceof Map || target instanceof String) {
			return dictDefinitions;
		}
		List<Field> fields = FieldUtils.getAllFieldsList(target.getClass());
		for (Field field : fields) {
			Dict dict = AnnotationUtils.getAnnotation(field, Dict.class);
			if (dict != null) {
				DictDefinition dictDefinition = new DictDefinition();
				dictDefinition.setDict(dict);
				dictDefinition.setField(field);
				dictDefinitions.add(dictDefinition);
			}
		}
		return dictDefinitions;
	}

	@SneakyThrows
	private static void doConvertDict(Object target, List<DictDefinition> dictDefinitions,
									  Map<String, Map<Long, String>> dictMapMap) {
		for (DictDefinition dictDefinition : dictDefinitions) {
            //获取Dict注解和字段信息
			Dict dict = dictDefinition.getDict();
			Field field = dictDefinition.getField();
			//获取字典映射
			Map<Long, String> dictMap = dictMapMap.get(dict.dictType());
			//读取实体中带有注解的字段原有的值
			String dictCode = String.valueOf(FieldUtils.readField(target, field.getName(), true));
			//类型转换,我在库中用的存储的字段是String,所以需要进行类型的转换,如果你的库设置的不是,或者其他的类型,需要注意到这个地方
			Long longDictCode=Long.valueOf(dictCode);
			//拿到字典注解的label
			String dictField = StringUtils.isEmpty(dict.dictField()) ? field.getName() + DICT_FIELD_SUFFIX : dict.dictField();
			//设置字段的字典文本值
			FieldUtils.writeField(target, dictField, dictMap.get(longDictCode), true);
		}
	}

	@Data
	public static class DictDefinition {

		private Dict dict;

		private Field field;

	}

}

系统表的查询接口:

//这个我是在SysDictController下添加的接口,目的是实现查找多个类型的内容,同时还需要写个fegin接口以供别的模块使用
/**
	 * 通过字典类型查找字典
	 * @param types 类型
	 * @return 同类型字典
	 */
	@PostMapping("/types")
	public List<SysDictItem> getDictByTypes(@RequestBody List<String> types) {
		return sysDictItemService.list(Wrappers.<SysDictItem>query().lambda().in(SysDictItem::getDictType, types));
	}

使用方法

直接在实体字段上方添加注解

1.dictType:数据库中的字典的类型

2.dictField:实体中赋值的字段

如上方使用方法所示,如果你想将字典中的label值给实体中的 catalogStructure,则标注

如果前端需要,一个原来的ID,一个label,那就需要创建一个DTO,如图所示,将dictField 后边写上你想要的字段名称就行了

四,备注以及扩展

这个是公司用的pigx框架,没用到的同学,可以跳过了,仅供参考,依据具体项目实际来定

参数的入值:

@AfterReturning(pointcut = "doPointcut()", returning = "result")
	public void doAfterReturning(JoinPoint pjp, Object result) {
		try {
			DictUtils.convertDict(result);
		} catch (Exception e) {
			log.error(String.valueOf(e));
		}
	}

这个代码中的result需要着重注意,他可能会存在判断的问题

举例:这个是正常的,只拿到这个返回的实体就行,在我们实现三中的方法convertDict所有if()的目的都是为了拿到返回值中的实体

比如底下这个图,分页返回的就需要做一个判断(实现三我已经加上了,这个做一个参考):

判断:

五:具体实现 优化1,多个字段的匹配,用“,”隔开代码优化


@Component
public class DictUtils {

	private static final String DICT_FIELD_SUFFIX = "Text";


	/**
	 * 执行字典转换的公共方法
	 * @param target 待转换的对象
	 */
	public static void convertDict(Object target) {
		//判断是否是分页
		if (target instanceof Page) {
			for (Object object : ((Page<?>) target).getRecords()) {
				convertDictInternal(object);
			}
			//是否是list
		} else if (target instanceof List) {
			if (CollectionUtils.isNotEmpty((List<?>) target)) {
				for (Object object : (List<?>) target) {
					convertDictInternal(object);
				}
			}
		} else {
			convertDictInternal(target);
		}
	}

	/**
	 * 内部的字典转换实现方法
	 * @param target 待转换的对象
	 */
	@SneakyThrows
	private static void convertDictInternal(Object target) {
		// 获取目标对象的字典定义
		List<DictDefinition> dictDefinitions = getMetadata(target);
		// 如果没有字典定义则直接返回
		if (CollectionUtils.isEmpty(dictDefinitions)) {
			return;
		}
		// 提取字典类型并获取字典映射
		String commaSeparatedString = dictDefinitions.stream()
				.map(d -> d.getDict().dictType())
				.collect(Collectors.joining(","));
		List<String> dictNames = Arrays.asList(commaSeparatedString.split(","));
		Map<String, Map<Long, String>> dictMapMap = getDictMap(dictNames);
		// 执行具体的字典转换操作
		doConvertDict(target, dictDefinitions, dictMapMap);
	}

	/**
	 * 获取目标对象的字典定义
	 * @param target 目标对象
	 * @return 字典定义列表
	 */
	private  static List<DictDefinition> getMetadata(Object target) {
		List<DictDefinition> dictDefinitions = new ArrayList<>();
		// 排除基本类型、包装类型、Map 和 String 类型
		if (ClassUtils.isPrimitiveOrWrapper(target.getClass())
				|| target instanceof Map || target instanceof String) {
			return dictDefinitions;
		}
         // 获取目标对象的所有字段
		List<Field> fields = FieldUtils.getAllFieldsList(target.getClass());
		for (Field field : fields) {
			// 获取字段上的 Dict 注解
			Dict dict = AnnotationUtils.getAnnotation(field, Dict.class);
			if (dict!= null) {
				// 创建并添加字典定义
				DictDefinition dictDefinition = new DictDefinition();
				dictDefinition.setDict(dict);
				dictDefinition.setField(field);
				dictDefinitions.add(dictDefinition);
			}
		}
		return dictDefinitions;
	}


	/**
	 * 根据字典名称获取字典映射
	 * @param dictNames 字典名称列表
	 * @return 字典映射
	 */
	@SneakyThrows
	private static  Map<String, Map<Long, String>> getDictMap(List<String> dictNames) {
		final RemoteDictService remoteDictService = SpringContextHolder.getBean(RemoteDictService.class);
		List<SysDictItem> dictList = remoteDictService.getDictItemByType(dictNames);
		return new HashMap<>(dictList.stream().collect(Collectors.groupingBy(
				SysDictItem::getDictType, Collectors.toMap(SysDictItem::getId, SysDictItem::getLabel, (v1, v2) -> v2))));
	}


	/**
	 * 执行具体的字典字段转换
	 * @param target 目标对象
	 * @param dictDefinitions 字典定义列表
	 * @param dictMapMap 字典映射
	 */
	@SneakyThrows
	private static  void doConvertDict(Object target, List<DictDefinition> dictDefinitions,
							   Map<String, Map<Long, String>> dictMapMap) {
		for (DictDefinition dictDefinition : dictDefinitions) {
			Dict dict = dictDefinition.getDict();
			Field field = dictDefinition.getField();

			String[] dictTypes = dict.dictType().split(",");
			for (String dictType : dictTypes) {
				Map<Long, String> dictMap = dictMapMap.get(dictType.trim());
				// 读取字段的字典编码
				String dictCode = String.valueOf(FieldUtils.readField(target, field.getName(), true));
				// 类型转换
				Long longDictCode = Long.valueOf(dictCode);
				// 确定字典字段名
				String dictField = StringUtils.isEmpty(dict.dictField())? field.getName() + DICT_FIELD_SUFFIX : dict.dictField();
				// 设置字段的字典文本值
				if (dictMap!= null && dictMap.containsKey(longDictCode)) {
					FieldUtils.writeField(target, dictField, dictMap.get(longDictCode), true);
				}
			}
		}
	}

	@Data
	public static class DictDefinition {

		private Dict dict;

		private Field field;

	}
}

使用方式:

参考:

主要内容参考:

java自定义注解实现数据字典映射_字典映射 java-CSDN博客

分页扩展参考:

字典翻译@Dict - 莫大人 - 博客园

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2235780.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【NLP自然语言处理】深入探索Self-Attention:自注意力机制详解

目录 &#x1f354; Self-attention的特点 &#x1f354; Self-attention中的归一化概述 &#x1f354; softmax的梯度变化 3.1 softmax函数的输入分布是如何影响输出的 3.2 softmax函数在反向传播的过程中是如何梯度求导的 3.3 softmax函数出现梯度消失现象的原因 &…

华为eNSP:QinQ

一、什么是QinQ&#xff1f; QinQ是一种网络技术&#xff0c;全称为"Quantum Insertion"&#xff0c;也被称为"Q-in-Q"、"Double Tagging"或"VLAN stacking"。它是一种在现有的VLAN&#xff08;Virtual Local Area Network&#xff0…

细说STM32单片机USART中断收发RTC实时时间并改善其鲁棒性的另一种方法

目录 一、工程目的 1、目标 2、通讯协议及应对错误指令的处理目标 二、工程设置 三、程序改进 四、下载与调试 1、合规的指令 2、不以#开头&#xff0c;但以&#xff1b;结束&#xff0c;长度不限 3、以#开头&#xff0c;不以;结束&#xff0c;也不包含;&#xff0c;长…

Redis设计与实现 学习笔记 第十六章 Sentinel

Sentinel&#xff08;哨岗、哨兵&#xff09;是Redis的高可用性&#xff08;high availability&#xff09;解决方案&#xff1a;由一个或多个Sentinel实例&#xff08;instance&#xff09;组成的Sentinel系统可以监视任意多个主服务器&#xff0c;以及这些主服务器属下的从服…

前端三件套-css

一、元素选择器 元素选择器&#xff1a;利用标签名称。p,h1-h6...... 行内样式&#xff08;内联样式&#xff09;&#xff1a;例如<p style"color:red;font-size:50px"> id选择器&#xff1a;针对某一个特定的标签来使用。以#定义。 class&#xff08;类&a…

MoonBit 双周报 Vol.59:新增编译器常量支持,改进未使用警告,支持跨包函数导入...多个关键技术持续优化中!

2024-11-04 MoonBit更新 增加了编译期常量的支持。常量的名字以大写字母开头&#xff0c;用语法 const C ... 声明。常量的类型必须是内建的数字类型或 String。常量可以当作普通的值使用&#xff0c;也可以用于模式匹配。常量的值目前只能是字面量&#xff1a; const MIN_…

新疆高校大数据实验室案例分享

高校大数据实验室建设&#xff0c;企业可以提供技术支持、实训平台和项目案例&#xff0c;高校则提供科研和教学资源&#xff0c;实现产学研一体化。不仅有利于大数据技术的应用和人才培养也有利于区域发展。 泰迪与新疆合作的院校包括新疆大学、昌吉学院等 新疆大…

Capcut,更适合做TikTok运营的“剪映”

剪映这一次的更新&#xff0c;可谓是引来许多视频创作者的怒火。原本免费的功能&#xff0c;更新之后需要vip才能使用了&#xff1b;原本的vip功能&#xff0c;则需要升级至svip&#xff0c;甚至一些功能&#xff0c;需要会员积分才能使用。 许多运营TikTok的小伙伴一直在用剪映…

linux centos 安装redis

安装 wget https://download.redis.io/releases/redis-7.4.0.tar.gz解压redis-7.4.0.tar.gz文件 tar -zxvf redis-7.4.0.tar.gz进入redis安装目录 cd redis-7.4.0make时报错&#xff0c;因为需要安装gcc&#xff0c;gcc安装需要联网安装 修改端口 编辑文件用vi。nano命令cen…

第一个纯血鸿蒙应用(Napi开发-ArtTS调用C/C++)

1.行业背景 纯血鸿蒙&#xff0c;即鸿蒙Next版已于2014年1月正式发版&#xff0c;鸿蒙生态设备数量已经突破10亿台&#xff0c;已经有超过15000个应用和元服务上架。鸿蒙生态不只是移动设备这么简单&#xff0c;他打造的是一个18n的全场景战略&#xff0c;真正做到了“万物互联…

2.ARM_ARM是什么

CPU工作原理 CPU与内存中的内容&#xff1a; 内存中存放了指令&#xff0c;每一个指令存放的地址不一样&#xff0c;所需的内存空间也不一样。 运算器能够进行算数运算和逻辑运算&#xff0c;这些运算在CPU中都是以运算电路的形式存在&#xff0c;一个运算功能对应一种运算电…

【Ant.designpro】上传图片

文章目录 一、前端二、后端 一、前端 fieldProps:可以监听并且获取到组件输入的内容 action{“/api/upload_image”} 直接调用后端接口 <ProFormUploadButtonlabel{"上传手续图片"}name{"imgs"}action{"/api/upload_image"}max{5} fieldPro…

CSS基础知识六(浮动的高度塌陷问题及解决方案)

目录 1.浮动高度塌陷概念 2.下面是几种解决高度塌陷的几种方案&#xff1a; 解决方案一&#xff1a; 解决方案二&#xff1a; 解决方案三&#xff1a; 1.浮动高度塌陷概念 在CSS中&#xff0c;高度塌陷问题指的是父元素没有正确地根据其内部的浮动元素或绝对定位元素来计…

【云原生开发】K8S集群管理后端开发设计与实现

✨✨ 欢迎大家来到景天科技苑✨✨ &#x1f388;&#x1f388; 养成好习惯&#xff0c;先赞后看哦~&#x1f388;&#x1f388; &#x1f3c6; 作者简介&#xff1a;景天科技苑 &#x1f3c6;《头衔》&#xff1a;大厂架构师&#xff0c;华为云开发者社区专家博主&#xff0c;…

计算机网络——SDN

分布式控制路由 集中式控制路由

qt QTableWidgetItem详解

1、概述 QTableWidgetItem 是 Qt 框架中的一个类&#xff0c;专门用于在 QTableWidget&#xff08;一个基于项的表格视图&#xff09;中表示单个单元格的内容。QTableWidget 继承自 QAbstractItemView&#xff0c;而 QTableWidgetItem 则作为表格中的一个单元格项&#xff0c;…

DevExpress中文教程 - 如何使用AI模型检查HTML编辑中的语法?

DevExpress .NET MAUI多平台应用UI组件库提供了用于Android和iOS移动开发的高性能UI组件&#xff0c;该组件库包括数据网格、图表、调度程序、数据编辑器、CollectionView和选项卡组件等。 目前许多开发人员正在寻找多种方法将AI添加到解决方案中&#xff08;这通常比想象的要…

vue中html如何转成pdf下载,pdf转base64,忽略某个元素渲染在pdf中,方法封装

一、下载 html2Canvas jspdf npm install jspdf html2canvas二、封装转换下载方法 htmlToPdf.js import html2Canvas from html2canvas import JsPDF from jspdf/*** param {*} reportName 下载时候的标题* param {*} isDownload 是否下载默认为下载&#xff0c;传false不…

day05(单片机)SPI+数码管

目录 SPI数码管 SPI通信 SPI总线介绍 字节交换原理 时序单元 ​​​​​​​SPI模式 模式0 模式1 模式2 模式3 数码管 介绍 74HC595芯片分析 ​​​​​​​原理图分析 ​​​​​​​cubeMX配置​​​​​​​ 程序编写 硬件SPI ​​​​​​​软件SPI 作业&#xff1a; SPI数…

越学越爽!4小时从零入门大模型教程,2024最详细的学习路线,让你少走99%弯路!(大模型/LLM/Agent/提示工程)

第一阶段&#xff1a;基础理论入门 目标&#xff1a;了解大模型的基本概念和背景。 内容&#xff1a; 人工智能演进与大模型兴起。 大模型定义及通用人工智能定义。 GPT模型的发展历程。 第二阶段&#xff1a;核心技术解析 目标&#xff1a;深入学习大模型的关键技术和工…