add 增加 easyexcel 工具类

ruoyi-common/src/main/java/com/ruoyi/common/annotation/ExcelDictFormat.java

@@ -0,0 +1,30 @@
+package com.ruoyi.common.annotation;
+
+import java.lang.annotation.*;
+
+/**
+ * 字典格式化
+ *
+ * @author Lion Li
+ */
+@Target({ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface ExcelDictFormat {
+
+	/**
+	 * 如果是字典类型，请设置字典的type值 (如: sys_user_sex)
+	 */
+	String dictType() default "";
+
+	/**
+	 * 读取内容转表达式 (如: 0=男,1=女,2=未知)
+	 */
+	String readConverterExp() default "";
+
+	/**
+	 * 分隔符，读取字符串组内容
+	 */
+	String separator() default ",";
+
+}

ruoyi-common/src/main/java/com/ruoyi/common/convert/ExcelDictConvert.java

@@ -0,0 +1,69 @@
+package com.ruoyi.common.convert;
+
+import cn.hutool.core.annotation.AnnotationUtil;
+import cn.hutool.core.convert.Convert;
+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.ruoyi.common.annotation.ExcelDictFormat;
+import com.ruoyi.common.utils.StringUtils;
+import com.ruoyi.common.utils.poi.ExcelUtils;
+import lombok.extern.slf4j.Slf4j;
+
+import java.lang.reflect.Field;
+
+/**
+ * 字典格式化转换处理
+ *
+ * @author Lion Li
+ */
+@Slf4j
+public class ExcelDictConvert implements Converter<Object> {
+
+	@Override
+	public Class<Object> supportJavaTypeKey() {
+		return Object.class;
+	}
+
+	@Override
+	public CellDataTypeEnum supportExcelTypeKey() {
+		return null;
+	}
+
+	@Override
+	public Object convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
+		ExcelDictFormat anno = getAnnotation(contentProperty.getField());
+		String type = anno.dictType();
+		String label = cellData.getStringValue();
+		String value;
+		if (StringUtils.isBlank(type)) {
+			value = ExcelUtils.reverseByExp(label, anno.readConverterExp(), anno.separator());
+		} else {
+			value = ExcelUtils.reverseDictByExp(label, type, anno.separator());
+		}
+		return Convert.convert(contentProperty.getField().getType(), value);
+	}
+
+	@Override
+	public CellData<String> convertToExcelData(Object object, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
+		if (StringUtils.isNull(object)) {
+			return new CellData<>("");
+		}
+		ExcelDictFormat anno = getAnnotation(contentProperty.getField());
+		String type = anno.dictType();
+		String value = Convert.toStr(object);
+		String label;
+		if (StringUtils.isBlank(type)) {
+			label = ExcelUtils.convertByExp(value, anno.readConverterExp(), anno.separator());
+		} else {
+			label = ExcelUtils.convertDictByExp(value, type, anno.separator());
+		}
+		return new CellData<>(label);
+	}
+
+	private ExcelDictFormat getAnnotation(Field field) {
+		return AnnotationUtil.getAnnotation(field, ExcelDictFormat.class);
+	}
+}

ruoyi-common/src/main/java/com/ruoyi/common/utils/poi/ExcelUtils.java

@@ -0,0 +1,150 @@
+package com.ruoyi.common.utils.poi;
+
+import cn.hutool.core.util.IdUtil;
+import com.alibaba.excel.EasyExcel;
+import com.alibaba.excel.write.style.column.LongestMatchColumnWidthStyleStrategy;
+import com.ruoyi.common.utils.DictUtils;
+import com.ruoyi.common.utils.StringUtils;
+import com.ruoyi.common.utils.file.FileUtils;
+
+import javax.servlet.ServletOutputStream;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+/**
+ * Excel相关处理
+ *
+ * @author ruoyi
+ */
+public class ExcelUtils {
+
+	/**
+	 * 对excel表单默认第一个索引名转换成list（EasyExcel）
+	 *
+	 * @param is 输入流
+	 * @return 转换后集合
+	 */
+	public static <T> List<T> importExcel(InputStream is, Class<T> clazz) {
+		return EasyExcel.read(is).head(clazz).sheet().doReadSync();
+	}
+
+	/**
+	 * 对list数据源将其里面的数据导入到excel表单（EasyExcel）
+	 *
+	 * @param list      导出数据集合
+	 * @param sheetName 工作表的名称
+	 * @return 结果
+	 */
+	public static <T> void exportExcel(List<T> list, String sheetName, Class<T> clazz, HttpServletResponse response) {
+		try {
+			String filename = encodingFilename(sheetName);
+			response.reset();
+			response.addHeader("Access-Control-Allow-Origin", "*");
+			response.addHeader("Access-Control-Expose-Headers", "Content-Disposition");
+			FileUtils.setAttachmentResponseHeader(response, URLEncoder.encode(filename, StandardCharsets.UTF_8.toString()));
+			response.setContentType("application/vnd.ms-excel;charset=UTF-8");
+			ServletOutputStream os = response.getOutputStream();
+			EasyExcel.write(os, clazz)
+				.autoCloseStream(false)
+				// 自动适配
+				.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
+				.sheet(sheetName).doWrite(list);
+		} catch (IOException e) {
+			throw new RuntimeException("导出Excel异常");
+		}
+	}
+
+	/**
+	 * 解析导出值 0=男,1=女,2=未知
+	 *
+	 * @param propertyValue 参数值
+	 * @param converterExp  翻译注解
+	 * @param separator     分隔符
+	 * @return 解析后值
+	 */
+	public static String convertByExp(String propertyValue, String converterExp, String separator) {
+		StringBuilder propertyString = new StringBuilder();
+		String[] convertSource = converterExp.split(",");
+		for (String item : convertSource) {
+			String[] itemArray = item.split("=");
+			if (StringUtils.containsAny(separator, propertyValue)) {
+				for (String value : propertyValue.split(separator)) {
+					if (itemArray[0].equals(value)) {
+						propertyString.append(itemArray[1] + separator);
+						break;
+					}
+				}
+			} else {
+				if (itemArray[0].equals(propertyValue)) {
+					return itemArray[1];
+				}
+			}
+		}
+		return StringUtils.stripEnd(propertyString.toString(), separator);
+	}
+
+	/**
+	 * 反向解析值 男=0,女=1,未知=2
+	 *
+	 * @param propertyValue 参数值
+	 * @param converterExp  翻译注解
+	 * @param separator     分隔符
+	 * @return 解析后值
+	 */
+	public static String reverseByExp(String propertyValue, String converterExp, String separator) {
+		StringBuilder propertyString = new StringBuilder();
+		String[] convertSource = converterExp.split(",");
+		for (String item : convertSource) {
+			String[] itemArray = item.split("=");
+			if (StringUtils.containsAny(separator, propertyValue)) {
+				for (String value : propertyValue.split(separator)) {
+					if (itemArray[1].equals(value)) {
+						propertyString.append(itemArray[0] + separator);
+						break;
+					}
+				}
+			} else {
+				if (itemArray[1].equals(propertyValue)) {
+					return itemArray[0];
+				}
+			}
+		}
+		return StringUtils.stripEnd(propertyString.toString(), separator);
+	}
+
+	/**
+	 * 解析字典值
+	 *
+	 * @param dictValue 字典值
+	 * @param dictType  字典类型
+	 * @param separator 分隔符
+	 * @return 字典标签
+	 */
+	public static String convertDictByExp(String dictValue, String dictType, String separator) {
+		return DictUtils.getDictLabel(dictType, dictValue, separator);
+	}
+
+	/**
+	 * 反向解析值字典值
+	 *
+	 * @param dictLabel 字典标签
+	 * @param dictType  字典类型
+	 * @param separator 分隔符
+	 * @return 字典值
+	 */
+	public static String reverseDictByExp(String dictLabel, String dictType, String separator) {
+		return DictUtils.getDictValue(dictType, dictLabel, separator);
+	}
+
+	/**
+	 * 编码文件名
+	 */
+	public static String encodingFilename(String filename) {
+		return IdUtil.fastSimpleUUID() + "_" + filename + ".xlsx";
+	}
+
+}