Java中利用POI優(yōu)雅的導出Excel文件詳解
前言
故事是這樣開始的: 公司給排了幾天的工期,讓完成 2 個功能模塊的開發(fā)。其中有一個場景是這樣的,從 Excel 導入數據,要求數據不能重復。用戶可以下載導入失敗的 Excel 文件。
這樣就有 2 種實現(xiàn)
- 將失敗數據存儲數據庫,需要下載時生成 Excel 下載即可
- 將失敗數據生成 Excel 文件存儲文件服務器,然后返回下載鏈接。
老大要求按方案二進行。好吧,導出 Excel 是再常見不過的功能了,然而總是覺得以前寫的不夠優(yōu)雅,所以決定進行簡單的封裝,以適應簡單場景的 Excel 導出。
實現(xiàn)
Excel 導出的數據源一般是數據庫中查詢的數據。在 Java 開發(fā)這種面向對象的設計中,數據一般都是以對象為載體,填充在集合中的。所以入參之一便設計為 Collection 集合類。
導出的 Excel 一般需要表頭說明每列數據的含義,這里計劃用注解+反射來進行定義。Excel 無論是通過 HttpServletResponse 還是 File 存儲,本質上都是 IO 流操作。
具體實現(xiàn)如下:
pom.xml
<dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>4.1.2</version> </dependency>
注解定義
該注解添加在字段上,標識哪些字段需要導出到 Excel,并且添加表頭說明。
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface ExcelHeader { /** * 表頭 * @return */ String value() default ""; /** * 列索引 * @return */ int columnIndex() default 0; }
實體類
以下實體類中根據注解可知,age 字段不需要導出到 Excel。
@Data @NoArgsConstructor @AllArgsConstructor public class User { @ExcelHeader(value = "賬號") private String username; @ExcelHeader(value = "密碼") private String password; @ExcelHeader(value = "生日") @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") private LocalDateTime birthday; // 該字段沒有添加注解, Excel不導出 private Integer age; public User(String username, String password, LocalDateTime birthday) { this.username = username; this.password = password; this.birthday = birthday; } }
單元測試
注釋已經足夠清晰,這里不再過多復述。
@Slf4j class IdcPoiApplicationTests { @Test void contextLoads() throws NoSuchFieldException, IllegalAccessException, IOException { // 創(chuàng)建模擬數據 User user1 = new User("admin", "123456", LocalDateTime.now()); User user2 = new User("test", "123456", LocalDateTime.now()); List<User> users = Arrays.asList(user1, user2); // 文件路徑 String basePath = "/Users/cuishiying/Documents/spring-cloud-learning/idc-poi/oss/"; String fileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()).toString() +".xls"; // 將Excel寫入文件 HSSFWorkbook workbook = exportExcel(users, User.class); workbook.setSheetName(0,"sheetName");//設置sheet的Name // 無論是通過HttpServletResponse導出還是導出到本地磁盤,本質都是IO操作,所以這里將IO操作提取到外層。 workbook.write(new File(basePath + File.separator + fileName)); } /** * * @param data 需要導出的數據 * @param clz 數據對應的實體類 * @param <T> 泛型 * @return Excel文件 * @throws NoSuchFieldException * @throws IllegalAccessException */ public <T> HSSFWorkbook exportExcel(List<T> data, Class<T> clz) throws NoSuchFieldException, IllegalAccessException { Field[] fields = clz.getDeclaredFields(); List<String> headers = new LinkedList<>(); List<String> variables = new LinkedList<>(); // 創(chuàng)建工作薄對象 HSSFWorkbook workbook=new HSSFWorkbook();//這里也可以設置sheet的Name // 創(chuàng)建工作表對象 HSSFSheet sheet = workbook.createSheet(); // 創(chuàng)建表頭 Row rowHeader = sheet.createRow(0); // 表頭處理 for (int h = 0; h < fields.length; h++) { Field field = fields[h]; if (field.isAnnotationPresent(ExcelHeader.class)) { // 表頭 ExcelHeader annotation = field.getAnnotation(ExcelHeader.class); headers.add(annotation.value()); rowHeader.createCell(h).setCellValue(annotation.value()); // 字段 variables.add(field.getName()); } } // 數據處理 for (int i = 0; i < data.size() ; i++) { //創(chuàng)建工作表的行(表頭占用1行, 這里從第二行開始) HSSFRow row = sheet.createRow(i + 1); // 獲取一行數據 T t = data.get(i); Class<?> aClass = t.getClass(); // 填充列數據 for (int j = 0; j < variables.size(); j++) { Field declaredField = aClass.getDeclaredField(variables.get(j)); declaredField.setAccessible(true); String key = declaredField.getName(); Object value = declaredField.get(t); row.createCell(j).setCellValue(value.toString()); } } log.info("Excel文件創(chuàng)建成功"); return workbook; } }
總結
上邊的案例只是表達基本設計思路,并不嚴謹。大家項目中使用的話還請斟酌。
到此這篇關于Java中利用POI優(yōu)雅的導出Excel文件的文章就介紹到這了,更多相關Java用POI導出Excel文件內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
SSH框架網上商城項目第27戰(zhàn)之申請域名空間和項目部署及發(fā)布
這篇文章主要為大家詳細介紹了SSH框架網上商城項目第26戰(zhàn)之申請域名空間和項目部署及發(fā)布,感興趣的小伙伴們可以參考一下2016-06-06Jenkins一鍵打包部署SpringBoot應用的方法步驟
本文主要介紹了使用Jenkins一鍵打包部署SpringBoot應用的方法步驟,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-12-12Spring Boot RestTemplate提交表單數據的三種方法
本篇文章主要介紹了Spring Boot RestTemplate提交表單數據的三種方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-03-03