目錄
easyExcel 讀寫excel表格
EasyExcel是一個基於Java的簡單、省內存的讀寫Excel的開源項目。在盡可能節約內存的情況下支持讀寫百M的Excel。
Java解析、生成Excel比較有名的框架有Apache poi、jxl。但他們都存在一個嚴重的問題就是非常的耗內存，poi有一套SAX模式的API可以一定程度的解決一些內存溢出的問題，但POI還是有一些缺陷，比如07版Excel解壓縮以及解壓后存儲都是在內存中完成的，內存消耗依然很大。easyexcel重寫了poi對07版Excel的解析，能夠原本一個3M的excel用POI sax依然需要100M左右內存降低到幾M，並且再大的excel不會出現內存溢出，03版依賴POI的sax模式。在上層做了模型轉換的封裝，讓使用者更加簡單方便。
官方文檔: https://www.yuque.com/easyexcel/doc/easyexcel
1. 導入maven依賴
依賴地址
https://mvnrepository.com/artifact/com.alibaba/easyexcel
2. 簡單寫出excel
2.1 准備pojo類
以User類為例, @ExcelProperty注解是聲明表格對應的列信息, value是列名, index是索引(從0開始)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@ExcelProperty(value = "姓名", index = 0)
private String name;
@ExcelProperty(value = "年齡", index = 1)
private Integer age;
@ExcelProperty(value = "生日", index = 2)
private Date birth;
}
2.2 寫出
// 假設為數據庫層對象
@Autowired
private UserDao userDao;
// 寫出excel文件方法
public void writeExcelForUserList() {
// 保存文件路徑
String fileName = "d:\\user.xlsx";
// 查數據, 查詢所有用戶
List<User> users = userDao.getUsers();
/** 寫出到文件
* 參數fileName為文件輸出路徑
* User.class為實體類字節碼對象
* sheet中的參數為表的sheet名
* doWrite的參數為實體類集合對象
*/
EasyExcel.write(fileName, User.class).sheet("用戶表").doWrite(users);
}
3. 簡單讀取excel
假如我們讀取上面生成的excel表格, pojo依賴依舊使用的上面的實體類User
3.1 監聽器
讀取excel需要先寫一個監聽器繼承AnalysisEventListener, 泛型最好指定對應的實體類
注意, 此監聽器不能被spring管理, 使用的時候只能new
public class UserExcelListener extends AnalysisEventListener<User> {
/**
* 一行一行的讀取excel中的內容 (此方法必寫)
*/
@Override
public void invoke(User user, AnalysisContext analysisContext) {
System.out.println("user: " + user);
}
/**
* 讀取表頭內容
*/
@Override
public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
super.invokeHeadMap(headMap, context);
System.out.println("headMap: " + headMap);
}
/**
* 讀取完成之后執行 (此方法必寫)
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
System.out.println("read ok");
}
}
3.2 讀取
public void readExcelForUserList() {
// 讀取文件的路徑
String fileName = "d:\\user.xlsx";
// 執行讀取
/**
* fileName參數為讀取文件的路徑
* User.class為對應的實體類
* new UserExcelListener是上面寫的監聽器
*/
EasyExcel.read(fileName, User.class, new UserExcelListener()).sheet().doRead();
}
4. WEB 上傳和下載
4.1 下載
/**
* 文件下載（失敗了會返回一個有部分數據的Excel）
* <p>1. 創建excel對應的實體對象 參照{@link DownloadData}
* <p>2. 設置返回的 參數
* <p>3. 直接寫，這里注意，finish的時候會自動關閉OutputStream,當然你外面再關閉流問題不大
*/
@GetMapping("download")
public void download(HttpServletResponse response) throws IOException {
// 這里注意 有同學反應使用swagger 會導致各種問題，請直接用瀏覽器或者用postman
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
// 這里URLEncoder.encode可以防止中文亂碼 當然和easyexcel沒有關系
String fileName = URLEncoder.encode("測試", "UTF-8");
response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());
}
4.2 上傳
/**
* 文件上傳
* <p>1. 創建excel對應的實體對象 參照{@link UploadData}
* <p>2. 由於默認一行行的讀取excel，所以需要創建excel一行一行的回調監聽器，參照{@link UploadDataListener}
* <p>3. 直接讀即可
*/
@PostMapping("upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {
EasyExcel.read(file.getInputStream(), UploadData.class, new UploadDataListener(uploadDAO)).sheet().doRead();
return "success";
}