EasyExcel使用筆記

官方Github地址：https://github.com/alibaba/easyexcel

官方使用說明：https://alibaba-easyexcel.github.io/index.html

使用步驟：

1. 在頁面上新增導入按鈕和文件選擇框，代碼參考：

   <a id="btnImport" class="easyui-linkbutton" data-options="iconCls:'icon-save'" onclick="selectFile()" style="float: right;">導入</a>

   <input id="filebox" name="filebox" type="file" onchange="uploadFile()" style="float:right;display:none;" />

2. 加入JavaScript方法調用后台，代碼參考：

       function selectFile(){
           $("#filebox").click();
       }
       function uploadFile() {
           if(isLowerIE10()){
               $.messager.alert('錯誤', "當前瀏覽器版本太低，請使用IE10及以上或者其他瀏覽器",'error');
           } else {
               var file = $("#filebox").val();    
                if (file.endWith(".xlsx")) {
                   var options = {
                       type : 'post',
                       url : "upload.do",
                       dataType : 'json',
                       complete : function(result) {
                           $('#dg').datagrid("loaded");
                           var result = result.responseJSON;
                           $.messager.alert('操作提示', result.msg,'info',function(){
                               $('#dg').datagrid('reload');
                           });
                       }
                   }
                   $('#dg').datagrid("loading");
                   $("#searchForm").ajaxSubmit(options);
               } else {
                   $.messager.alert('錯誤', "請選擇Excel2007以上版本文件，擴展名：xlsx",'error');
               }
           }
       }

3. 后台控制器Controller中接受文件流並傳給業務層做進一步處理，代碼參考

       @RequestMapping("upload.do")
       @ResponseBody
       public Result upload(HttpServletRequest req, @RequestParam(value = "filebox") MultipartFile file) {
           Result result = Result.getInstanceError();
           try {
               result = prodlineBugService.importByExcel(file);
           } catch (Exception e) {
               log.error("產線不良Excel導入異常:", e);
               result.setMsg(e.getMessage());
           }
           return result;
       }

4. 業務層service

   public Result importByExcel(MultipartFile file) throws IOException {
           EasyExcel.read(file.getInputStream(), ProdlineBugVO.class, new ProdlineBugListener(this)).sheet().autoTrim(true)
                   .doRead();
           return Result.getInstanceSuccess();
       }

5. 業務對象VO用注解標識一下列名。

   @ExcelIgnoreUnannotated
   public class ProdlineBugVO {
   
       /**
        * ID
        */
       @ExcelProperty(value = "ID")
       private Long id;
       /**
        * 期間(yyyy-mm)
        */
       private String yearMonth;
       /**
        * 供應商編碼
        */
       @ExcelProperty(value = "供應商編碼")
       private String supplierCode;
       /**
        * 物料編碼
        */
       @ExcelProperty(value = "物料編碼")
       private String itemNumber;
       /**
        * 包含Y 不包含N
        */
       @ExcelProperty(value = "不良數")
       private BigDecimal bugNum;
       /**
        * 總數
        */
       private BigDecimal totalNum;
       /**
        * 包含Y 不包含N
        */
       @ExcelProperty(value = "工單號")
       private String icmoCode;
       /**
        * 描述
        */
       @ExcelProperty(value = "描述")
       private String description;
       /**
        * 季度考核ID
        */
       private Long quarterExamineId;
       /**
        * 發生時間
        */
       @ExcelProperty(value = "發生日期")
       private Date actualTime;
   
       private String itemName;
       private String supplierName;
       /** excel行號 */
       private Integer rowIndex;
   
       /**
        * 設置 ID
        */
       public Long getId() {
           return id;
       }
   
       /**
        * 獲取 ID
        */
       public void setId(Long id) {
           this.id = id;
       }
   
       /**
        * 設置 期間(yyyy-mm)
        */
       public String getYearMonth() {
           return yearMonth;
       }
   
       /**
        * 獲取 期間(yyyy-mm)
        */
       public void setYearMonth(String yearMonth) {
           this.yearMonth = yearMonth;
       }
   
       /**
        * 設置 供應商編碼
        */
       public String getSupplierCode() {
           return supplierCode;
       }
   
       /**
        * 獲取 供應商編碼
        */
       public void setSupplierCode(String supplierCode) {
           this.supplierCode = supplierCode;
       }
   
       /**
        * 設置 物料編碼
        */
       public String getItemNumber() {
           return itemNumber;
       }
   
       /**
        * 獲取 物料編碼
        */
       public void setItemNumber(String itemNumber) {
           this.itemNumber = itemNumber;
       }
   
       public BigDecimal getBugNum() {
           return bugNum;
       }
   
       public void setBugNum(BigDecimal bugNum) {
           this.bugNum = bugNum;
       }
   
       public BigDecimal getTotalNum() {
           return totalNum;
       }
   
       public void setTotalNum(BigDecimal totalNum) {
           this.totalNum = totalNum;
       }
   
       /**
        * 設置 包含Y 不包含N
        */
       public String getIcmoCode() {
           return icmoCode;
       }
   
       /**
        * 獲取 包含Y 不包含N
        */
       public void setIcmoCode(String icmoCode) {
           this.icmoCode = icmoCode;
       }
   
       /**
        * 設置 描述
        */
       public String getDescription() {
           return description;
       }
   
       /**
        * 獲取 描述
        */
       public void setDescription(String description) {
           this.description = description;
       }
   
       /**
        * 設置 季度考核ID
        */
       public Long getQuarterExamineId() {
           return quarterExamineId;
       }
   
       /**
        * 獲取 季度考核ID
        */
       public void setQuarterExamineId(Long quarterExamineId) {
           this.quarterExamineId = quarterExamineId;
       }
   
       /**
        * 設置 發生時間
        */
       public Date getActualTime() {
           return actualTime;
       }
   
       /**
        * 獲取 發生時間
        */
       public void setActualTime(Date actualTime) {
           this.actualTime = actualTime;
       }
   
       /**
        * 創建人(郵箱)
        */
       private String createBy;
       /**
        * 創建時間
        */
       private Date createTime;
       /**
        * 更新人(郵箱)
        */
       private String updateBy;
       /**
        * 更新時間
        */
       private Date updateTime;
   
       public String getCreateBy() {
           return createBy;
       }
   
       public void setCreateBy(String createBy) {
           this.createBy = createBy;
       }
   
       public Date getCreateTime() {
           return createTime;
       }
   
       public void setCreateTime(Date createTime) {
           this.createTime = createTime;
       }
   
       public String getUpdateBy() {
           return updateBy;
       }
   
       public void setUpdateBy(String updateBy) {
           this.updateBy = updateBy;
       }
   
       public Date getUpdateTime() {
           return updateTime;
       }
   
       public void setUpdateTime(Date updateTime) {
           this.updateTime = updateTime;
       }
   
       public String getItemName() {
           return itemName;
       }
   
       public void setItemName(String itemName) {
           this.itemName = itemName;
       }
   
       public String getSupplierName() {
           return supplierName;
       }
   
       public void setSupplierName(String supplierName) {
           this.supplierName = supplierName;
       }
   
       public Integer getRowIndex() {
           return rowIndex;
       }
   
       public void setRowIndex(Integer rowIndex) {
           this.rowIndex = rowIndex;
       }
   }

6. 定義好Listener來調用保存方法。

   public class ProdlineBugListener extends AnalysisEventListener<ProdlineBugVO> {
       private Logger log = LoggerFactory.getLogger(this.getClass());
       
       /** 一次處理的數量,防止一次處理的過多造成oom */
       private static final int BATCH_COUNT = 5000;
       
       List<ProdlineBugVO> list = new ArrayList<ProdlineBugVO>();
       
       private ProdlineBugService prodlineBugService;
       
       public ProdlineBugListener() {
       }
   
       public ProdlineBugListener(ProdlineBugService prodlineBugService) {
           this.prodlineBugService = prodlineBugService;
       }
       
       @Override
       public void invoke(ProdlineBugVO data, AnalysisContext context) {
           data.setRowIndex(context.readRowHolder().getRowIndex() + 1);
           list.add(data);
           if (list.size() >= BATCH_COUNT) {
               // 達到BATCH_COUNT再處理，防止內存中存儲過大數據，容易OOM
               prodlineBugService.batchSave(list);
               list.clear();
           }
       }
   
       @Override
       public void doAfterAllAnalysed(AnalysisContext arg0) {
           // 這里也要保存數據，確保最后遺留的和不到batch_count的數據也存儲到數據庫
           prodlineBugService.batchSave(list);
       }
   }

注意事項

1. 事務問題：如果不想Excel處理過程中被分成好多比事務，那請將讀Excel的方法寫到有事務控制的業務層。這樣，當某一行內容校驗失敗，拋出異常，前面的操作就會回滾。
2. 對於日期格式，可以用Date來接收。框架默認已經支持很多常用的數字格式，例如："yyyy-MM-dd"等，但如果沒有解析成功，那就需要使用@DateTimeFormat("yyyy年MM月dd日")注解配置
3. @ExcelProperty注解支持按列名或列索引來配置表頭，如果使用列名的方式，那即使列順序變更也不會影響讀數據。但千萬不要2種方式同時配置。
4. 對於少數Excel單元格內容格式不確定的情況（比如動態內容導入）。可能無法定義明確的VO值對象，可以使用Map<Integer, Object>來接受行內容。key是列索引。
   1. 如果單元格內容為空，map中不會有這個單元格對應的Entry，所以不要用EntrySet來循環
   2. 可以一開始就記錄好表頭的列數量，然后用這個列數量來循環Map，這樣就知道哪一列是空的了。
5. 如果Excel中有空行，框架會自動跳過不會調用invoke方法。
6. autoTrim如果是true，讀單元格內容時會自動trim。
7. 框架默認第一行是表頭，數據是從第二行開始的。如果不是可以使用headRowNumber方法指定。
8. 該框架已經解決了POI頭疼的性能問題而且簡化了很多Excel讀寫的代碼。更多功能可以參考官方github