EasyExcel 使用小結

　　EasyExcel是一個基於Java的簡單、省內存的讀寫Excel的開源項目。在盡可能節約內存的情況下支持讀寫百M的Excel。以下是在使用 EasyExcel 的一些小結，參考內容以官方說明文檔為主，總結了使用過程中一些經驗和遇到的問題，相較於官方文檔並不全面，謹作為記錄，具體使用請參照官方使用說明。

引入EasyExcel依賴

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>${easyexcel.version}</version>
</dependency>

最新版本（2021/01/25）2.2.6  版本查看：https://github.com/alibaba/easyexcel/releases

 

EasyExcel 官方使用說明

官方的使用說明：https://www.yuque.com/easyexcel/doc/easyexcel

使用記錄

　　使用方式為 Web 中的讀取，Web 中上傳文件，對數據進行處理后在 Web 中寫出。

上傳文件：

上傳多個文件

<div class="item">
    <form id="form" method="post" action="upload" enctype="multipart/form-data">
        <div class="upload-box">
            選擇文件
            <input type="file" name="uploadFile" id="fileUps" accept=".xls,.xlsx" class="upload"
                   multiple="multiple">
        </div>
        <input type="submit" value="提交" class="upload-box submit"/>
    </form>
    <div id="files-box"></div>
    <p>報價單匯總（只提交報價單）</p>
    <p>只能上傳excel格式文件！</p>
</div>

 Controller：

@PostMapping("upload")
@ResponseBody
public void upload(@RequestParam("uploadFile") MultipartFile[] uploadFileM, HttpServletResponse response) {
    mergeQuotesService.MergeQuotes(uploadFileM, response);
}

讀文件：

for (MultipartFile file : uploadFileM) {
    if (file.getOriginalFilename().contains("報價單")) {
        // 這里 需要指定讀用哪個class去讀，然后讀取第一個sheet 文件流會自動關閉
        try {
            // 標題占兩行，從第三行開始讀取
            EasyExcel.read(file.getInputStream(), Quotes.class, new QuotesListener(quotesResultDto)).sheet().headRowNumber(2).doRead();
        } catch (Exception e) {
            e.printStackTrace();
        }

        /**
         * 原始數據整理
         */
        quotesResultDto.feedBack().forEach(quotes -> removeRepeat.put(quotes.getDrawing() + quotes.getVersion(), new QuotesMergeDto(quotes)));
    }
}

 對象：

Qutote(部分)：

@Data
@ContentRowHeight(12)
@HeadFontStyle(fontHeightInPoints = 10, fontName = "微軟雅黑")
@HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 9)
public class Quotes {

    /**
     * Module Name
     */
    @ColumnWidth(12)
    @ExcelProperty(value = {"加工件", "Module Name"}, index = 0)
    private String moduleName;


    /**
     * SWC Module
     */
    @ColumnWidth(10)
    @ExcelProperty(value = {"加工件", "SWC Module"}, index = 1)
    private String module;

    /**
     * Drawing No.
     */
    @ColumnWidth(18)
    @ExcelProperty(value = {"加工件", "Drawing No."}, index = 2)
    private String drawing;

　　...
}

因為此實體類還參與了后續的寫文件，因此添加了很多自定義樣式的注解，若無此需求則不需要添加，如：

@Data
public class DemoData {
    private String string;
    private Date date;
    private Double doubleData;
}

監聽器：

public class QuotesListener extends AnalysisEventListener<Quotes> {


    List<Quotes> list = new ArrayList<>();

    private Quotes quotes;

    @Autowired
    QuotesResultDAO quotesResult;

    public QuotesListener() {
        quotes = new Quotes();
    }

    public QuotesListener(QuotesResultDAO quotesResult) {
        this.quotesResult = quotesResult;
    }

    /**
     * 這個每一條數據解析都會來調用
     *
     * @param quotes
     * @param analysisContext
     */
    @Override
    public void invoke(Quotes quotes, AnalysisContext analysisContext) {
        list.add(quotes);
    }


    /**
     * 所有數據解析完成了 才會來調用
     *
     * @param analysisContext
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        quotesResult.save(list);
    }

}

持久層：

@Repository
public class QuotesResultDAO {

    List<Quotes> list = new ArrayList<>();

    /**
     * 存儲 Excel 中讀取的數據
     *
     * @param quotes
     */
    public void save(List<Quotes> quotes) {
        list.addAll(quotes);
    }

    /**
     * 返回列表
     *
     * @return
     */
    public List<Quotes> feedBack() {
        /**
         * 在第一次返回數據時清空 list 中的內容，防止數據留存
         */
        List<Quotes> temp = new ArrayList<>();
        temp.addAll(list);
        list.clear();
        return temp;
    }

}

數據處理(讀取&寫出)：

@Service
@RequiredArgsConstructor
public class MergeQuotesServiceImpl implements MergeQuotesService {

    private final QuotesResultDto quotesResultDto;

    // 報價單合並
    public void MergeQuotes(MultipartFile[] uploadFileM, HttpServletResponse response) {

        // 用於對唯一ID進行去重
        Map<String, QuotesMergeDto> removeRepeat = new HashMap<>();
        // 最終合並結果列表
        List<QuotesMergeDto> result = new ArrayList<>();


        for (MultipartFile file : uploadFileM) {
            if (file.getOriginalFilename().contains("報價單")) {
                // 這里 需要指定讀用哪個class去讀，然后讀取第一個sheet 文件流會自動關閉
                try {
                    // 標題占兩行，從第三行開始讀取
                    EasyExcel.read(file.getInputStream(), Quotes.class, new QuotesListener(quotesResultDto)).sheet().headRowNumber(2).doRead();
                } catch (Exception e) {
                    e.printStackTrace();
                }

                /**
                 * 原始數據整理
                 */
                quotesResultDto.feedBack().forEach(quotes -> removeRepeat.put(quotes.getDrawing() + quotes.getVersion(), new QuotesMergeDto(quotes)));
            }
        }

        // 最終的去重數據
        removeRepeat.forEach((k, v) -> result.add(v));

        // 報價單輸出
        MergeResultWrite(result, response);
    }


    /**
     * 報價單輸出
     *
     * @param list
     */
    public void MergeResultWrite(List<QuotesMergeDto> list, HttpServletResponse response) {

        // 這里注意 使用swagger 會導致各種問題，請直接用瀏覽器或者用postman
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 這里URLEncoder.encode可以防止中文亂碼 當然和easyExcel沒有關系
        try {

            String fileName = URLEncoder.encode("匯總報價單", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
            // Excel 寫出合並報價單
            EasyExcel.write(response.getOutputStream(), QuotesMergeDto.class).sheet("sheet1")
                    .doWrite(list);
            // System.out.println("報價單已合並");
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

}

 寫文件：

@Data
@ContentRowHeight(12)
@HeadFontStyle(fontHeightInPoints = 10)
@HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 9)
public class QuotesMergeDto {

    /**
     * Drawing No.
     */
    @ColumnWidth(18)
    @ExcelProperty(value = {"Drawing No."}, index = 0)
    private String drawing;

    /**
     * Version No.
     */
    @ColumnWidth(16)
    @ExcelProperty(value = {"Version No."}, index = 1)
    private String version;

    /**
     * Material
     */
    @ColumnWidth(16)
    @ExcelProperty(value = {"Material"}, index = 2)
    private String material;
    /**
     * Surface Treatment
     */
    @ColumnWidth(25)
    @ExcelProperty(value = {"Surface Treatment"}, index = 3)
    private String surface;
    /**
     * 零件類型
     */
    @ColumnWidth(15)
    @ExcelProperty(value = {"零件類型"}, index = 4)
    private String type;
}

在文件寫出時，可以按照需求設置樣式，最后傳入的 list 並不需要與實體類的類型對應，只會按照實體類的格式進行寫出，index 的值對應 列表對象中元素的位置。

 其它操作

按照序號讀取特定表單：

ExcelReader excelReader = null;
                try {
                    excelReader = EasyExcel.read(file.getInputStream()).build();

                    // 讀取右側第三個 sheet
                    ReadSheet readSheet2 =
                            EasyExcel.readSheet(2).head(Workmanship.class).
                                    registerReadListener(new SummaryListener(summaryResultDto)).headRowNumber(5).build();
                    excelReader.read(readSheet2);
                } catch (Exception e) {
                    e.printStackTrace();
                } finally {
                    if (excelReader != null) {
                        // 這里千萬別忘記關閉，讀的時候會創建臨時文件，到時磁盤會崩的
                        excelReader.finish();
                    }
                }

使用場景：Excel 中有多個 sheet，按照需要讀取所需 sheet。

寫入多個 sheet:

        int number = 0; // 表單的編號 2 　　　　　try {　
            String returnName = URLEncoder.encode("報價單+價格", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + returnName + ".xlsx");
            excelWriter = EasyExcel.write(response.getOutputStream()).build();
            for (MultipartFile file : files) {
                if (file.getOriginalFilename().contains("報價單")) {
                    // 這里 需要指定讀用哪個class去讀，然后讀取第一個sheet 文件流會自動關閉
                    try {
                        EasyExcel.read(file.getInputStream(), Quotes.class, new QuotesListener(quotesResultDto)).sheet().headRowNumber(2).doRead();
                    } catch (Exception e) {
                        System.out.println(file.getOriginalFilename() + "讀取錯誤");
                        e.printStackTrace();
                    }

                    /**
                     * 報價單表內數據
                     */
                    quoteList = quotesResultDto.feedBack();
                    List<QuotesMergePlusPriceDto> list = new ArrayList<>();

                    quoteList.forEach(quotes -> {

                        try {
                            // 父類賦值到子類
                            list.add(FatherToChild.getQuotesMergePlusPriceDto(new QuotesMergePlusPriceDto(), quotes, prices.get(quotes.getDrawing() + "-" + quotes.getVersion())));
                            28                             
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    });


                    String sheetName = file.getOriginalFilename();
                    WriteSheet writeSheet = EasyExcel.writerSheet(number, sheetName).head(QuotesMergePlusPriceDto.class).build();
                    number++;

                    excelWriter.write(list, writeSheet);

                }

            }
        } catch (Exception e) {
            e.printStackTrace();

        } finally {
            // 千萬別忘記finish 會幫忙關閉流
            if (excelWriter != null) {
                excelWriter.finish();
            }
        }

編號對應顏色：

單元格填充顏色：

 

 

@HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 9)

字體顏色：

@ContentFontStyle(color = 10, fontHeightInPoints = 11)

此處參考：https://my.oschina.net/u/3267498/blog/4680918