From 9ad64521d39e722b74379cc33c78de4cd0b426b3 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子Li <15040126243@163.com>
Date: 星期三, 18 十二月 2024 17:46:53 +0800
Subject: [PATCH] update 优化 !pr_610 代码实现
---
ruoyi-modules/ruoyi-demo/src/main/java/org/dromara/demo/domain/vo/TestDemoVo.java | 7 +
ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/handler/DataWriteHandler.java | 62 +++++++++++++++
ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/utils/ExcelUtil.java | 118 +++--------------------------
3 files changed, 81 insertions(+), 106 deletions(-)
diff --git a/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/handler/DataWriteHandler.java b/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/handler/DataWriteHandler.java
index 0d11360..a2aa495 100644
--- a/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/handler/DataWriteHandler.java
+++ b/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/handler/DataWriteHandler.java
@@ -10,11 +10,15 @@
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.style.WriteCellStyle;
import com.alibaba.excel.write.metadata.style.WriteFont;
-import lombok.Data;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;
+import org.dromara.common.core.utils.reflect.ReflectUtils;
+import org.dromara.common.excel.annotation.ExcelNotation;
+import org.dromara.common.excel.annotation.ExcelRequired;
+import java.lang.reflect.Field;
+import java.util.HashMap;
import java.util.Map;
/**
@@ -22,7 +26,6 @@
*
* @author guzhouyanyu
*/
-@Data
public class DataWriteHandler implements SheetWriteHandler, CellWriteHandler {
/**
@@ -36,8 +39,16 @@
private final Map<Integer, Short> headColumnMap;
+ public DataWriteHandler(Class<?> clazz) {
+ notationMap = getNotationMap(clazz);
+ headColumnMap = getRequiredMap(clazz);
+ }
+
@Override
public void afterCellDispose(CellWriteHandlerContext context) {
+ if (CollUtil.isEmpty(notationMap) && CollUtil.isEmpty(headColumnMap)) {
+ return;
+ }
WriteCellData<?> cellData = context.getFirstCellData();
WriteCellStyle writeCellStyle = cellData.getOrCreateStyle();
@@ -74,4 +85,51 @@
}
}
}
+
+ /**
+ * 鑾峰彇蹇呭～鍒�
+ */
+ private static Map<Integer, Short> getRequiredMap(Class<?> clazz) {
+ Map<Integer, Short> requiredMap = new HashMap<>();
+ Field[] fields = clazz.getDeclaredFields();
+ // 妫�鏌� fields 鏁扮粍鏄惁涓虹┖
+ if (fields.length == 0) {
+ return requiredMap;
+ }
+ Field[] filteredFields = ReflectUtils.getFields(clazz, field -> !"serialVersionUID".equals(field.getName()));
+
+ for (int i = 0; i < filteredFields.length; i++) {
+ Field field = filteredFields[i];
+ if (!field.isAnnotationPresent(ExcelRequired.class)) {
+ continue;
+ }
+ ExcelRequired excelRequired = field.getAnnotation(ExcelRequired.class);
+ int columnIndex = excelRequired.index() == -1 ? i : excelRequired.index();
+ requiredMap.put(columnIndex, excelRequired.fontColor().getIndex());
+ }
+ return requiredMap;
+ }
+
+ /**
+ * 鑾峰彇鎵规敞
+ */
+ private static Map<Integer, String> getNotationMap(Class<?> clazz) {
+ Map<Integer, String> notationMap = new HashMap<>();
+ Field[] fields = clazz.getDeclaredFields();
+ // 妫�鏌� fields 鏁扮粍鏄惁涓虹┖
+ if (fields.length == 0) {
+ return notationMap;
+ }
+ Field[] filteredFields = ReflectUtils.getFields(clazz, field -> !"serialVersionUID".equals(field.getName()));
+ for (int i = 0; i < filteredFields.length; i++) {
+ Field field = filteredFields[i];
+ if (!field.isAnnotationPresent(ExcelNotation.class)) {
+ continue;
+ }
+ ExcelNotation excelNotation = field.getAnnotation(ExcelNotation.class);
+ int columnIndex = excelNotation.index() == -1 ? i : excelNotation.index();
+ notationMap.put(columnIndex, excelNotation.value());
+ }
+ return notationMap;
+ }
}
diff --git a/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/utils/ExcelUtil.java b/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/utils/ExcelUtil.java
index fa1fb90..856699a 100644
--- a/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/utils/ExcelUtil.java
+++ b/ruoyi-common/ruoyi-common-excel/src/main/java/org/dromara/common/excel/utils/ExcelUtil.java
@@ -16,9 +16,6 @@
import lombok.NoArgsConstructor;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.core.utils.file.FileUtils;
-import org.dromara.common.core.utils.reflect.ReflectUtils;
-import org.dromara.common.excel.annotation.ExcelNotation;
-import org.dromara.common.excel.annotation.ExcelRequired;
import org.dromara.common.excel.convert.ExcelBigNumberConvert;
import org.dromara.common.excel.core.*;
import org.dromara.common.excel.handler.DataWriteHandler;
@@ -27,9 +24,7 @@
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
-import java.lang.reflect.Field;
import java.util.Collection;
-import java.util.HashMap;
import java.util.List;
import java.util.Map;
@@ -197,6 +192,7 @@
.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
// 澶ф暟鍊艰嚜鍔ㄨ浆鎹� 闃叉澶辩湡
.registerConverter(new ExcelBigNumberConvert())
+ .registerWriteHandler(new DataWriteHandler(list.get(0).getClass()))
.sheet(sheetName);
if (merge) {
// 鍚堝苟澶勭悊鍣�
@@ -217,7 +213,7 @@
* @param data 妯℃澘闇�瑕佺殑鏁版嵁
* @param response 鍝嶅簲浣�
*/
- public static void exportTemplate(List<Object> data, String filename, String templatePath, HttpServletResponse response) {
+ public static <T> void exportTemplate(List<T> data, String filename, String templatePath, HttpServletResponse response) {
try {
resetResponse(filename, response);
ServletOutputStream os = response.getOutputStream();
@@ -236,20 +232,21 @@
* @param data 妯℃澘闇�瑕佺殑鏁版嵁
* @param os 杈撳嚭娴�
*/
- public static void exportTemplate(List<Object> data, String templatePath, OutputStream os) {
+ public static <T> void exportTemplate(List<T> data, String templatePath, OutputStream os) {
+ if (CollUtil.isEmpty(data)) {
+ throw new IllegalArgumentException("鏁版嵁涓虹┖");
+ }
ClassPathResource templateResource = new ClassPathResource(templatePath);
ExcelWriter excelWriter = EasyExcel.write(os)
.withTemplate(templateResource.getStream())
.autoCloseStream(false)
// 澶ф暟鍊艰嚜鍔ㄨ浆鎹� 闃叉澶辩湡
.registerConverter(new ExcelBigNumberConvert())
+ .registerWriteHandler(new DataWriteHandler(data.get(0).getClass()))
.build();
WriteSheet writeSheet = EasyExcel.writerSheet().build();
- if (CollUtil.isEmpty(data)) {
- throw new IllegalArgumentException("鏁版嵁涓虹┖");
- }
// 鍗曡〃澶氭暟鎹鍑� 妯℃澘鏍煎紡涓� {.灞炴�
- for (Object d : data) {
+ for (T d : data) {
excelWriter.fill(d, writeSheet);
}
excelWriter.finish();
@@ -305,6 +302,9 @@
* @param os 杈撳嚭娴�
*/
public static void exportTemplateMultiList(Map<String, Object> data, String templatePath, OutputStream os) {
+ if (CollUtil.isEmpty(data)) {
+ throw new IllegalArgumentException("鏁版嵁涓虹┖");
+ }
ClassPathResource templateResource = new ClassPathResource(templatePath);
ExcelWriter excelWriter = EasyExcel.write(os)
.withTemplate(templateResource.getStream())
@@ -313,9 +313,6 @@
.registerConverter(new ExcelBigNumberConvert())
.build();
WriteSheet writeSheet = EasyExcel.writerSheet().build();
- if (CollUtil.isEmpty(data)) {
- throw new IllegalArgumentException("鏁版嵁涓虹┖");
- }
for (Map.Entry<String, Object> map : data.entrySet()) {
// 璁剧疆鍒楄〃鍚庣画杩樻湁鏁版嵁
FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
@@ -339,6 +336,9 @@
* @param os 杈撳嚭娴�
*/
public static void exportTemplateMultiSheet(List<Map<String, Object>> data, String templatePath, OutputStream os) {
+ if (CollUtil.isEmpty(data)) {
+ throw new IllegalArgumentException("鏁版嵁涓虹┖");
+ }
ClassPathResource templateResource = new ClassPathResource(templatePath);
ExcelWriter excelWriter = EasyExcel.write(os)
.withTemplate(templateResource.getStream())
@@ -346,9 +346,6 @@
// 澶ф暟鍊艰嚜鍔ㄨ浆鎹� 闃叉澶辩湡
.registerConverter(new ExcelBigNumberConvert())
.build();
- if (CollUtil.isEmpty(data)) {
- throw new IllegalArgumentException("鏁版嵁涓虹┖");
- }
for (int i = 0; i < data.size(); i++) {
WriteSheet writeSheet = EasyExcel.writerSheet(i).build();
for (Map.Entry<String, Object> map : data.get(i).entrySet()) {
@@ -439,91 +436,4 @@
return IdUtil.fastSimpleUUID() + "_" + filename + ".xlsx";
}
- /**
- * 鑾峰彇蹇呭～鍒桵ap
- *
- * @param clazz 绫籧lass
- * @return java.util.Map<java.lang.Integer, java.lang.Short>
- * @author SunLingDa
- * @date 2022/11/3 13:23
- */
- private static Map<Integer, Short> getRequiredMap(Class<?> clazz) {
- Map<Integer, Short> requiredMap = new HashMap<>();
- Field[] fields = clazz.getDeclaredFields();
- // 妫�鏌� fields 鏁扮粍鏄惁涓虹┖
- if (fields.length == 0) {
- return requiredMap;
- }
- Field[] filteredFields = ReflectUtils.getFields(clazz, field -> !"serialVersionUID".equals(field.getName()));
-
- for (int i = 0; i < filteredFields.length; i++) {
- Field field = filteredFields[i];
- if (!field.isAnnotationPresent(ExcelRequired.class)) {
- continue;
- }
- ExcelRequired excelRequired = field.getAnnotation(ExcelRequired.class);
- int columnIndex = excelRequired.index() == -1 ? i : excelRequired.index();
- requiredMap.put(columnIndex, excelRequired.fontColor().getIndex());
- }
- return requiredMap;
- }
-
- /**
- * 鑾峰彇鎵规敞Map
- *
- * @param clazz 绫籧lass
- * @return java.util.Map<java.lang.Integer, java.lang.String>
- * @author SunLingDa
- * @date 2022/11/3 13:24
- */
- private static Map<Integer, String> getNotationMap(Class<?> clazz) {
- Map<Integer, String> notationMap = new HashMap<>();
- Field[] fields = clazz.getDeclaredFields();
- // 妫�鏌� fields 鏁扮粍鏄惁涓虹┖
- if (fields.length == 0) {
- return notationMap;
- }
- Field[] filteredFields = ReflectUtils.getFields(clazz, field -> !"serialVersionUID".equals(field.getName()));
- for (int i = 0; i < filteredFields.length; i++) {
- Field field = filteredFields[i];
- if (!field.isAnnotationPresent(ExcelNotation.class)) {
- continue;
- }
- ExcelNotation excelNotation = field.getAnnotation(ExcelNotation.class);
- int columnIndex = excelNotation.index() == -1 ? i : excelNotation.index();
- notationMap.put(columnIndex, excelNotation.value());
- }
- return notationMap;
- }
- public static <T> void exportExcelRequire(List<T> list, String sheetName, Class<T> clazz,HttpServletResponse response) {
- exportExcelTemplate(list,sheetName,clazz,response);
- }
- /**
- * 瀵煎嚭excel妯℃澘
- *
- * @param list 瀵煎嚭鏁版嵁闆嗗悎
- * @param sheetName 宸ヤ綔琛ㄧ殑鍚嶇О
- * @param clazz 瀹炰綋绫�
- * @param response 鍝嶅簲浣�
- */
- public static <T> void exportExcelTemplate(List<T> list, String sheetName, Class<T> clazz, HttpServletResponse response) {
- try {
- Map<Integer, Short> requiredMap = getRequiredMap(clazz);
- Map<Integer, String> notationMap = getNotationMap(clazz);
- resetResponse(sheetName, response);
- ServletOutputStream os = response.getOutputStream();
- DataWriteHandler writeHandler = new DataWriteHandler(notationMap, requiredMap);
- ExcelWriterSheetBuilder builder = EasyExcel.write(os, clazz)
- .autoCloseStream(false)
- // 鑷姩閫傞厤
- .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
- .registerWriteHandler(writeHandler)
- // 澶ф暟鍊艰嚜鍔ㄨ浆鎹� 闃叉澶辩湡
- .registerConverter(new ExcelBigNumberConvert())
- .sheet(sheetName);
- builder.doWrite(list);
- } catch (IOException e) {
- throw new RuntimeException("瀵煎嚭Excel寮傚父");
- }
- }
}
diff --git a/ruoyi-modules/ruoyi-demo/src/main/java/org/dromara/demo/domain/vo/TestDemoVo.java b/ruoyi-modules/ruoyi-demo/src/main/java/org/dromara/demo/domain/vo/TestDemoVo.java
index 016c2f7..e7ea807 100644
--- a/ruoyi-modules/ruoyi-demo/src/main/java/org/dromara/demo/domain/vo/TestDemoVo.java
+++ b/ruoyi-modules/ruoyi-demo/src/main/java/org/dromara/demo/domain/vo/TestDemoVo.java
@@ -2,6 +2,8 @@
import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
+import org.dromara.common.excel.annotation.ExcelNotation;
+import org.dromara.common.excel.annotation.ExcelRequired;
import org.dromara.common.translation.annotation.Translation;
import org.dromara.common.translation.constant.TransConstant;
import org.dromara.demo.domain.TestDemo;
@@ -36,30 +38,35 @@
/**
* 閮ㄩ棬id
*/
+ @ExcelRequired
@ExcelProperty(value = "閮ㄩ棬id")
private Long deptId;
/**
* 鐢ㄦ埛id
*/
+ @ExcelRequired
@ExcelProperty(value = "鐢ㄦ埛id")
private Long userId;
/**
* 鎺掑簭鍙�
*/
+ @ExcelRequired
@ExcelProperty(value = "鎺掑簭鍙�")
private Integer orderNum;
/**
* key閿�
*/
+ @ExcelNotation(value = "娴嬭瘯key")
@ExcelProperty(value = "key閿�")
private String testKey;
/**
* 鍊�
*/
+ @ExcelNotation(value = "娴嬭瘯value")
@ExcelProperty(value = "鍊�")
private String value;
--
Gitblit v1.9.3