Easyexcel简单使用-摩杜云开发者社区

https://easyexcel.opensource.alibaba.com/

依赖

<!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.3.2</version>
</dependency>

读Excel

    /**
     * 最简单的读
     * <p>1. 创建excel对应的实体对象 参照{@link DemoData}
     * <p>2. 由于默认一行行的读取excel，所以需要创建excel一行一行的回调监听器，参照{@link DemoDataListener}
     * <p>3. 直接读即可
     */
    @Test
    public void simpleRead() {
        String fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
        // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
        EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
    }

写Excel

    /**
     * 最简单的写
     * <p>1. 创建excel对应的实体对象 参照{@link com.alibaba.easyexcel.test.demo.write.DemoData}
     * <p>2. 直接写即可
     */
    @Test
    public void simpleWrite() {
        String fileName = TestFileUtil.getPath() + "write" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去读，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());
    }

web上传、下载

   /**
     * 文件下载（失败了会返回一个有部分数据的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.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
        EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());
    }

    /**
     * 文件上传
     * <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";
    }

使用文档：

https://easyexcel.opensource.alibaba.com/docs/current/quickstart/read

实际的案例

web上的上传和下载excel的controller

    @ResponseBody
    @RequestMapping("/upload")
    public Result upload(MultipartFile file) {
        logger.info(" upload file ... ");
        String result = "";
        try {
            EasyExcel.read(file.getInputStream(), InputQianduan1ShouruCuowuBaimingdanEntity.class, new InputQianduan1ShouruCuowuBaimingdanEntityListener(inputQianduan1ShouruCuowuBaimingdanRepository)).sheet().doRead();
            result = "文件上传成功";
            return ResultUtils.success(result);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    @GetMapping("/download")
    public void download(HttpServletResponse response) throws IOException {
        // 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
        EasyExcel.write(response.getOutputStream(), InputQianduan1ShouruCuowuBaimingdanEntity.class).sheet("模板").doWrite(data());
    }
    private List<InputQianduan1ShouruCuowuBaimingdanEntity> data() {
        return inputQianduan1ShouruCuowuBaimingdanRepository.findAll();
    }

读取xlsx文件的Listener

package com.cqsym.shujuluruw.excellistener;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.exception.ExcelDataConvertException;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson.JSON;
import com.cqsym.shujuluruw.entity.InputQianduan1ShouruCuowuBaimingdanEntity;
import com.cqsym.shujuluruw.repository.InputQianduan1ShouruCuowuBaimingdanRepository;
import com.cqsym.shujuluruw.repository.YuanshibiaoMingxiQianduanRepository;
import lombok.extern.slf4j.Slf4j;

import java.util.List;

@Slf4j
public class InputQianduan1ShouruCuowuBaimingdanEntityListener implements ReadListener<InputQianduan1ShouruCuowuBaimingdanEntity> {

    private static final int BATCH_COUNT = 100;
    private List<InputQianduan1ShouruCuowuBaimingdanEntity> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    private InputQianduan1ShouruCuowuBaimingdanRepository inputQianduan1ShouruCuowuBaimingdanRepository;
    public InputQianduan1ShouruCuowuBaimingdanEntityListener(InputQianduan1ShouruCuowuBaimingdanRepository inputQianduan1ShouruCuowuBaimingdanRepository) {
        this.inputQianduan1ShouruCuowuBaimingdanRepository = inputQianduan1ShouruCuowuBaimingdanRepository;
    }

    @Override
    public void invoke(InputQianduan1ShouruCuowuBaimingdanEntity inputQianduan1ShouruCuowuBaimingdanEntity, AnalysisContext analysisContext) {
        log.info("解析到一条数据:{}", JSON.toJSONString(inputQianduan1ShouruCuowuBaimingdanEntity));
        cachedDataList.add(inputQianduan1ShouruCuowuBaimingdanEntity);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (cachedDataList.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }

    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        saveData();
        log.info("所有数据解析完成！");
    }

    @Override
    public void onException(Exception exception, AnalysisContext context) {
        log.error("解析失败，但是继续解析下一行:{}", exception.getMessage());
        // 如果是某一个单元格的转换异常 能获取到具体行号
        // 如果要获取头的信息 配合invokeHeadMap使用
        if (exception instanceof ExcelDataConvertException) {
            ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException)exception;
            log.error("第{}行，第{}列解析异常，数据为:{}", excelDataConvertException.getRowIndex(), excelDataConvertException.getColumnIndex(), excelDataConvertException.getCellData());
        }

    }



    private void saveData() {
        log.info("{}条数据，开始存储数据库！", cachedDataList.size());
        inputQianduan1ShouruCuowuBaimingdanRepository.saveAllAndFlush(cachedDataList);
        log.info("存储数据库成功！");
    }

}