Alibaba Easy Excel - 简单、省内存的Java解析Excel工具 |...

世界哪有真情
1,016 阅读3分钟

说明

EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel

下载

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.0.5</version>
</dependency>

读取

1.自定义实体类解析数据
import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
    @ExcelProperty("标题1")
    private String title1;

    @ExcelProperty("标题2")
    private String title2;

    @ExcelProperty("标题3")
    private String title3;
}

2.编写监听类
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;

import java.util.List;

@Slf4j
public class DemoDataListener implements ReadListener<DemoData> {

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
    private List<DemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);

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

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

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

3.开始读取
EasyExcel.read(文件路径, DemoData.class, new DemoDataListener()).sheet().doRead();

*注： DemoData：自定义解析Excel数据的实体类；DemoDataListener：自定义用于监听数据读取过程的类

web读取

    /**
     * 文件上传
     * 
     */
    @PostMapping("upload")
    @ResponseBody
    public String upload(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), UploadData.class, new UploadDataListener(uploadDAO)).sheet().doRead();
        return "success";
    }

*注： UploadData：自定义解析Excel数据的实体类；UploadDataListener：自定义用于监听数据读取过程的类

写入

1.创建实体类
import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
    @ExcelProperty("标题1")
    private String title1;

    @ExcelProperty("标题2")
    private String title2;

    @ExcelProperty("标题3")
    private String title3;

    /**
     * 忽略这个字段
     */
    @ExcelIgnore
    private String ignore;
}

2.开始写入
ArrayList<DemoData> list = new ArrayList<>();
DemoData demoData = new DemoData();
demoData.setTitle1("1");
demoData.setTitle2("2");
demoData.setTitle3("3");
list.add(demoData);
list.add(demoData);
EasyExcel.write(文件路径, DemoData.class).sheet("模板").doWrite(list);

*注：DemoData：自定义解析Excel数据的实体类

模板写入

1.填充模板
在excel中对应需求的单元格写上 ${属性} ，即可根据模板导入， 若对象类型 则写{对象属性.属性}
2.开始写入
EasyExcel.write(生成excel的路径, DemoData.class).withTemplate(excel模板路径).sheet().doWrite(excel数据);

web响应

1.接口代码
    @GetMapping("/financial/statements/export")
    @ApiOperation(value = "财务报表导出")
    public void financialStatementsExport(HttpServletResponse response) throws Exception {
        String fileName = "财务报表导出" + DateUtil.format(new Date(), "yyyyMMddHHmmss") + ".xlsx";
        //response输出文件流
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(fileName, "UTF-8"));
        //写入
        EasyExcel.write(response.getOutputStream())
            .head(DemoData.class)
            .sheet("Sheet1")
            .doWrite(memberIncomeLogsBoList);
    }
2.前端代码
window.location.href = "接口访问路径"

更多

www.yuque.com/easyexcel/d…

注意

也许你的项目中已经使用了apach poi 例如：

image.png 那你在引入Easy Excel时，会产生冲突，导出报错等问题，因为Easy Excel包含了poi引发的

解决方案

1.更改项目中的poi的版本如下3.17：

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.17</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.17</version>
</dependency>
<dependency> 
    <groupId>org.apache.poi</groupId> 
    <artifactId>poi-ooxml-schemas</artifactId> 
    <version>3.17</version> 
</dependency>
<dependency>
   <groupId>cglib</groupId>
   <artifactId>cglib</artifactId>
   <version>3.1</version>
</dependency>
<!-- <dependency>
   <groupId>org.apache.commons</groupId>
   <artifactId>commons-collections4</artifactId>
   <version>4.1</version>
</dependency> -->

2.排除Easy Excel中的poi

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.6</version>
    <exclusions>
        <exclusion>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml-schemas</artifactId>
        </exclusion>
    </exclusions>
</dependency>

*注：以上是经测试过的，能对的上的版本，你也可以尝试其他的版本。

异常：

java.lang.VerifyError: class net.sf.cglib.core.DebuggingClassWriter overrides final method visit.(IILjava/lang/String;Ljava/lang/String;Ljava/lang/String;[Ljava/lang/String;)V

原因:

SpringBoot的项目，在SpringBoot的架构中已经存在了cglib的jar包。这时候如果再在POM文件中引入cglib的jar包，并且在代码中导入使用的是cglib的类，就会导致asm类的版本冲突，导致报错。

解决: 在POM文件中去掉自己引入的cglib的包,采用SpringBoot默认带的cglib包。

avatar
文章
阅读
粉丝