文章目錄
- 前言
- 一、依賴坐標
- 二、工具類:ExcelUtil
- 三、測試
- 1.實體類
- 2.前置操作
- 3.單Sheet導出
- 4.單Sheet導入
- 5.多Sheet導出
- 6.多Sheet導入
- 7.完整代碼
- 四、擴展:自定義注解實現枚舉類型轉換
- 1.枚舉接口
- 2.枚舉類
- 3.注解
- 4.轉換類
- 5.使用示例
- 6.測試
- 總結
前言
在現代應用開發中,高效可靠的Excel處理能力已成為企業級應用的剛需。本文介紹的Excel工具類基于阿里巴巴EasyExcel技術棧,提供從基礎數據導入導出、多Sheet復雜報表生成到枚舉類型自動轉換的一站式解決方案。通過簡潔的API設計和嚴謹的內存管理,開發者可輕松應對各種Excel處理場景,避免重復造輪子,顯著提升開發效率。
一、依賴坐標
核心依賴
<!--表格處理——easyexcel--><dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>3.3.2</version></dependency><!-- Lombok(簡化代碼結構) --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.30</version></dependency><!-- Spring Web(文件上傳支持) --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>
依賴說明
依賴 | 核心功能 | 版本要求 | 優勢特性 |
---|---|---|---|
EasyExcel | Excel 讀寫操作 | ≥3.3.2 | 低內存占用、高性能處理 |
Lombok | 簡化代碼結構(非必需) | - | 減少樣板代碼 |
Spring Web | 文件上傳支持(非必需) | - | 簡化 Web 集成 |
二、工具類:ExcelUtil
核心功能設計
方法名 | 參數 | 功能描述 | 返回值示例 |
---|---|---|---|
importExcel | file=訂單.xlsx, clazz=Order.class | 導入訂單數據到Order對象列表 | List<Order> |
exportSingle | baseName="訂單", sheet=orderSheet | 導出訂單數據到單Sheet文件 | /exports/訂單_20240520.xlsx |
exportMulti | baseName="報表", sheets=[sheet1,sheet2] | 導出多Sheet財務報表 | /exports/報表_20240520.xlsx(多sheet) |
Sheet
數據封裝類
@Data
@AllArgsConstructor
public static class Sheet<T> {private final String name; // Sheet名稱private final List<T> data; // 數據列表private final Class<T> clazz;// 數據模型類
}
完整代碼
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.write.metadata.WriteSheet;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
/*** Excel 工具類*/
@Slf4j
@RequiredArgsConstructor
@Component
public class ExcelUtil {// 默認導出目錄(可自定義)@Value("${vehicle.export}")//這里通過配置文件配置,然后用spring提供的value注解注入的,也可以直接指定private String defaultExportDir;/*** 導入整張表*/public <T> List<T> importExcel(MultipartFile file, Class<T> clazz) throws IOException {if (file.isEmpty()) {throw new IllegalArgumentException("上傳的文件為空");}return EasyExcel.read(file.getInputStream()).head(clazz).sheet().doReadSync();}/*** 導出單個 Sheet*/public Path exportSingle(String baseName, Sheet<?> sheet) throws IOException {String filepath = generateUniqueFileName(baseName);EasyExcel.write(filepath, sheet.getClazz()).sheet(sheet.getName()).doWrite(sheet.getData());return Path.of(filepath);}/*** 導出多個 Sheet*/public Path exportMulti(String baseName, List<Sheet<?>> sheets) throws IOException {String filepath = generateUniqueFileName(baseName);// 創建 ExcelWriterExcelWriter writer = EasyExcel.write(filepath).build();// 寫入每個 sheetfor (int i = 0; i < sheets.size(); i++) {Sheet<?> sheet = sheets.get(i);WriteSheet writeSheet = EasyExcel.writerSheet(i, sheet.getName()).head(sheet.getClazz()).build();writer.write(sheet.getData(), writeSheet);}// 手動關閉 ExcelWriterwriter.finish();return Path.of(filepath);}/*** 生成帶時間戳的唯一文件名(避免覆蓋)*/private String generateUniqueFileName(String baseName) throws IOException {// 確保目錄存在File dir = new File(defaultExportDir);if (!dir.exists()) {dir.mkdirs();}// 使用時間戳和隨機數生成唯一文件名String timestamp = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMddHHmmss"));String randomSuffix = java.util.UUID.randomUUID().toString().substring(0, 4); // 隨機后綴,避免極小概率的沖突return String.format("%s%s_%s_%s.xlsx", defaultExportDir, baseName, timestamp, randomSuffix);}/*** Sheet 數據封裝類*/@AllArgsConstructor@Datapublic static class Sheet<T> {private final String name;private final List<T> data;private final Class<T> clazz;}
}
三、測試
1.實體類
// 測試實體類 - 用戶
@Data
@AllArgsConstructor
@NoArgsConstructor
public static class User {@ExcelProperty("用戶ID")private Long id;@ExcelProperty("姓名")private String name;@ExcelProperty("郵箱")private String email;@ExcelProperty("注冊日期")private LocalDate registerDate;
}// 測試實體類 - 產品
@Data
@AllArgsConstructor
@NoArgsConstructor
public static class Product {@ExcelProperty("產品ID")private String productId;@ExcelProperty("產品名稱")private String name;@ExcelProperty("價格")private Double price;@ExcelProperty("庫存數量")private Integer stock;
}
2.前置操作
private ExcelUtil excelUtil;
private List<User> testUsers;
private List<Product> testProducts;// 導出目錄 - src/test/resources/excel
private static final String EXPORT_DIR = "src/test/resources/excel/";@BeforeEach
void setUp() throws NoSuchFieldException, IllegalAccessException {// 初始化ExcelUtil,設置導出目錄excelUtil = new ExcelUtil();//反射獲取數據Field field = ExcelUtil.class.getDeclaredField("defaultExportDir");field.setAccessible(true);field.set(excelUtil, EXPORT_DIR);// 準備測試用戶數據testUsers = new ArrayList<>();testUsers.add(new User(1L, "張三", "zhangsan@example.com", LocalDate.of(2023, 1, 15)));testUsers.add(new User(2L, "李四", "lisi@example.com", LocalDate.of(2023, 3, 22)));testUsers.add(new User(3L, "王五", "wangwu@example.com", LocalDate.of(2023, 5, 30)));// 準備測試產品數據testProducts = new ArrayList<>();testProducts.add(new Product("P001", "筆記本電腦", 5999.0, 120));testProducts.add(new Product("P002", "智能手機", 3999.0, 200));testProducts.add(new Product("P003", "平板電腦", 2999.0, 150));
}
3.單Sheet導出
/*** 測試單Sheet導出功能* 文件將導出到 src/test/resources/excel 目錄*/@Testvoid testSingleSheetExport() throws IOException {// 1. 創建用戶數據SheetExcelUtil.Sheet<User> userSheet = new ExcelUtil.Sheet<>("用戶列表", testUsers, User.class);// 2. 導出用戶數據到單Sheet ExcelPath exportPath = excelUtil.exportSingle("test_users_export", userSheet);// 3. 打印文件路徑System.out.println("單Sheet導出路徑: " + exportPath.toAbsolutePath());// 4. 驗證文件已創建assertTrue(Files.exists(exportPath), "導出的Excel文件應存在");assertTrue(exportPath.toString().endsWith(".xlsx"), "文件應為.xlsx格式");assertTrue(Files.size(exportPath) > 0, "文件大小應大于0");}
4.單Sheet導入
修改文件名成剛生成的文件
/*** 測試單Sheet導入功能 (文件名需要修改成對應生成的文件)* 使用預先導出的文件進行導入測試*/@Testvoid testSingleSheetImport() throws IOException {File importFile = new File(EXPORT_DIR + "test_users_export_20250806202812_93bf.xlsx");System.out.println("使用導入文件: " + importFile.getAbsolutePath());// 準備MultipartFilebyte[] fileContent = Files.readAllBytes(importFile.toPath());MockMultipartFile mockFile = new MockMultipartFile("users.xlsx", "users.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);// 導入用戶數據List<User> importedUsers = excelUtil.importExcel(mockFile, User.class);// 驗證導入結果assertEquals(testUsers.size(), importedUsers.size(), "導入的用戶數量應匹配");for (int i = 0; i < testUsers.size(); i++) {User original = testUsers.get(i);User imported = importedUsers.get(i);assertEquals(original.getId(), imported.getId(), "用戶ID應匹配");assertEquals(original.getName(), imported.getName(), "用戶名應匹配");assertEquals(original.getEmail(), imported.getEmail(), "郵箱應匹配");assertEquals(original.getRegisterDate(), imported.getRegisterDate(), "注冊日期應匹配");}// 打印導入結果System.out.println("成功導入用戶數據: " + importedUsers.size() + " 條");importedUsers.forEach(user ->System.out.printf("ID: %d, 姓名: %s, 郵箱: %s%n",user.getId(), user.getName(), user.getEmail()));}
5.多Sheet導出
/*** 測試多Sheet導出功能* 文件將導出到 src/test/resources/excel 目錄*/@Testvoid testMultiSheetExport() throws IOException {// 1. 準備多Sheet數據ExcelUtil.Sheet<User> userSheet = new ExcelUtil.Sheet<>("用戶數據", testUsers, User.class);ExcelUtil.Sheet<Product> productSheet = new ExcelUtil.Sheet<>("產品數據", testProducts, Product.class);List<ExcelUtil.Sheet<?>> sheets = new ArrayList<>();sheets.add(userSheet);sheets.add(productSheet);// 2. 導出到多Sheet ExcelPath exportPath = excelUtil.exportMulti("test_multi_sheet_export", sheets);// 3. 打印文件路徑System.out.println("多Sheet導出路徑: " + exportPath.toAbsolutePath());// 4. 驗證文件已創建assertTrue(Files.exists(exportPath), "導出的Excel文件應存在");}
6.多Sheet導入
/*** 測試多Sheet導入功能* 使用預先導出的文件進行導入測試*/@Testvoid testMultiSheetImport() throws IOException {File importFile = new File(EXPORT_DIR + "test_multi_sheet_export_20250806203417_2318.xlsx");System.out.println("使用導入文件: " + importFile.getAbsolutePath());// 導入用戶數據(第一個Sheet)byte[] fileContent = Files.readAllBytes(importFile.toPath());MockMultipartFile userFile = new MockMultipartFile("multi_sheet.xlsx", "multi_sheet.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);List<User> importedUsers = excelUtil.importExcel(userFile, User.class);// 驗證用戶數據assertEquals(testUsers.size(), importedUsers.size(), "導入的用戶數量應匹配");// 導入產品數據(第二個Sheet)MockMultipartFile productFile = new MockMultipartFile("multi_sheet.xlsx", "multi_sheet.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);List<Product> importedProducts = EasyExcel.read(productFile.getInputStream()).head(Product.class).sheet(1) // 第二個Sheet(索引從0開始).doReadSync();// 驗證產品數據assertEquals(testProducts.size(), importedProducts.size(), "導入的產品數量應匹配");for (int i = 0; i < testProducts.size(); i++) {Product original = testProducts.get(i);Product imported = importedProducts.get(i);assertEquals(original.getProductId(), imported.getProductId(), "產品ID應匹配");assertEquals(original.getName(), imported.getName(), "產品名稱應匹配");assertEquals(original.getPrice(), imported.getPrice(), 0.001, "產品價格應匹配");assertEquals(original.getStock(), imported.getStock(), "庫存數量應匹配");}// 打印導入結果System.out.println("成功導入用戶數據: " + importedUsers.size() + " 條");System.out.println("成功導入產品數據: " + importedProducts.size() + " 條");}
7.完整代碼
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.annotation.ExcelProperty;
import com.fc.utils.ExcelUtil;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.mock.web.MockMultipartFile;import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;public class ExcelUtilTest {// 測試實體類 - 用戶@Data@AllArgsConstructor@NoArgsConstructorpublic static class User {@ExcelProperty("用戶ID")private Long id;@ExcelProperty("姓名")private String name;@ExcelProperty("郵箱")private String email;@ExcelProperty("注冊日期")private LocalDate registerDate;}// 測試實體類 - 產品@Data@AllArgsConstructor@NoArgsConstructorpublic static class Product {@ExcelProperty("產品ID")private String productId;@ExcelProperty("產品名稱")private String name;@ExcelProperty("價格")private Double price;@ExcelProperty("庫存數量")private Integer stock;}private ExcelUtil excelUtil;private List<User> testUsers;private List<Product> testProducts;// 導出目錄 - src/test/resources/excelprivate static final String EXPORT_DIR = "src/test/resources/excel/";@BeforeEachvoid setUp() throws NoSuchFieldException, IllegalAccessException {// 初始化ExcelUtil,設置導出目錄excelUtil = new ExcelUtil();//反射獲取數據Field field = ExcelUtil.class.getDeclaredField("defaultExportDir");field.setAccessible(true);field.set(excelUtil, EXPORT_DIR);// 準備測試用戶數據testUsers = new ArrayList<>();testUsers.add(new User(1L, "張三", "zhangsan@example.com", LocalDate.of(2023, 1, 15)));testUsers.add(new User(2L, "李四", "lisi@example.com", LocalDate.of(2023, 3, 22)));testUsers.add(new User(3L, "王五", "wangwu@example.com", LocalDate.of(2023, 5, 30)));// 準備測試產品數據testProducts = new ArrayList<>();testProducts.add(new Product("P001", "筆記本電腦", 5999.0, 120));testProducts.add(new Product("P002", "智能手機", 3999.0, 200));testProducts.add(new Product("P003", "平板電腦", 2999.0, 150));}/*** 測試單Sheet導出功能* 文件將導出到 src/test/resources/excel 目錄*/@Testvoid testSingleSheetExport() throws IOException {// 1. 創建用戶數據SheetExcelUtil.Sheet<User> userSheet = new ExcelUtil.Sheet<>("用戶列表", testUsers, User.class);// 2. 導出用戶數據到單Sheet ExcelPath exportPath = excelUtil.exportSingle("test_users_export", userSheet);// 3. 打印文件路徑System.out.println("單Sheet導出路徑: " + exportPath.toAbsolutePath());// 4. 驗證文件已創建assertTrue(Files.exists(exportPath), "導出的Excel文件應存在");assertTrue(exportPath.toString().endsWith(".xlsx"), "文件應為.xlsx格式");assertTrue(Files.size(exportPath) > 0, "文件大小應大于0");}/*** 測試多Sheet導出功能* 文件將導出到 src/test/resources/excel 目錄*/@Testvoid testMultiSheetExport() throws IOException {// 1. 準備多Sheet數據ExcelUtil.Sheet<User> userSheet = new ExcelUtil.Sheet<>("用戶數據", testUsers, User.class);ExcelUtil.Sheet<Product> productSheet = new ExcelUtil.Sheet<>("產品數據", testProducts, Product.class);List<ExcelUtil.Sheet<?>> sheets = new ArrayList<>();sheets.add(userSheet);sheets.add(productSheet);// 2. 導出到多Sheet ExcelPath exportPath = excelUtil.exportMulti("test_multi_sheet_export", sheets);// 3. 打印文件路徑System.out.println("多Sheet導出路徑: " + exportPath.toAbsolutePath());// 4. 驗證文件已創建assertTrue(Files.exists(exportPath), "導出的Excel文件應存在");}/*** 測試單Sheet導入功能 (文件名需要修改成對應生成的文件)* 使用預先導出的文件進行導入測試*/@Testvoid testSingleSheetImport() throws IOException {File importFile = new File(EXPORT_DIR + "test_users_export_*.xlsx");System.out.println("使用導入文件: " + importFile.getAbsolutePath());// 準備MultipartFilebyte[] fileContent = Files.readAllBytes(importFile.toPath());MockMultipartFile mockFile = new MockMultipartFile("users.xlsx", "users.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);// 導入用戶數據List<User> importedUsers = excelUtil.importExcel(mockFile, User.class);// 驗證導入結果assertEquals(testUsers.size(), importedUsers.size(), "導入的用戶數量應匹配");for (int i = 0; i < testUsers.size(); i++) {User original = testUsers.get(i);User imported = importedUsers.get(i);assertEquals(original.getId(), imported.getId(), "用戶ID應匹配");assertEquals(original.getName(), imported.getName(), "用戶名應匹配");assertEquals(original.getEmail(), imported.getEmail(), "郵箱應匹配");assertEquals(original.getRegisterDate(), imported.getRegisterDate(), "注冊日期應匹配");}// 打印導入結果System.out.println("成功導入用戶數據: " + importedUsers.size() + " 條");importedUsers.forEach(user ->System.out.printf("ID: %d, 姓名: %s, 郵箱: %s%n",user.getId(), user.getName(), user.getEmail()));}/*** 測試多Sheet導入功能* 使用預先導出的文件進行導入測試*/@Testvoid testMultiSheetImport() throws IOException {File importFile = new File(EXPORT_DIR + "test_multi_sheet_export_*.xlsx");System.out.println("使用導入文件: " + importFile.getAbsolutePath());// 導入用戶數據(第一個Sheet)byte[] fileContent = Files.readAllBytes(importFile.toPath());MockMultipartFile userFile = new MockMultipartFile("multi_sheet.xlsx", "multi_sheet.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);List<User> importedUsers = excelUtil.importExcel(userFile, User.class);// 驗證用戶數據assertEquals(testUsers.size(), importedUsers.size(), "導入的用戶數量應匹配");// 導入產品數據(第二個Sheet)MockMultipartFile productFile = new MockMultipartFile("multi_sheet.xlsx", "multi_sheet.xlsx","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",fileContent);List<Product> importedProducts = EasyExcel.read(productFile.getInputStream()).head(Product.class).sheet(1) // 第二個Sheet(索引從0開始).doReadSync();// 驗證產品數據assertEquals(testProducts.size(), importedProducts.size(), "導入的產品數量應匹配");for (int i = 0; i < testProducts.size(); i++) {Product original = testProducts.get(i);Product imported = importedProducts.get(i);assertEquals(original.getProductId(), imported.getProductId(), "產品ID應匹配");assertEquals(original.getName(), imported.getName(), "產品名稱應匹配");assertEquals(original.getPrice(), imported.getPrice(), 0.001, "產品價格應匹配");assertEquals(original.getStock(), imported.getStock(), "庫存數量應匹配");}// 打印導入結果System.out.println("成功導入用戶數據: " + importedUsers.size() + " 條");System.out.println("成功導入產品數據: " + importedProducts.size() + " 條");}
}
四、擴展:自定義注解實現枚舉類型轉換
自定義注解實現枚舉定義的
code->description
的轉化
1.枚舉接口
public interface IEnum {int getCode();String getDescription();
}
2.枚舉類
import lombok.Getter;
@Getter
public enum TransportType implements IEnum{SINGLE(1, "單邊"),BILATERAL(2, "往返");private final int code;private final String description;TransportType(int code, String description) {this.code = code;this.description = description;}public static TransportType fromCode(int code) {for (TransportType status : TransportType.values()) {if (status.getCode() == code) {return status;}}throw new IllegalArgumentException("狀態異常: " + code);}
}
3.注解
import com.fc.enums.IEnum;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EnumClass {/*** 指定枚舉類,必須實現 IEnum 且有 fromCode(int) 靜態方法*/Class<? extends IEnum> value();
}
4.轉換類
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.data.ReadCellData;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
import com.fc.anno.EnumClass;
import com.fc.enums.IEnum;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;public class EnumConverter implements Converter<Object> {/*** key -> 枚舉 Class* value -> description -> code 的映射(導入用)*/private static final Map<Class<?>, Map<String, Integer>> DESC_TO_CODE_CACHE = new ConcurrentHashMap<>();/*** key -> 枚舉 Class* value -> code -> description 的映射(導出用)*/private static final Map<Class<?>, Map<Integer, String>> CODE_TO_DESC_CACHE = new ConcurrentHashMap<>();@Overridepublic Class<?> supportJavaTypeKey() {return Object.class; // 支持任意枚舉}@Overridepublic CellDataTypeEnum supportExcelTypeKey() {return CellDataTypeEnum.STRING;}@Overridepublic Object convertToJavaData(ReadCellData<?> cellData,ExcelContentProperty contentProperty,GlobalConfiguration globalConfiguration) throws Exception {String cellValue = cellData.getStringValue();if (cellValue == null || cellValue.trim().isEmpty()) {return null;}Class<? extends IEnum> enumClass = getEnumClass(contentProperty);Map<String, Integer> descToCode = DESC_TO_CODE_CACHE.computeIfAbsent(enumClass, this::buildDescToCodeMap);Integer code = descToCode.get(cellValue.trim());if (code == null) {throw new IllegalArgumentException("找不到對應枚舉描述:" + cellValue);}Method fromCode = enumClass.getDeclaredMethod("fromCode", int.class);return fromCode.invoke(null, code); // 返回 Integer 或枚舉都行}@Overridepublic WriteCellData<?> convertToExcelData(Object value,ExcelContentProperty contentProperty,GlobalConfiguration globalConfiguration) throws Exception {if (value == null) {return new WriteCellData<>("");}Class<? extends IEnum> enumClass = getEnumClass(contentProperty);Map<Integer, String> codeToDesc = CODE_TO_DESC_CACHE.computeIfAbsent(enumClass, this::buildCodeToDescMap);int code;if (value instanceof Number) {code = ((Number) value).intValue();} else if (value instanceof IEnum) {code = ((IEnum) value).getCode();} else {throw new IllegalArgumentException("不支持的類型:" + value.getClass());}return new WriteCellData<>(codeToDesc.getOrDefault(code, ""));}private static Class<? extends IEnum> getEnumClass(ExcelContentProperty contentProperty) {/* 重點:從注解里拿到枚舉類 */EnumClass enumClassAnno = contentProperty.getField().getAnnotation(EnumClass.class);if (enumClassAnno == null) {throw new IllegalStateException("字段必須使用 @EnumClass 指定枚舉");}return enumClassAnno.value();}private Map<Integer, String> buildCodeToDescMap(Class<?> enumClass) {return Arrays.stream(enumClass.getEnumConstants()).map(o -> (IEnum) o).collect(Collectors.toMap(IEnum::getCode, IEnum::getDescription));}private Map<String, Integer> buildDescToCodeMap(Class<?> enumClass) {return Arrays.stream(enumClass.getEnumConstants()).map(o -> (IEnum) o).collect(Collectors.toMap(IEnum::getDescription, IEnum::getCode));}
}
5.使用示例
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {@ExcelProperty("產品ID")private String productId;@ExcelProperty("產品名稱")private String name;@ExcelProperty("價格")private Double price;@ExcelProperty(value = "運輸類型",converter = EnumConverter.class)//使用自定義的轉換類@EnumClass(value = TransportType.class)//添加注解指定轉換的枚舉類,注意一定要實現接口IEnumprivate Integer transportType;
}
6.測試
完整測試代碼
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.annotation.ExcelProperty;
import com.fc.anno.EnumClass;
import com.fc.convert.EnumConverter;
import com.fc.enums.TransportType;
import com.fc.utils.ExcelUtil;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.mock.web.MockMultipartFile;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertTrue;public class ExcelUtilTest {// 測試實體類 - 產品@Data@AllArgsConstructor@NoArgsConstructorpublic static class Product {@ExcelProperty("產品ID")private String productId;@ExcelProperty("產品名稱")private String name;@ExcelProperty("價格")private Double price;@ExcelProperty(value = "運輸類型",converter = EnumConverter.class)@EnumClass(value = TransportType.class)private Integer transportType;}private ExcelUtil excelUtil;private List<Product> testProducts;// 導出目錄 - src/test/resources/excelprivate static final String EXPORT_DIR = "src/test/resources/excel/";@BeforeEachvoid setUp() throws NoSuchFieldException, IllegalAccessException {// 初始化ExcelUtil,設置導出目錄excelUtil = new ExcelUtil();//反射獲取數據Field field = ExcelUtil.class.getDeclaredField("defaultExportDir");field.setAccessible(true);field.set(excelUtil, EXPORT_DIR);// 準備測試產品數據testProducts = new ArrayList<>();testProducts.add(new Product("P001", "水泥", 5999.0, 1));testProducts.add(new Product("P002", "河沙", 3999.0, 1));testProducts.add(new Product("P003", "磚塊", 2999.0, 2));}/*** 測試單Sheet導出功能* 文件將導出到 src/test/resources/excel 目錄*/@Testvoid testSingleSheetExport() throws IOException {// 1. 創建用戶數據SheetExcelUtil.Sheet<Product> productSheet = new ExcelUtil.Sheet<>("產品列表", testProducts, Product.class);// 2. 導出用戶數據到單Sheet ExcelPath exportPath = excelUtil.exportSingle("test_produces_export", productSheet);// 3. 打印文件路徑System.out.println("單Sheet導出路徑: " + exportPath.toAbsolutePath());// 4. 驗證文件已創建assertTrue(Files.exists(exportPath), "導出的Excel文件應存在");assertTrue(exportPath.toString().endsWith(".xlsx"), "文件應為.xlsx格式");assertTrue(Files.size(exportPath) > 0, "文件大小應大于0");}
}
總結
本Excel處理工具類旨在為開發者提供一套簡潔高效的Excel操作解決方案。基于成熟的EasyExcel技術棧,覆蓋了從基礎數據導入導出、多Sheet復雜報表生成到枚舉類型自動轉換的完整場景。通過合理的API設計、嚴謹的資源管理和智能的類型轉換機制,顯著降低了Excel處理的開發門檻。