這篇文章主要講解了Java中如何利用POI優(yōu)雅的導(dǎo)出Excel文件,內(nèi)容清晰明了,對(duì)此有興趣的小伙伴可以學(xué)習(xí)一下,相信大家閱讀完之后會(huì)有幫助。
阿瓦提ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場(chǎng)景,ssl證書未來市場(chǎng)廣闊!成為創(chuàng)新互聯(lián)建站的ssl證書銷售渠道,可以享受市場(chǎng)價(jià)格4-6折優(yōu)惠!如果有意向歡迎電話聯(lián)系或者加微信:028-86922220(備注:SSL證書合作)期待與您的合作!
前言
故事是這樣開始的: 公司給排了幾天的工期,讓完成 2 個(gè)功能模塊的開發(fā)。其中有一個(gè)場(chǎng)景是這樣的,從 Excel 導(dǎo)入數(shù)據(jù),要求數(shù)據(jù)不能重復(fù)。用戶可以下載導(dǎo)入失敗的 Excel 文件。
這樣就有 2 種實(shí)現(xiàn)
老大要求按方案二進(jìn)行。好吧,導(dǎo)出 Excel 是再常見不過的功能了,然而總是覺得以前寫的不夠優(yōu)雅,所以決定進(jìn)行簡單的封裝,以適應(yīng)簡單場(chǎng)景的 Excel 導(dǎo)出。
實(shí)現(xiàn)
Excel 導(dǎo)出的數(shù)據(jù)源一般是數(shù)據(jù)庫中查詢的數(shù)據(jù)。在 Java 開發(fā)這種面向?qū)ο蟮脑O(shè)計(jì)中,數(shù)據(jù)一般都是以對(duì)象為載體,填充在集合中的。所以入?yún)⒅槐阍O(shè)計(jì)為 Collection 集合類。
導(dǎo)出的 Excel 一般需要表頭說明每列數(shù)據(jù)的含義,這里計(jì)劃用注解+反射來進(jìn)行定義。Excel 無論是通過 HttpServletResponse 還是 File 存儲(chǔ),本質(zhì)上都是 IO 流操作。
具體實(shí)現(xiàn)如下:
pom.xml
org.apache.poi poi-ooxml 4.1.2
注解定義
該注解添加在字段上,標(biāo)識(shí)哪些字段需要導(dǎo)出到 Excel,并且添加表頭說明。
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface ExcelHeader { /** * 表頭 * @return */ String value() default ""; /** * 列索引 * @return */ int columnIndex() default 0; }
實(shí)體類
以下實(shí)體類中根據(jù)注解可知,age 字段不需要導(dǎo)出到 Excel。
@Data @NoArgsConstructor @AllArgsConstructor public 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; // 該字段沒有添加注解, 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)足夠清晰,這里不再過多復(fù)述。
@Slf4j class 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()); Listusers = 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");//設(shè)置sheet的Name // 無論是通過HttpServletResponse導(dǎo)出還是導(dǎo)出到本地磁盤,本質(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 泛型 * @return Excel文件 * @throws NoSuchFieldException * @throws IllegalAccessException */ public HSSFWorkbook exportExcel(List data, Class clz) throws NoSuchFieldException, IllegalAccessException { Field[] fields = clz.getDeclaredFields(); List headers = new LinkedList<>(); List 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行, 這里從第二行開始) 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; } }
看完上述內(nèi)容,是不是對(duì)Java中如何利用POI優(yōu)雅的導(dǎo)出Excel文件有進(jìn)一步的了解,如果還想學(xué)習(xí)更多內(nèi)容,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。