Springboot使用easyExcel导入导出

EasyExcel Alibaba开源

一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能

• [ ]

最简单的导入

快速完成基本导入功能，有手即可

引入Jar包

        <!--easyexcel，推荐使用3.0 以上版本，功能更加完善-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.1.1</version>
        </dependency>

创建excel对应的实体对象

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

代码

    @RequestMapping(value = "/testFileExcel")
    public String testFileExcel(MultipartFile file) throws IOException {
       // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
        // 这里每次会读取100条数据 然后返回过来 直接调用使用数据就行
        EasyExcel.read(file.getInputStream(), DemoData.class, new PageReadListener<DemoData>(dataList -> {
            for (DemoData demoData : dataList) {
               // 这里就是你处理代码保存的逻辑了
                log.info("读取到一条数据{}", JSON.toJSONString(demoData));
            }
        })).sheet().doRead();
    }

• [ ]

最简单的导出

创建导出excel的对象
可以理解为这就是excel导出的模板

@Getter
@Setter
@EqualsAndHashCode
public class DemoData {
    @ExcelProperty("字符串标题")
    private String string;
    @ExcelProperty("日期标题")
    private Date date;
    @ExcelProperty("数字标题")
    private Double doubleData;
    /**
     * 忽略这个字段（忽略的字段不会导出）
     */
    @ExcelIgnore
    private String ignore;
}

代码

    /**
     * excel导出
     */
    @PostMapping(value = "/fileOutExcel")
    public void fileOutExcel(HttpServletResponse response) throws Exception {
        List<DemoData> list = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            DemoData data = new DemoData();
            data.setString("字符串" + i);
            data.setDate(new Date());
            data.setDoubleData(0.56);
            list.add(data);
        }
        // list：是导出数据
       // new LongestMatchColumnWidthStyleStrategy()： 是导出表头的自动列宽（但不太精确）
        ExcelUtils.webWrite(response, "模板", DemoData.class, "sheet1", list, new LongestMatchColumnWidthStyleStrategy());
    }

webWrite工具代码

    /**
     * 单sheet下载,带自定义拦截器
     *
     * WriteHandler (new LongestMatchColumnWidthStyleStrategy())自定义列宽 不精确
     *
     * 文件下载并且失败的时候返回json（默认失败了会返回一个有部分数据的Excel）
     *
     * @since 2.1.1
     */
    public <T> void webWrite(HttpServletResponse response, String fileName, Class c, String sheetName, List<T> data, WriteHandler writeHandler) throws IOException {
        // 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
        try {
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
            fileName = URLEncoder.encode(fileName, "UTF-8");
            response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
            // 这里需要设置不关闭流
            EasyExcel.write(response.getOutputStream(), c).registerWriteHandler(writeHandler).autoCloseStream(Boolean.FALSE).sheet(sheetName)
                    .doWrite(data);
        } catch (Exception e) {
            log.error("导出异常{}", e);
            e.printStackTrace();
            // 重置response
            response.reset();
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            Map<String, String> map = new HashMap<String, String>();
            map.put("code", "11");
            map.put("msg", "下载文件失败" + e.getMessage());
            response.getWriter().println(JSON.toJSONString(map));
        }
    }

注意：
1.在导入保存数据时，使用批量插入数据库的方式控制范围保持在每次200-500条内
2.EasyExcel还有很多强大的功能，足矣满足大部分的需求可参考官网https://easyexcel.opensource.alibaba.com/