mybatis-plus 罗列实现模版，导入，导出

基于上一篇的罗列利用扩展一下
1.导出模版
excel类

2. package sjgjtask.databasetest.util;
4. import cn.hutool.core.collection.CollUtil;
5. import com.alibaba.excel.EasyExcelFactory;
6. import com.alibaba.excel.annotation.ExcelProperty;
7. import com.alibaba.excel.write.builder.ExcelWriterBuilder;
8. import com.alibaba.excel.write.style.column.LongestMatchColumnWidthStyleStrategy;
9. import org.springframework.http.HttpHeaders;
11. import javax.servlet.http.HttpServletResponse;
12. import java.io.IOException;
13. import java.lang.reflect.Field;
14. import java.net.URLEncoder;
15. import java.nio.charset.StandardCharsets;
16. import java.util.ArrayList;
17. import java.util.Arrays;
18. import java.util.List;
19. import java.util.stream.Collectors;
21. public class ExcelUtil {
23.     /**
24.      * 通过class获取实体类中ExcelProperty注解设置的excel表头名称
25.      *
26.      * @param clazz
27.      * @return
28.      */
29.     public static List<String> getExcelHeadListByEntityExcelProperty(Class clazz) {
30.         List<String> result = new ArrayList<>();
31.         //获取类中所有的属性
32.         for (Field declaredField : clazz.getDeclaredFields()) {
33.             declaredField.setAccessible(true);
35.             //获取根据注解的方式获取ExcelProperty修饰的字段
36.             ExcelProperty excelProperty = declaredField.getAnnotation(ExcelProperty.class);
37.             if (excelProperty != null) {
38.                 String[] values = excelProperty.value();
39.                 StringBuilder value = new StringBuilder();
40.                 for (String s : values) {
41.                     value.append(s);
42.                 }
43.                 result.add(value.toString());
44.             }
45.         }
46.         return result;
47.     }
49.     public static <T> void templateExport(HttpServletResponse response, String name, Class<T> clazz) throws IOException {
50.         templateExport(response, name + "导入模板", clazz, null);
51.     }
53.     public static <T> void templateExport(HttpServletResponse response, String name, Class<T> clazz, List<T> dataList) throws IOException {
54.         if (CollUtil.isEmpty(dataList)) {
55.             dataList = new ArrayList<>();
56.         }
57.         Field[] fields = clazz.getDeclaredFields();
58.         List<SelectItem> selectItemData = new ArrayList<>();
59.         int excelIndex = 0;
60.         for (int i = 0; i < fields.length; i++) {
61.             Field field = fields[i];
62.             field.setAccessible(true);
63.             if (field.isAnnotationPresent(ExcelProperty.class)) {
64.                 excelIndex++;
65.                 // 确保 fieldType 是 Enum 类型并且实现了 IBaseEnum 接口
66.                 Class<?> fieldType = field.getType();
67.                 if (!isImplementingInterface(fieldType, IBaseEnum.class)) {
68.                     continue;
69.                 }
70.                 @SuppressWarnings("unchecked")
71.                 Class<? extends IBaseEnum<?>> enumType = (Class<? extends IBaseEnum<?>>) fieldType;
72.                 IBaseEnum<?>[] enums = enumType.getEnumConstants();
74.                 if (enums != null) {
75.                     selectItemData = new ArrayList<>();
76.                     SelectItem selectItem = new SelectItem(excelIndex - 1);
77.                     List<String> enumMessages = Arrays.stream(enums)
78.                             .map(enumObject -> enumObject.getMessage().toString())
79.                             .collect(Collectors.toList());
80.                     selectItem.addDataItem(enumMessages);
81.                     selectItemData.add(selectItem);
82.                 }
83.             }
84.         }
85. //        if (selectItemData.size() > 0) {
86. //            selectWriteHandler = new SelectWriteHandler(selectItemData);
87. //        }
88.         response.setContentType("application/octet-stream");
89.         response.addHeader(HttpHeaders.CONTENT_DISPOSITION, String.format("attachment;filename*=%s", URLEncoder.encode(name, StandardCharsets.UTF_8.toString()) + ".xlsx"));
90.         // 下拉框数据
91.         ExcelWriterBuilder excelWriterBuilder = EasyExcelFactory.write(response.getOutputStream(), clazz).inMemory(Boolean.TRUE)
92.                 .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
93.                 .registerWriteHandler(new SheetHeaderCommentWriteHandler(clazz));
94.         if (!selectItemData.isEmpty()) {
95.             excelWriterBuilder.registerWriteHandler(new SelectWriteHandler(selectItemData));
96.         }
97.         excelWriterBuilder.sheet(name + "配置数据").doWrite(dataList);
98.     }
100.     public static <T> void export(HttpServletResponse response, String name, List<T> dataList) throws IOException {
101.         if (CollUtil.isEmpty(dataList)) {
102.             throw new IOException("无数据");
103.         }
104.         Class<T> t = (Class<T>) dataList.get(0).getClass();
105.         templateExport(response, name, t, dataList);
106.     }
108.     private static boolean isImplementingInterface(Class<?> clazz, Class<?> interfaceClass) {
109.         if (clazz == null || interfaceClass == null || !interfaceClass.isInterface()) {
110.             return false;
111.         }
112.         // 检查当前类是否实现了接口
113.         if (Arrays.asList(clazz.getInterfaces()).contains(interfaceClass)) {
114.             return true;
115.         }
116.         // 递归检查父类
117.         return clazz.getSuperclass() != null && isImplementingInterface(clazz.getSuperclass(), interfaceClass);
118.     }
120. }

复制代码

罗列下拉框类

2. package sjgjtask.databasetest.util;
4. import cn.hutool.core.lang.Assert;
5. import lombok.Data;
7. import java.util.ArrayList;
8. import java.util.List;
9. import java.util.UUID;
11. /**
12. * excel下拉框数据项
13. */
14. @Data
15. public class SelectItem {
17.     /**
18.      * 下拉框所在列的索引，从0开始
19.      */
20.     private Integer columnIndex;
21.     /**
22.      * 下拉框的值列表
23.      */
24.     private List<DataItem> dataItems;
25.     /**
26.      * 子级对应的下拉框数据
27.      */
28.     private SelectItem subSelect;
30.     public SelectItem(Integer columnIndex) {
31.         this.columnIndex = columnIndex;
32.     }
34.     public void addDataItem(List<String> values) {
35.         this.addDataItem("_" + UUID.randomUUID().toString().replaceAll("-", ""), values);
36.     }
38.     public void addDataItem(String mappingKey, List<String> values) {
39.         if (this.dataItems == null) {
40.             this.dataItems = new ArrayList<>();
41.         }
42.         this.dataItems.add(new DataItem(mappingKey, values));
43.     }
45.     @Data
46.     public static class DataItem {
47.         /**
48.          * 关联上级的key
49.          */
50.         private String mappingKey;
51.         /**
52.          * 当前下拉框的值
53.          */
54.         private List<String> values;
55.         /**
56.          * 当前下拉框的引用，隐藏页单元格地址
57.          */
58.         private String hiddenFormulaRef;
60.         public DataItem(String mappingKey, List<String> values) {
61.             Assert.notBlank(mappingKey, "mappingKey is not blank");
62.             Assert.notEmpty(values, "values is not empty");
63.             this.mappingKey = mappingKey;
64.             this.values = values;
65.         }
66.     }
68. }

复制代码

下拉框填写类

2. package sjgjtask.databasetest.util;
4. import cn.hutool.core.lang.Assert;
5. import com.alibaba.excel.write.handler.CellWriteHandler;
6. import com.alibaba.excel.write.handler.SheetWriteHandler;
7. import com.alibaba.excel.write.handler.context.CellWriteHandlerContext;
8. import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
9. import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
10. import com.alibaba.excel.write.metadata.style.WriteFont;
11. import org.apache.poi.ss.usermodel.*;
12. import org.apache.poi.ss.util.CellRangeAddressList;
13. import org.apache.poi.ss.util.CellReference;
15. import java.util.HashSet;
16. import java.util.List;
17. import java.util.Set;
19. public class SelectWriteHandler implements SheetWriteHandler, CellWriteHandler {
21.     // 下拉框从哪一行结束
22.     private static final int ROW_SIZE = 10000;
23.     // 红色字体
24.     private final WriteFont redFont;
25.     // 下拉框数据
26.     private final List<SelectItem> selectItems;
27.     // 下拉框数据隐藏sheet名称
28.     private final String HIDDEN_SHEET_NAME = "hidden_sheet";
29.     // 拉框所在列的索引，从0开始
30.     private final Set<Integer> selectColumns = new HashSet<>();
32.     private boolean isLoadSelectColumns = false;
34.     private int rowIndex = 0;
36.     public SelectWriteHandler(List<SelectItem> selectItems) {
37.         Assert.notEmpty(selectItems, "selectItems can not be empty");
38.         this.selectItems = selectItems;
39.         redFont = getRedFont();
40.     }
42.     @Override
43.     public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
44.         Workbook workbook = writeWorkbookHolder.getWorkbook();
45.         Sheet hiddenSheet = workbook.getSheet(HIDDEN_SHEET_NAME);
46.         if (hiddenSheet != null) {
47.             return;
48.         }
49.         hiddenSheet = workbook.createSheet(HIDDEN_SHEET_NAME);
50.         workbook.setSheetHidden(workbook.getSheetIndex(hiddenSheet), true);
51.         Sheet sheet = writeSheetHolder.getSheet();
52.         for (SelectItem selectItem : selectItems) {
53.             buildHiddenSheetSelectRef(workbook, sheet, hiddenSheet, selectItem, null);
54.         }
55.         if (!isLoadSelectColumns) {
56.             isLoadSelectColumns = true;
57.         }
58.     }
60.     private void buildHiddenSheetSelectRef(Workbook workbook, Sheet sheet, Sheet hiddenSheet, SelectItem selectItem, String formulaRef) {
61.         if (!isLoadSelectColumns) {
62.             selectColumns.add(selectItem.getColumnIndex());
63.         }
64.         List<SelectItem.DataItem> dataItems = selectItem.getDataItems();
65.         for (SelectItem.DataItem dataItem : dataItems) {
66.             setDataAndName(workbook, hiddenSheet, dataItem);
67.         }
68.         // 单元格地址引用
69.         if (formulaRef == null || formulaRef.isEmpty()) {
70.             formulaRef = dataItems.get(0).getHiddenFormulaRef();
71.         }
72.         // 创建检验器
73.         DataValidation dataValidation = getDataValidation(sheet, selectItem, formulaRef);
74.         sheet.addValidationData(dataValidation);
75.         SelectItem subSelect = selectItem.getSubSelect();
76.         if (subSelect != null) {
77.             buildHiddenSheetSelectRef(workbook, sheet, hiddenSheet, subSelect, getInDirectFormulaRef(selectItem.getColumnIndex()));
78.         }
79.     }
81.     private DataValidation getDataValidation(Sheet sheet, SelectItem selectItem, String formulaRef) {
82.         DataValidationHelper helper = sheet.getDataValidationHelper();
83.         DataValidationConstraint constraint = helper.createFormulaListConstraint(formulaRef);
84.         CellRangeAddressList rangeAddressList = new CellRangeAddressList(1, ROW_SIZE, selectItem.getColumnIndex(), selectItem.getColumnIndex());
85.         DataValidation dataValidation = helper.createValidation(constraint, rangeAddressList);
86.         dataValidation.setShowErrorBox(true);
87.         return dataValidation;
88.     }
90.     private void setDataAndName(Workbook workbook, Sheet hiddenSheet, SelectItem.DataItem dataItem) {
91.         // 构建隐藏数据
92.         Row row = hiddenSheet.createRow(rowIndex);
93.         List<String> values = dataItem.getValues();
94.         for (int i = 0; i < values.size(); i++) {
95.             row.createCell(i).setCellValue(values.get(i));
96.         }
97.         // 创建名称命名器
98.         Name name = workbook.createName();
99.         name.setNameName(dataItem.getMappingKey());
100.         name.setRefersToFormula(getFormulaRef(row));
101.         dataItem.setHiddenFormulaRef(name.getRefersToFormula());
102.         rowIndex++;
103.     }
105.     private String getInDirectFormulaRef(Integer columnIndex) {
106.         CellReference slectCellReference = new CellReference(1, columnIndex);
107.         return "INDIRECT(" + joinFormulaRef(slectCellReference, false) + ")";
108.     }
110.     @Override
111.     public void afterCellDispose(CellWriteHandlerContext context) {
112.         if (!context.getHead()) {
113.             Integer columnIndex = context.getColumnIndex();
114.             if (selectColumns.contains(columnIndex)) {
115.                 // 设置红色字体
116.                 context.getFirstCellData().getOrCreateStyle().setWriteFont(redFont);
117.             }
118.         }
119.         CellWriteHandler.super.afterCellDispose(context);
120.     }
122.     private String getFormulaRef(Row prvRow) {
123.         Cell startCell = prvRow.getCell(prvRow.getFirstCellNum());
124.         Cell endCell = prvRow.getCell(prvRow.getLastCellNum() - 1);
125.         return HIDDEN_SHEET_NAME + "!" + joinFormulaRef(new CellReference(startCell), true) + ":" + joinFormulaRef(new CellReference(endCell), true);
126.     }
128.     public String joinFormulaRef(CellReference cellReference, boolean isAbsolute) {
129.         StringBuilder sb = new StringBuilder();
130.         String[] refs = cellReference.getCellRefParts();
131.         for (int i = refs.length - 1; i >= 1; i--) {
132.             if (isAbsolute) {
133.                 sb.append("$");
134.             }
135.             sb.append(refs[i]);
136.         }
137.         return sb.toString();
138.     }
140.     /**
141.      * 返回一个红色字体
142.      *
143.      * @return
144.      */
145.     private WriteFont getRedFont() {
146.         WriteFont redFont = new WriteFont();
147.         redFont.setColor(IndexedColors.RED.getIndex());
148.         return redFont;
149.     }
150. }

复制代码

表头填写类

2. package sjgjtask.databasetest.util;
4. import com.alibaba.excel.write.handler.RowWriteHandler;
5. import com.alibaba.excel.write.handler.context.RowWriteHandlerContext;
6. import org.apache.poi.ss.usermodel.*;
7. import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
8. import org.apache.poi.xssf.usermodel.XSSFRichTextString;
10. /**
11. * excel表头批注
12. */
13. public class SheetHeaderCommentWriteHandler implements RowWriteHandler {
15.     private Class clazz;
17.     public SheetHeaderCommentWriteHandler(Class clazz) {
18.         this.clazz = clazz;
19.     }
21.     @Override
22.     public void afterRowDispose(RowWriteHandlerContext context) {
23.     }
25.     public void writeComment(RowWriteHandlerContext context, int i, String commentInfo) {
26.         Sheet sheet = context.getWriteSheetHolder().getSheet();
27.         Drawing<?> drawingPatriarch = sheet.createDrawingPatriarch();
28.         // 在第一行 第二列创建一个批注
29.         Comment comment = drawingPatriarch.createCellComment(
30.                 new XSSFClientAnchor(0, 0, 0, 0, (short) i, 0, (short) i + 1, 1)
31.         );
32.         // 输入批注信息
33.         comment.setString(new XSSFRichTextString(commentInfo));
34.         // 确保表头行存在
35.         Row headerRow = sheet.getRow(0);
36.         if (headerRow == null) {
37.             headerRow = sheet.createRow(0);
38.         }
40.         // 确保单元格存在
41.         Cell cell = headerRow.getCell(i);
42.         if (cell == null) {
43.             cell = headerRow.createCell(i);
44.         }
45.         // 将批注添加到单元格对象中
46.         cell.setCellComment(comment);
47.     }
48. }

复制代码

实体类

2. package sjgjtask.databasetest.entity;
4. import com.alibaba.excel.annotation.ExcelProperty;
5. import com.baomidou.mybatisplus.annotation.TableField;
6. import com.baomidou.mybatisplus.annotation.TableName;
7. import lombok.Data;
8. import sjgjtask.databasetest.enums.Type;
9. import sjgjtask.databasetest.util.EnumTypeHandler;
11. import java.util.List;
13. @Data
14. @TableName("newtable")
15. public class NewTable {
16.     @ExcelProperty("唯一序列")
17.     private String id;
18.     @ExcelProperty("名称")
19.     private String name; // 名称
20.     @ExcelProperty("类型")
21.     private Type type; // 修改为枚举类型
22.     @ExcelProperty("类型数组")
23.     @TableField(typeHandler = EnumTypeHandler.class)
24.     private List<Type> arr; // 修改为枚举类型
25. }

复制代码

最后导出方法类

2. /**
3.      * 利用ExcelUtil导出模板
4.      */
5.     @GetMapping("/template")
6.     public void template(HttpServletResponse response) throws IOException {
7.         ExcelUtil.templateExport(response, "newtable", NewTable.class);
8.     }

复制代码

导出结果如下

2.导出数据
未完待续