Java中利用POI優(yōu)雅的導出Excel文件詳解
前言
故事是這樣開始的: 公司給排了幾天的工期,讓完成 2 個功能模塊的開發(fā)。其中有一個場景是這樣的,從 Excel 導入數(shù)據(jù),要求數(shù)據(jù)不能重復。用戶可以下載導入失敗的 Excel 文件。
這樣就有 2 種實現(xiàn)
- 將失敗數(shù)據(jù)存儲數(shù)據(jù)庫,需要下載時生成 Excel 下載即可
- 將失敗數(shù)據(jù)生成 Excel 文件存儲文件服務器,然后返回下載鏈接。
老大要求按方案二進行。好吧,導出 Excel 是再常見不過的功能了,然而總是覺得以前寫的不夠優(yōu)雅,所以決定進行簡單的封裝,以適應簡單場景的 Excel 導出。
實現(xiàn)
Excel 導出的數(shù)據(jù)源一般是數(shù)據(jù)庫中查詢的數(shù)據(jù)。在 Java 開發(fā)這種面向?qū)ο蟮脑O(shè)計中,數(shù)據(jù)一般都是以對象為載體,填充在集合中的。所以入?yún)⒅槐阍O(shè)計為 Collection 集合類。
導出的 Excel 一般需要表頭說明每列數(shù)據(jù)的含義,這里計劃用注解+反射來進行定義。Excel 無論是通過 HttpServletResponse 還是 File 存儲,本質(zhì)上都是 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;
}
實體類
以下實體類中根據(jù)注解可知,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;
}
}
單元測試
注釋已經(jīng)足夠清晰,這里不再過多復述。
@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());
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");//設(shè)置sheet的Name
// 無論是通過HttpServletResponse導出還是導出到本地磁盤,本質(zhì)都是IO操作,所以這里將IO操作提取到外層。
workbook.write(new File(basePath + File.separator + fileName));
}
/**
*
* @param data 需要導出的數(shù)據(jù)
* @param clz 數(shù)據(jù)對應的實體類
* @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();//這里也可以設(shè)置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());
}
}
// 數(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;
}
}
總結(jié)
上邊的案例只是表達基本設(shè)計思路,并不嚴謹。大家項目中使用的話還請斟酌。
到此這篇關(guān)于Java中利用POI優(yōu)雅的導出Excel文件的文章就介紹到這了,更多相關(guān)Java用POI導出Excel文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
詳解使用Spring?Data?repository進行數(shù)據(jù)層的訪問問題
這篇文章主要介紹了使用Spring?Data?repository進行數(shù)據(jù)層的訪問,抽象出Spring Data repository是因為在開發(fā)過程中,常常會為了實現(xiàn)不同持久化存儲的數(shù)據(jù)訪問層而寫大量的大同小異的代碼,本文給大家介紹的非常詳細,需要的朋友參考下吧2022-06-06
Java實現(xiàn)XML格式與JSON格式互相轉(zhuǎn)換的方法
這篇文章主要介紹了Java實現(xiàn)XML格式與JSON格式互相轉(zhuǎn)換的方法,方法通過實例代碼給大家介紹的非常詳細,選擇使用哪種格式通常取決于項目的需求和上下文,所以格式轉(zhuǎn)換就成了我們必備的技能,具體實現(xiàn)代碼跟隨小編一起看看吧2023-10-10
SpringBoot3.x打包Docker容器的實現(xiàn)
這篇文章主要介紹了SpringBoot3.x打包Docker容器的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-11-11
Spring Boot 開發(fā)私有即時通信系統(tǒng)(WebSocket)
本文利用Spring Boot作為基礎(chǔ)框架,Spring Security作為安全框架,WebSocket作為通信框架,實現(xiàn)點對點聊天和群聊天2017-04-04

