easyExcel

于 2024-07-21 19:09:53 发布
阅读量1k 收藏 16
点赞数 28
分类专栏： Java高级 笔记及理解 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_51644244/article/details/140592223
版权

easy Excel

EasyExcel官方文档 - 基于Java的Excel处理工具 | Easy Excel 官网

**java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便

完成写

  1. 导入依赖
<!-- EasyExcel -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.3.1</version>
</dependency>
  1. 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    @ExcelProperty(value = "姓名", index = 0)
    private String name;
    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;
    @ExcelProperty(value = "性别", index = 2)
    private String sex;
    @ExcelProperty(value = "地址", index = 3)
    private String address;
}

QQ_1721558373497.png

  1. 测试
@Test
    void write(){
        // 文件输出的路径
        String fileName = System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        List<Student> list = new ArrayList<>();
        list.add(new Student("张三丰", 25,"男","驻马店"));
        list.add(new Student("郭靖", 29,"男", "上蔡县"));
        list.add(new Student("蓉儿", 25,"女", "东洪镇"));
        list.add(new Student("云朵", 15,"女", "赵楼村"));
        EasyExcel.write(fileName, Student.class).sheet("学生信息").doWrite(list);

    }

web 的下载数据

  1. 依赖
<!-- EasyExcel -->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>easyexcel</artifactId>
  <version>3.3.1</version>
</dependency>
  1. controller 层
@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");

    /*后面这些数据可以从数据库中查到*/
    List<Student> list = new ArrayList<>();
    list.add(new Student("张三丰", 25,"男","驻马店"));
    list.add(new Student("郭靖", 29,"男", "上蔡县"));
    list.add(new Student("蓉儿", 25,"女", "东洪镇"));
    list.add(new Student("云朵", 15,"女", "赵楼村"));

    EasyExcel.write(response.getOutputStream(), Student.class).sheet("模板").doWrite(list);
}
  1. 测试

http://localhost:8080/download 浏览器直接打开立马下载

读操作

  1. 导入依赖
<!-- EasyExcel -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.3.1</version>
</dependency>
  1. 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    @ExcelProperty(value = "姓名", index = 0)
    private String name;
    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;
    @ExcelProperty(value = "性别", index = 2)
    private String sex;
    @ExcelProperty(value = "地址", index = 3)
    private String address;
}

QQ_1721558373497.png

  1. 创建监听器
public class DemoDataListener implements ReadListener<Student> {

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
    private List<Student> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    /**
     * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
     */
    private final StudentDao studentDao;

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

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

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

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

    /**
     * 加上存储数据库
     */
    private void saveData() {
        System.out.println("{"+cachedDataList.size()+"}条数据，开始存储数据库！");
        studentDao.save(cachedDataList);
        System.out.println("存储数据库成功！");
    }
}

:::tips
监听器：

  • 由于这里的监听器类并未交给 spring 管理因此上面的 StudenDao不能通过自动注入的方式来直接写，这里采用构造器的方式注入。
  • 这里调用的方法，后面真正调用时就直接存入到数据库了，（最好采用批量添加的方式）
    :::
  1. StudentDao
@Repository
public class StudentDao {
    public void save(List<Student> students) {
        // 我们这里测试先打印出来，后面可以直接添加到数据库
        students.forEach(System.out::println);
        System.out.println("保存成功");
    }
}
  1. 测试
@Test
    void read() throws UnsupportedEncodingException, FileNotFoundException {
        // 文件的绝对路径
        String fileName = "D:\\IdeaProjects\\easyExcel\\easyExcel\\AAA1721460305714.xlsx";
        // 这里默认读取第一个sheet
        EasyExcel.read(fileName, Student.class, new DemoDataListener()).sheet().doRead();
    }

读操作 web

  1. 引入依赖
<!-- EasyExcel -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.3.1</version>
</dependency>
<!-- 文件上传依赖 -->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.4</version>
</dependency>
  1. 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    @ExcelProperty(value = "姓名", index = 0)
    private String name;
    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;
    @ExcelProperty(value = "性别", index = 2)
    private String sex;
    @ExcelProperty(value = "地址", index = 3)
    private String address;
}

QQ_1721558373497.png

  1. 创建监听器
public class DemoDataListener implements ReadListener<Student> {

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
    private List<Student> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    /**
     * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
     */
    private final StudentDao studentDao;

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

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

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

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

    /**
     * 加上存储数据库
     */
    private void saveData() {
        System.out.println("{"+cachedDataList.size()+"}条数据，开始存储数据库！");
        studentDao.save(cachedDataList);
        System.out.println("存储数据库成功！");
    }
}

:::tips
监听器：

  • 由于这里的监听器类并未交给 spring 管理因此上面的 StudenDao不能通过自动注入的方式来直接写，这里采用构造器的方式注入。
  • 这里调用的方法，后面真正调用时就直接存入到数据库了，（最好采用批量添加的方式）
    :::
  1. StudentDao
@Repository
public class StudentDao {
    public void save(List<Student> students) {
        // 我们这里测试先打印出来，后面可以直接添加到数据库
        students.forEach(System.out::println);
        System.out.println("保存成功");
    }
}
  1. controller 层
@Autowired
    private StudentDao studentDao;

    @ResponseBody
    @PostMapping("/upload")
    public String upload(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), Student.class, new DemoDataListener(studentDao)).sheet().doRead();
        return "success";
    }
  1. 这里的测试需要借助**Apipost**** 或 ****postman**

QQ_1721559939960.png
:::tips
这里的参数名和类型都要选择正确，否者就会报空指针异常
:::

gyhwjy
关注
  • 28
    点赞
  • 踩
  • 16
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
EasyExcel 官方使用文档总结
Rsun2018的博客
02-27 1万+
参考： 官方示例 官方api easyexcel github 地址 easyexcel csdn 总结
阿里最简单读取Excel表格 附官方文档
CS555DN的博客
09-02 1247
阿里最简单读取Excel表格 附官方文档
EasyExcel 中文文档
zbh1957282580的博客
01-05 8534
EasyExcel ：在实际项目开发中，有些自有的封装的导入导出很难用，异常麻烦。听闻EasyExcel比较好用，就在开发中用了一波，发现很简单，来分享一波，也顺便巩固。 官方文档：https://alibaba-easyexcel.github.io/index.html ...
easyexcel官方文档_easyexcel快速入门
weixin_39611930的博客
11-23 3935
一 前言本篇是EasyExcel快速入门知识，讲解如何读取，写入excel ,并给出了简单web示例；为什么要使用easyexcel；原因是相比于poi,easyexcel更加轻量级，读取写入API方便，并且在工作中占用内存较小；官方描述如下：Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定...
EasyExcel文档链接与使用示例
最新发布
happyxin_的博客
07-11 599
【代码】EasyExcel文档链接与使用示例。
EasyExcel详解（结合官方文档）
Bananaaay的博客
12-27 1万+
EasyExcel的学习分享
easyExcel官方文档
小六
12-21 2万+
官方文档：https://alibaba-easyexcel.github.io/index.html 最新文档：https://yuque.com/easyexcel
EasyExcel 官方文档总结
热门推荐
chris
12-27 5万+
参考： https://github.com/alibaba/easyexcel/blob/master/docs/API.md 官方api https://github.com/alibaba/easyexcel easyexcel github 地址 https://blog.csdn.net/sinat_32366329/article/details/103109058 e...
easyexcel 官方文档地址
goon202的专栏
12-09 3717
读 · 语雀
POI详文&EasyExcel（EasyExcel直接可看官方文档）.pdf
12-13
这是一篇关于Excel文件操作的文章，主要写的是POI操作，关于EasyExcel建议直接查看官方API文档，写的很详细。所以在这里也没有做过多的整理和总结。如果了解了POI，那么EasyExcel一定没问题，冲吧
easyexcel代码
06-21
EasyExcel是一款由阿里巴巴开源的Java库，专门用于处理Excel数据，尤其在大数据量读写场景下表现出色。它简化了Excel与Java对象之间的转换，提供了简单易用的API，使得开发者无需关注底层复杂的文件格式，可以更加...
easyexcel-3.0.5-API文档-中英对照版.zip
05-04
赠送jar包：easyexcel-3.0.5.jar； 赠送原API文档：easyexcel-3.0.5-javadoc.jar； 赠送源代码：easyexcel-3.0.5-sources.jar； 赠送Maven依赖信息文件：easyexcel-3.0.5.pom； 包含翻译后的API文档：easyexcel-3.0.5-javadoc-API文档-中文(简体)-英语-对照版.zip； Maven坐标：com.alibaba:easyexcel:3.0.5； 标签：alibaba、easyexcel、jar包、java、中英对照文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。 双语对照，边学技术、边学英语。
easyexcel所需依赖包2.1.6版本
05-06
EasyExcel是一款由阿里巴巴开发的轻量级Java处理Excel的库，它简化了读取、写入Excel的操作，尤其在处理大量数据时，性能表现优秀。2.1.6是EasyExcel的一个版本，此版本可能包含了对之前版本的优化和一些新功能的...
easyexcel合并单元格
02-11
原文连接...
alibaba easyexcel
07-18
**阿里云EasyExcel：高效处理超大Excel的Java利器** 在大数据时代，处理Excel文件，尤其是超大型Excel文件，成为了许多企业和开发者面临的重要任务。阿里云EasyExcel正是为了解决这一问题而诞生的一款强大工具。它...
如何使用EasyExcel库来写入Excel文件
07-29
通过以上示例代码，你应该能够理解如何使用EasyExcel库在Java中进行Excel文件的写入操作。这个库提供了简洁的API，使得Excel文件的操作变得非常方便。 总结一下，实现Excel文件写入的步骤包括： 1.引入EasyExcel的...
EasyExcel帮忙文档
rocklee的专栏
12-04 516
https://www.yuque.com/easyexcel/doc/
EasyExcel读写Excel内容
qq_45611467的博客
12-06 363
1.导入依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>1.1.2-beat1</version> </dependency> 2.测试往Excel写入内容 @Test public void simpleWrite() { Stri
EasyExcel
Kodak
12-20 644
简介：导出报表是目前常有功能，当数据量特别大的时候会内存溢出和卡顿页面，poi的操作方式仍然存在内存占用过大的问题,以及存在内存溢出的隐患。无意间查询到阿里开源的EasyExcel框架，发现可以将解析的EXCEL的内存占用控制在KB级别，并且绝对不会内存溢出（内部实现待研究）,还有就是速度极快， 大概100W条记录，十几个字段， 只需要70秒即可完成下载。果断研究阿里开源的Eas...
easyexcel 驼峰
04-11
EasyExcel是一款基于Java的开源Excel操作工具，它提供了简单易用的API，可以方便地读取、写入和操作Excel文件。EasyExcel支持驼峰命名方式，即可以通过注解来指定Java对象与Excel文件之间的映射关系，实现对象与Excel数据的互相转换。 使用EasyExcel进行驼峰命名的步骤如下： 1. 在Java对象的属性上使用注解`@ExcelProperty`，指定属性与Excel列的映射关系。例如： ```java public class User { @ExcelProperty("姓名") private String name; @ExcelProperty("年龄") private Integer age; // 其他属性... } ``` 2. 在读取或写入Excel时，通过`EasyExcel`类提供的API来操作。例如： - 读取Excel文件： ```java List<User> userList = EasyExcel.read("user.xlsx").head(User.class).sheet().doReadSync(); ``` - 写入Excel文件： ```java List<User> userList = new ArrayList<>(); // 添加用户数据到userList... EasyExcel.write("user.xlsx", User.class).sheet().doWrite(userList); ``` 这样，就可以通过EasyExcel实现Java对象与Excel文件之间的数据转换，并且支持驼峰命名方式。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值