实现 easyExcel 导入导出自定义字典转换器

已于 2023-10-10 21:07:36 修改
阅读量4.3k 收藏 12
点赞数 3
分类专栏： java程序实现 文章标签： java 数据库 开发语言
于 2023-09-09 18:32:19 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/demo_yo/article/details/132778472
版权

一、easyExcel 字典转换器 Converter

easyExcel 导入导出自定义字典转换器，包括导入字典转换以及导出字典转换。适配多个逗号分隔的字典值转换。

1、excel 导入字典转换注解

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

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

/**
 * excel导入字典转换注解
 * <p>
 * 将excel导入的字典label自动转换为字典code
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DictItemSerialize.class)
public @interface ExcelDictItemLabel {

	/**
	 * 字典type
	 */
	String type();

}

2、excel 导出字典转换注解

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

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

/**
 * excel导出字典转换注解
 * <p>
 * 将excel导出的字典code自动转换为字典label
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DictItemSerialize.class)
public @interface ExcelDictItem {

	/**
	 * 字典type
	 */
	String type();

}

3、自定义 excel 转换器

import cn.hutool.core.util.StrUtil;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
import com.whitemeen.magic.common.core.constant.CacheConstants;
import com.whitemeen.magic.common.core.constant.SecurityConstants;
import com.whitemeen.magic.common.core.util.R;
import com.whitemeen.magic.common.core.util.SpringContextHolder;
import com.whitemeen.magic.upms.modules.admin.api.entity.SysDictItem;
import com.whitemeen.magic.upms.modules.admin.api.feign.RemoteDictService;
import com.whitemeen.magic.upms.modules.admin.config.ExcelDictItem;
import com.whitemeen.magic.upms.modules.admin.config.ExcelDictItemLabel;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;

import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * Excel Converter字典转换器
 */
public class ExcelDictConverter implements Converter<String> {

	public ExcelDictConverter() {
	}

	@Override
	public Class supportJavaTypeKey() {
		return null;
	}

	@Override
	public CellDataTypeEnum supportExcelTypeKey() {
		return null;
	}

	/**
	 * 将excel单元格数据转换成对象属性值（适配多个逗号分隔的字典值）
	 *
	 * @param cellData             单元格的数据
	 * @param excelContentProperty excel每一行的数据内容
	 * @param globalConfiguration  global全局配置
	 * @return 转换后的对象属性值
	 * @throws Exception 异常
	 */
	@Override
	public String convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
		// 获取字典类型
		Field field = excelContentProperty.getField();
		ExcelDictItemLabel excel = field.getAnnotation(ExcelDictItemLabel.class);
		String dictType = excel.type();

		// 为空返回
		String dictLabel = cellData.getStringValue();
		if (StrUtil.isBlank(dictLabel)) {
			return dictLabel;
		}

		// 查询字典
		CacheManager cacheManager = SpringContextHolder.getBean(CacheManager.class);
		Cache dictCache = cacheManager.getCache(CacheConstants.DICT_DETAILS);
		R<List<SysDictItem>> dictItemListR = dictCache.get(dictType, R.class);

		if (dictItemListR == null) {
			RemoteDictService dictService = SpringContextHolder.getBean(RemoteDictService.class);
			dictItemListR = dictService.customize(dictType, SecurityConstants.FROM_IN);
		}
		if (dictItemListR == null || CollectionUtils.isEmpty(dictItemListR.getData())) {
			return dictLabel;
		}

		// 将字典项根据label分组
		Map<String, SysDictItem> dictItemLabelMap = dictItemListR.getData()
				.stream().collect(Collectors.toMap(SysDictItem::getLabel, Function.identity(), (v1, v2) -> v2));

		// 存在多个字典项值
		List<String> dictLabelList = Arrays.stream(dictLabel.split(",")).collect(Collectors.toList());
		StringBuilder dictValues = new StringBuilder();

		// 字典转换拼接
		for (String sourcesDictLabel : dictLabelList) {
			SysDictItem sysDictItem = dictItemLabelMap.get(sourcesDictLabel);
			if (sysDictItem == null) {
				continue;
			}

			if (StrUtil.isBlank(dictValues)) {
				dictValues.append(sysDictItem.getItemValue());
			} else {
				dictValues.append(",").append(sysDictItem.getItemValue());
			}
		}

		return String.valueOf(dictValues);
	}

	
//	/**
//	 * 将excel单元格数据转换成对象属性值（仅适配单个字典值）
//	 *
//	 * @param cellData             单元格的数据
//	 * @param excelContentProperty excel每一行的数据内容
//	 * @param globalConfiguration  global全局配置
//	 * @return 转换后的对象属性值
//	 * @throws Exception 异常
//	 */
//	@Override
//	public String convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
//		// 获取字典类型
//		Field field = excelContentProperty.getField();
//		ExcelDictItemLabel excel = field.getAnnotation(ExcelDictItemLabel.class);
//		String dictType = excel.type();
//
//		String dictLabel = cellData.getStringValue();
//		if (StrUtil.isBlank(dictLabel)) {
//			return dictLabel;
//		}
//		// 查询字典
//		RemoteDictService remoteDictService = SpringContextHolder.getBean(RemoteDictService.class);
//		R<List<SysDictItem>> dictItemsR = remoteDictService.getDictByType(dictType);
//		if (CollectionUtil.isEmpty(dictItemsR.getData())) {
//			return dictLabel;
//		}
//		// 进行字典翻译
//		String javaData = dictLabel;
//		List<SysDictItem> dictItems = dictItemsR.getData();
//		for (SysDictItem dictItem : dictItems) {
//			if (StrUtil.equals(dictLabel, dictItem.getLabel())) {
//				javaData = dictItem.getItemValue();
//				break;
//			}
//		}
//		return javaData;
//	}

	/**
	 * 将对象属性值转换成excel单元格数据（适配多个逗号分隔的字典值）
	 *
	 * @param dictValue            对象的属性值
	 * @param excelContentProperty excel每一行的数据内容
	 * @param globalConfiguration  global全局配置
	 * @return 转换后的对象属性值
	 * @throws Exception 异常
	 */
	@Override
	public CellData convertToExcelData(String dictValue, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
		// 获取字典类型
		Field field = excelContentProperty.getField();
		ExcelDictItem excel = field.getAnnotation(ExcelDictItem.class);
		String dictType = excel.type();

		// 为空返回
		if (StrUtil.isBlank(dictValue)) {
			return new CellData(dictValue);
		}

		// 查询字典
		CacheManager cacheManager = SpringContextHolder.getBean(CacheManager.class);
		Cache dictCache = cacheManager.getCache(CacheConstants.DICT_DETAILS);
		R<List<SysDictItem>> dictItemListR = dictCache.get(dictType, R.class);

		if (dictItemListR == null) {
			RemoteDictService dictService = SpringContextHolder.getBean(RemoteDictService.class);
			dictItemListR = dictService.customize(dictType, SecurityConstants.FROM_IN);
		}
		if (dictItemListR == null || CollectionUtils.isEmpty(dictItemListR.getData())) {
			return new CellData(dictValue);
		}

		// 将字典项根据value分组
		Map<String, SysDictItem> dictItemValueMap = dictItemListR.getData()
				.stream().collect(Collectors.toMap(SysDictItem::getItemValue, Function.identity(), (v1, v2) -> v2));

		// 存在多个字典项值
		List<String> dictValueList = Arrays.stream(dictValue.split(",")).collect(Collectors.toList());
		StringBuilder dictLabels = new StringBuilder();

		// 字典转换拼接
		for (String sourcesDictLabel : dictValueList) {
			SysDictItem sysDictItem = dictItemValueMap.get(sourcesDictLabel);
			if (sysDictItem == null) {
				continue;
			}

			if (StrUtil.isBlank(dictLabels)) {
				dictLabels.append(sysDictItem.getLabel());
			} else {
				dictLabels.append(",").append(sysDictItem.getLabel());
			}
		}

		if(StrUtil.isBlank(String.valueOf(dictLabels))){
			return new CellData(dictValue);
		}
		return new CellData(String.valueOf(dictLabels));
	}
	
//	/**
//	 * 将对象属性值转换成excel单元格数据（仅适配单个字典值）
//	 *
//	 * @param dictValue            对象的属性值
//	 * @param excelContentProperty excel每一行的数据内容
//	 * @param globalConfiguration  global全局配置
//	 * @return 转换后的对象属性值
//	 * @throws Exception 异常
//	 */
//	@Override
//	public CellData convertToExcelData(String dictValue, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
//		// 获取字典类型
//		Field field = excelContentProperty.getField();
//		String fieldName = field.getName();
//		DictItem excel = field.getAnnotation(DictItem.class);
//		String dictType = excel.type();
//		// 查询字典
//		RemoteDictService remoteDictService = SpringContextHolder.getBean(RemoteDictService.class);
//		R<List<SysDictItem>> dictItemsR = remoteDictService.getDictByType(dictType);
//		if (CollectionUtil.isEmpty(dictItemsR.getData())) {
//			return new CellData(dictValue);
//		}
//		// 进行字典翻译
//		String excelData = dictValue;
//		List<SysDictItem> dictItems = dictItemsR.getData();
//		for (SysDictItem dictItem : dictItems) {
//			if (StrUtil.equals(dictValue, dictItem.getItemValue())) {
//				excelData = dictItem.getLabel();
//				break;
//			}
//		}
//		return new CellData(excelData);
//	}

}

4、使用 excel 字典转换注解


	/**
	 * 性别label（用于接收与展现真实的excel内容）
	 */
	@ExcelProperty(value = "性别", converter = ExcelDictConverter.class)
	@ExcelDictItemLabel(type = "gender")
	private String genderLabel;

	/**
	 * 性别code（用来承载java对象属性值）
	 */
	@ExcelIgnore
	@ExcelDictItem(type = "gender")
	private String gender;
Whitemeen太白
关注
  • 3
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
自定义全局类型转换器
04-04
NULL 博文链接：https://1028826685.iteye.com/blog/1506380
EasyExcel导入excel和导出excel的demo
02-07
springboot集成easyexcel做的导入导出demo，下载即可运行。
Java中easyExcel框架字段转换具体实现（根据数据字典转换），对注解@ExcelProperty中converter的具体使用
weixin_54566947的博客
03-04 2894
/ DictValue是类型的具体代表（0,1,2），value是字段下的当时的属性值。//value是注解下字段的属性的具体值（性别字段的0,1），contentProperty框架封装的类。// 不能用注入的方式注入spring管理类，需要使用spring的工厂获取管理类。// 取出具体的 性别(0 女 1 男 2 未知)并赋值。// 我这边传入的数据字典类型用的数组传入。//最后转换的格式的String的。
EasyExcel 自定义LocalDate类型转换器Converter
热门推荐
旭东怪的博客
07-30 1万+
1 Maven依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.8</version> </dependency> 2 LocalDateConverter Loc
EasyExcel 字典转换 BaseDictConverter
最新发布
weixin_41256727的博客
04-29 401
EasyExcel字典值导入\导出转换
【RuoYi-Vue-Plus】学习笔记 49 - Easy Excel（三）自定义转换器 ExcelDictConvert 源码分析
MichelleChung的星球
03-08 2440
简单分析自定义字典类型转换器 ExcelDictConvert。
关于EasyExcel 优化，实现格式自定义，数据字典自动转化。
ssp584731180的博客
09-05 4168
1.下载模板，添加模板说明sheet2. 2.导入数据，对数据进行校验，对模板进行检验，并将校验结果展示给用户。 3.导出数据，可选导出字段4.字典数据自动转化， 4.导入/导出操作方式：添加一个注解即可。
EasyExcel详解（结合官方文档）
Bananaaay的博客
12-27 1万+
EasyExcel的学习分享
【java学习】EasyExcel的简单使用
hermit_f的博客
09-14 1万+
EasyExcel类是一套基于Java的开源Excel解析工具类，相较于传统的框架如Apache poi、jxl等更加快速、简洁，还可以解决大文件内存溢出问题，即能让使用者在不用考虑性能、内存的等因素的情况下，快速完成Excel的读（导入）、写（导出）等功能。这里使用的EasyExcel版本为3.1.1，JDK版本为1.8.0_161，同时辅助使用lombok和fastjson以简化代码或转化为Jason数据。
史上最全EasyExcel
豆豆的博客
01-19 4893
1、数据导入：减轻录入工作量2、数据导出：统计信息归档3、数据传输：异构系统之间数据传输。
EasyExcel 自定义类型转换器
weixin_45535519的博客
04-21 2612
EasyExcel 自定义类型转换器
ConvertCustomDictionaries:转换自定义字典
06-15
转换自定义字典 转换自定义字典 java -jar ConvertCustomDictionaries-1.0-SNAPSHOT-jar-with-dependencies.jar ctakes-resources-3.1.0/resources/org/apache/ctakes/dictionary/lookup/rxnorm_index out.txt
java使用EasyExcel导入导出excel（csdn）————程序.pdf
12-01
使用这些注解，开发者可以方便地定义Excel的样式和数据结构，实现自定义的导入导出功能。例如，可以使用`@ExcelProperty`注解在实体类的属性上，然后通过EasyExcel的API读取或写入Excel文件，实现数据的交换。 三、...
easyexcel+validation excel导入导出下载
01-19
使用esayexcel作为excel导入导出工具代码 validation 作为excel内容校验 可运行，内置模板文件
Spring Boot使用EasyExcel导入导出Excel
12-13
Spring Boot使用EasyExcel导入导出Excel
EasyExcel导出字典动态转换
qq_34873006的博客
04-09 372
EasyExcel
easyexcel实现根据字典单表导出
Pikoan的博客
06-05 1430
重写了convertToExcelData()方法，利用反射，拿到导出VO里@DictFormat中的值，由于数据库存放的为字典的键，便可根据这个值找到对应的字典，拿到对应的字典值，且考虑存放数据库的有可能是字符串类型的JSON数组，在进行键值转换的时候也需要判断是否为数组，循环并将其字典转换，拼接成String再将其返回。可以看到在导出的接收类里，我们给属性贴上的注解不再是@ApiModelProperty，变成了@ExcelProperty，这是easyexcel导出读操作的一个注解。
Alibaba EasyExcel介绍和简单使用
m0_62946761的博客
03-24 7601
学习Alibaba EasyExcel的简单使用
用java实现easyexcel导入导出
06-03
以下是使用 Java 实现 EasyExcel 导入导出的示例代码： 1. 引入 EasyExcel 依赖： ```xml <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.7</version> </dependency> ``` 2. 定义 Excel 数据模型： ```java public class User { @ExcelProperty("姓名") private String name; @ExcelProperty("年龄") private Integer age; // 省略 getter 和 setter 方法 } ``` 3. 编写 Excel 数据读取代码： ```java public void readExcel(File excelFile) { EasyExcel.read(excelFile, User.class, new AnalysisEventListener<User>() { @Override public void invoke(User user, AnalysisContext analysisContext) { // 处理读取到的数据 System.out.println(user); } @Override public void doAfterAllAnalysed(AnalysisContext analysisContext) { // 读取完毕后的操作 } }).sheet().doRead(); } ``` 4. 编写 Excel 数据写入代码： ```java public void writeExcel(File excelFile, List<User> userList) { EasyExcel.write(excelFile, User.class).sheet().doWrite(userList); } ``` 5. 配置 Excel 文件的格式： 可以使用注解或配置文件来设置 Excel 文件的格式，例如： ```java public class User { @ExcelProperty(value = "姓名", index = 0) private String name; @ExcelProperty(value = "年龄", index = 1) @ColumnWidth(15) private Integer age; // 省略 getter 和 setter 方法 } ``` 6. 执行导入导出操作： ```java File excelFile = new File("test.xlsx"); // 读取 Excel 文件 readExcel(excelFile); // 写入 Excel 文件 List<User> userList = new ArrayList<>(); userList.add(new User("张三", 20)); userList.add(new User("李四", 25)); writeExcel(excelFile, userList); ``` 总的来说，使用 EasyExcel 进行 Excel 文件的导入导出操作非常简单，只需要几行代码即可完成。同时，EasyExcel 还提供了丰富的 API，可以满足不同场景下的需求。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Whitemeen太白

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值