如何使用EasyExcel

本文参考EasyExcel使用手册:EasyExcel官方使用手册

本人在最近一次项目中使用到了excel导入和导出功能,第一想法是使用之前比较熟悉的apache poi 方法,但是之前貌似在哪刷到过关于 Alibaba EasyExcel 的一些消息,自称是比 apache poi 无论是性能上还是开发效率上都要好得多。

于是乎就抱着很新奇的一种心态来试试。

首先,来看看怎样把包加载到项目中:

在maven开发环境下,只需要在maven仓库中搜索easyexcel 就能找到对应的jar包,并把该内容复制到项目 pom.xml中自动导入即可

		<!--解析Excel-->
        <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.1.4</version>
        </dependency>

然后我们来看看导入的功能,到底EasyExcel有哪些值得我们惊艳的地方:

1、选择文件或文件夹上传,我们能在后端收到 一个或多个MultipartFile对象

2、不管你对上传上来的MultipartFile对象做了啥不可描述的事情,最终我还是要使用的

3、请睁大你们的双眼,重头戏要来了。。。

private void parseMultipartFile(MultipartFile file){
    List<SubsectionInfo> list = EasyExcel.read(file.getInputStream()).
                        head(SubsectionInfo.class).sheet().doReadSync();
}

ok啦,哇,这么简单,不敢相信,牛掰!此处省略300字赞词。。。

不过在此之前还得准备一点东西,看出来了吗?
没错,就是SubsectionInfo类,那么这个类用来干啥呢?
相信一些小伙伴已经猜到了,这个类就是把上传的excel文件每一列中的标题栏与对象中的字段映射对应。
抓了抓脑壳,那么这该如何实现呢,其实easyexcel已经给我们想好了,如下所示:

@Data
public class SubsectionInfo {

    @ExcelProperty("正文")
    private String content;

    @ExcelProperty("标题")
    private String title;

    @ExcelProperty("来源")
    private String sourceType;

    @ExcelProperty("网址")
    private String website;

}

其中,@ExcelProperty(“正文”) 中的是在excel表中列的标题栏目名称

不过官方并不建议用以上这种方式,因为这种方式会一次性把你的数据全部加载到内存中,然后返回给你,你拿到这个对象数组继续操作,在此过程中如果excel中的数据量很大,有极大程度会引起OOM异常。

那么我们应该如何来改良这个方法呢,官方也给出了对应的方式(增加监听器)

private void parseMultipartFile(MultipartFile file){
    EasyExcel.read(file.getInputStream(), new SubsectionInfoListener()).
                       head(SubsectionInfo.class).sheet().doRead();
}
// 有个很重要的点 DemoDataListener 不能被spring管理,要每次读取excel都要new,
// 然后里面用到spring可以构造方法传进去
public class SubsectionInfoListener extends AnalysisEventListener<SubsectionInfo> {

    private static final Logger LOGGER = LoggerFactory.getLogger(SubsectionInfoListener.class);

    /**
     * 每隔100条存储数据库,实际使用中可以3000条,然后清理list ,方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    List<SubsectionInfo> list = new ArrayList<SubsectionInfo>();
    /**
     * 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
     */
    private DemoDAO demoDAO;

    public SubsectionInfoListener() {
        // 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
//        demoDAO = new DemoDAO();
    }

    /**
     * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
     *
     * @param demoDAO
     */
    public SubsectionInfoListener(DemoDAO demoDAO) {
        this.demoDAO = demoDAO;
    }

    /**
     * 这个每一条数据解析都会来调用
     *
     * @param data
     *            one row value. Is is same as {@link AnalysisContext#readRowHolder()}
     * @param context
     */
    @Override
    public void invoke(SubsectionInfo data, AnalysisContext context) {
        LOGGER.info("解析到一条数据:{}", JSON.toJSONString(data));
        list.add(data);
        // 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
        if (list.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
            list.clear();
        }
    }

    /**
     * 所有数据解析完成了 都会来调用
     *
     * @param context
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 这里也要保存数据,确保最后遗留的数据也存储到数据库
        saveData();
        LOGGER.info("所有数据解析完成!");
    }

    /**
     * 加上存储数据库
     */
    private void saveData() {
        LOGGER.info("{}条数据,开始存储数据库!", list.size());
        demoDAO.save(list);
        LOGGER.info("存储数据库成功!");
    }

当然还有很多自定义的导入功能,我就不在这一一列举了,有兴趣的可以到上方官方使用手册中查看

下面,我们来看导出
	public static void write(Class<?> clazz) throws IOException {
        HttpServletResponse response = WebUtils.getResponse();
        List<?> resultList = new ArrayList<>();
        //此处省略 resultList 数据库查找赋值过程
        //.......
        EasyExcel.write(response.getOutputStream(), clazz).sheet("模板").doWrite(resultList);
    }
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值