前言

故事是這樣開(kāi)始的: 公司給排了幾天的工期，讓完成 2 個(gè)功能模塊的開(kāi)發(fā)。其中有一個(gè)場(chǎng)景是這樣的，從 Excel 導(dǎo)入數(shù)據(jù)，要求數(shù)據(jù)不能重復(fù)。用戶可以下載導(dǎo)入失敗的 Excel 文件。

這樣就有 2 種實(shí)現(xiàn)

將失敗數(shù)據(jù)存儲(chǔ)數(shù)據(jù)庫(kù)，需要下載時(shí)生成 Excel 下載即可 將失敗數(shù)據(jù)生成 Excel 文件存儲(chǔ)文件服務(wù)器,然后返回下載鏈接。

老大要求按方案二進(jìn)行。好吧，導(dǎo)出 Excel 是再常見(jiàn)不過(guò)的功能了，然而總是覺(jué)得以前寫(xiě)的不夠優(yōu)雅，所以決定進(jìn)行簡(jiǎn)單的封裝，以適應(yīng)簡(jiǎn)單場(chǎng)景的 Excel 導(dǎo)出。

實(shí)現(xiàn)

Excel 導(dǎo)出的數(shù)據(jù)源一般是數(shù)據(jù)庫(kù)中查詢的數(shù)據(jù)。在 Java 開(kāi)發(fā)這種面向?qū)ο蟮脑O(shè)計(jì)中，數(shù)據(jù)一般都是以對(duì)象為載體，填充在集合中的。所以入?yún)⒅槐阍O(shè)計(jì)為 Collection 集合類。

導(dǎo)出的 Excel 一般需要表頭說(shuō)明每列數(shù)據(jù)的含義，這里計(jì)劃用注解+反射來(lái)進(jìn)行定義。Excel 無(wú)論是通過(guò) HttpServletResponse 還是 File 存儲(chǔ)，本質(zhì)上都是 IO 流操作。

具體實(shí)現(xiàn)如下:

pom.xml

<dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>4.1.2</version> </dependency>

注解定義

該注解添加在字段上，標(biāo)識(shí)哪些字段需要導(dǎo)出到 Excel，并且添加表頭說(shuō)明。

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ExcelHeader { /** * 表頭 * @return */ String value() default ''; /** * 列索引 * @return */ int columnIndex() default 0;}

實(shí)體類

以下實(shí)體類中根據(jù)注解可知，age 字段不需要導(dǎo)出到 Excel。

@Data@NoArgsConstructor@AllArgsConstructorpublic class User { @ExcelHeader(value = '賬號(hào)') 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; // 該字段沒(méi)有添加注解, Excel不導(dǎo)出 private Integer age; public User(String username, String password, LocalDateTime birthday) { this.username = username; this.password = password; this.birthday = birthday; }}

單元測(cè)試

注釋已經(jīng)足夠清晰，這里不再過(guò)多復(fù)述。

@Slf4jclass IdcPoiApplicationTests { @Test void contextLoads() throws NoSuchFieldException, IllegalAccessException, IOException { // 創(chuàng)建模擬數(shù)據(jù) 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寫(xiě)入文件 HSSFWorkbook workbook = exportExcel(users, User.class); workbook.setSheetName(0,'sheetName');//設(shè)置sheet的Name // 無(wú)論是通過(guò)HttpServletResponse導(dǎo)出還是導(dǎo)出到本地磁盤(pán),本質(zhì)都是IO操作，所以這里將IO操作提取到外層。 workbook.write(new File(basePath + File.separator + fileName)); } /** * * @param data 需要導(dǎo)出的數(shù)據(jù) * @param clz 數(shù)據(jù)對(duì)應(yīng)的實(shí)體類 * @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)建工作薄對(duì)象 HSSFWorkbook workbook=new HSSFWorkbook();//這里也可以設(shè)置sheet的Name // 創(chuàng)建工作表對(duì)象 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()); } } // 數(shù)據(jù)處理 for (int i = 0; i < data.size() ; i++) { //創(chuàng)建工作表的行(表頭占用1行, 這里從第二行開(kāi)始) HSSFRow row = sheet.createRow(i + 1); // 獲取一行數(shù)據(jù) T t = data.get(i); Class<?> aClass = t.getClass(); // 填充列數(shù)據(jù) 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; }}

總結(jié)

上邊的案例只是表達(dá)基本設(shè)計(jì)思路，并不嚴(yán)謹(jǐn)。大家項(xiàng)目中使用的話還請(qǐng)斟酌。

到此這篇關(guān)于Java中利用POI優(yōu)雅的導(dǎo)出Excel文件的文章就介紹到這了,更多相關(guān)Java用POI導(dǎo)出Excel文件內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！