一 前言
本篇是EasyExcel快速入門知識，講解如何讀取，寫入excel ,並給出了簡單web示例；為什么要使用easyexcel；原因是相比於poi,easyexcel更加輕量級，讀取寫入API方便，並且在工作中占用內存較小；
官方描述如下：
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模式。在上層做了模型轉換的封裝，讓使用者更加簡單方便
知識追尋者(Inheriting the spirit of open source, Spreading technology knowledge;)
二 讀取excel
讀取的大體流程如下
- 讀取數據流
- 將數據流映射到listener
- listener中處理讀取的每條記錄
- 讀取完畢，進行清理；
2.1 讀取
讀取的方法如下，本方法是基於模型映射方法讀取，其它方法請讀者自行參考官方文檔；
模型是User.class；
listener是UserDataListener
讀取 第一個sheet；
@Test
public void testRead1(){
InputStream inputStream = null;
try {
// 獲取輸入流
inputStream = new FileInputStream("C:\\mydata\\generator\\zszxz.xlsx");
// 解析每行結果在listener中處理
AnalysisEventListener listener = new UserDataListener();
// 讀取excel
ExcelReader excelReader = EasyExcel.read(inputStream, User.class, listener)
.build();
// 讀取sheet0
ReadSheet readSheet = EasyExcel.readSheet(0).build();
// 將 sheet 寫入 Reader
excelReader.read(readSheet);
} catch (Exception e) {
} finally {
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
2.2 模型實例
如下所示，index 參數代表excel對應的列，0表示第一列； value表示列對應的名稱，在寫入excel時作用較大；
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
// id
@ExcelProperty(index = 0,value = "編號")
private Long id;
// 名稱
@ExcelProperty(index = 1,value = "名稱")
private String name;
// 創建時間
@ExcelProperty(index = 2,value = "創建時間")
private String createTime;
// 描述
@ExcelProperty(index = 3,value = "描述")
private String description;
}
2.3 AnalysisEventListener
實現 AnalysisEventListener接口；
invoke方法用於處理每條數據，讀者可以在這邊進行業務邏輯處理
doAfterAllAnalysed方法是只處理完所有數據后進行的動作；
@Component
public class UserDataListener extends AnalysisEventListener<User> {
// 用於存儲讀取到的數據
private List<User> datas = new ArrayList<User>();
// 這邊你可以注入servie,或者mapper 進行業務邏輯處理后數據入庫
/* *
* @Author lsc
* <p>解析每條數據處理的動作 </p>
* @Param [user, analysisContext]
* @Return void
*/
@Override
public void invoke(User user, AnalysisContext analysisContext) {
datas.add(user);
// do something
}
/* *
* @Author lsc
* <p> 解析所有數據之后處理的動作 </p>
* @Param [analysisContext]
* @Return void
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
// 打印
System.out.println(datas);
// do something
// 清理
datas.clear();
}
}
三 寫入excel
3.1 准備的數據
准備的數據也是一個List集合，存儲讀取的每行數據；
public class DataUtils {
public static List<User> getUserData(){
// 寫入響應
List<User> datas = new ArrayList<User>();
User user = new User();
user.setId(666L);
user.setName("知識追尋者");
user.setCreateTime(LocalDateTime.now().toString());
user.setDescription("跟着知識追尋者學習吧");
datas.add(user);
return datas;
}
}
3.2 寫入
寫入的數據更加簡單，因為有了之前的模型映射；
@Test
public void simpleWrite() {
// 文件名
String fileName = "C:\\mydata\\generator\\知識追尋者.xlsx";
// 寫入
EasyExcel.write(fileName, User.class).sheet("知識追尋者").doWrite(DataUtils.getUserData());
}
四 web上傳下載示例
@RestController
public class ExcelController {
@GetMapping("download")
public void download(HttpServletResponse response) throws IOException {
// 設置 ContentType
response.setContentType("application/vnd.ms-excel");
// 設置字符集
response.setCharacterEncoding("utf-8");
// 防止中文亂碼
String fileName = URLEncoder.encode("知識追尋者", "UTF-8");
// 設置 header
response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
// 寫入
EasyExcel.write(response.getOutputStream(), User.class)
.sheet("知識追尋者")// 指定sheet名稱
.doWrite(DataUtils.getUserData());//寫入數據
}
@PostMapping("upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {
EasyExcel.read(file.getInputStream(), User.class, new UserDataListener())
.sheet()
.doRead();
return "success";
}
}