EasyExcel 轻松灵活读取Excel内容

时间  2019-11-06
标签 easyexcel 轻松 灵活 读取 excel 内容 栏目 Microsoft Office 繁體版
原文   原文链接

take-it-easy-3842473_1920.jpg

写在前面

Java 后端程序员应该会遇到读取 Excel 信息到 DB 等相关需求，脑海中可能忽然间想起 Apache POI 这个技术解决方案，可是当 Excel 的数据量很是大的时候，你也许发现，POI 是将整个 Excel 的内容所有读出来放入到内存中，因此内存消耗很是严重，若是同时进行包含大数据量的 Excel 读操做，很容易形成内存溢出问题html

但 EasyExcel 的出现很好的解决了 POI 相关问题，本来一个 3M 的 Excel 用 POI 须要100M左右内存, 而 EasyExcel 能够将其下降到几 M，同时再大的 Excel 都不会出现内存溢出的状况，由于是逐行读取 Excel 的内容 (老规矩，这里不用过度关心下图，脑海中有个印象便可，看完下面的用例再回看这个图，就很简单了)java

另外 EasyExcel 在上层作了模型转换的封装，不须要 cell 等相关操做，让使用者更加简单和方便，且看git

简单读

假设咱们 excel 中有如下内容:程序员

咱们须要新建 User 实体，同时为其添加成员变量github

@Data
public class User {

    /**
     * 姓名
     */
    @ExcelProperty(index = 0)
    private String name;

    /**
     * 年龄
     */
    @ExcelProperty(index = 1)
    private Integer age;
}

你也许关注到了 @ExcelProperty 注解，同时使用了 index 属性 (0 表明第一列，以此类推)，该注解同时支持以「列名」name 的方式匹配，好比:web

@ExcelProperty("姓名")
private String name;

按照 github 文档的说明:面试

不建议 index 和 name 同时用，要么一个对象只用index，要么一个对象只用name去匹配
  1. 若是读取的 Excel 模板信息列固定，这里建议以 index 的形式使用，由于若是用名字去匹配，名字重复，会致使只有一个字段读取到数据，因此 index 是更稳妥的方式
  2. 若是 Excel 模板的列 index 常常有变化，那仍是选择 name 方式比较好，不用常常性修改实体的注解 index 数值

因此你们能够根据本身的状况自行选择数据库

编写测试用例
编程

EasyExcel 类中重载了不少个 read 方法，这里不一一列举说明，请你们自行查看；同时 sheet 方法也能够指定 sheetNo，默认是第一个 sheet 的信息后端

上面代码的 new UserExcelListener() 异常醒目，这也是 EasyExcel 逐行读取 Excel 内容的关键所在，自定义 UserExcelListener 继承 AnalysisEventListener

@Slf4j
public class UserExcelListener extends AnalysisEventListener<User> {

    /**
     * 批处理阈值
     */
    private static final int BATCH_COUNT = 2;
    List<User> list = new ArrayList<User>(BATCH_COUNT);

    @Override
    public void invoke(User user, AnalysisContext analysisContext) {
        log.info("解析到一条数据:{}", JSON.toJSONString(user));
        list.add(user);
        if (list.size() >= BATCH_COUNT) {
            saveData();
            list.clear();
        }
    }

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

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

到这里请回看文章开头的 EasyExcel 原理图，invoke 方法逐行读取数据，对应的就是订阅者 1；doAfterAllAnalysed 方法对应的就是订阅者 2，这样你理解了吗？

打印结果:

从这里能够看出，虽然是逐行解析数据，但咱们能够自定义阈值，完成数据的批处理操做，可见 EasyExcel 操做的灵活性

自定义转换器

这是最基本的数据读写，咱们的业务数据一般不可能这么简单，有时甚至须要将其转换为程序可读的数据

性别信息转换

好比 Excel 中新增「性别」列，其性别为男/女，咱们须要将 Excel 中的性别信息转换成程序信息: 「1: 男；2:女」

首先在 User 实体中添加成员变量 gender:

@ExcelProperty(index = 2)
private Integer gender;

EasyExcel 支持咱们自定义 converter，将 excel 的内容转换为咱们程序须要的信息，这里新建 GenderConverter，用来转换性别信息

public class GenderConverter implements Converter<Integer> {

    public static final String MALE = "男";
    public static final String FEMALE = "女";

    @Override
    public Class supportJavaTypeKey() {
        return Integer.class;
    }

    @Override
    public CellDataTypeEnum supportExcelTypeKey() {
        return CellDataTypeEnum.STRING;
    }

    @Override
    public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        String stringValue = cellData.getStringValue();
        if (MALE.equals(stringValue)){
            return 1;
        }else {
            return 2;
        }
    }

    @Override
    public CellData convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        return null;
    }
}
上面程序的 Converter 接口的泛型是指要转换的 Java 数据类型，与 supportJavaTypeKey 方法中的返回值类型一致

打开注解 @ExcelProperty 查看，该注解是支持自定义 Converter 的，因此咱们为 User 实体添加 gender 成员变量，并指定 converter

/**
 * 性别 1：男；2：女
 */
@ExcelProperty(index = 2, converter = GenderConverter.class)
private Integer gender;

来看运行结果:

数据按照咱们预期作出了转换，从这里也能够看出，Converter 能够一次定义处处是用的便利性

日期信息转换

日期信息也是咱们常见的转换数据，好比 Excel 中新增「出生年月」列，咱们要解析成 yyyy-MM-dd 格式，咱们须要将其进行格式化，EasyExcel 经过 @DateTimeFormat 注解进行格式化

在 User 实体中添加成员变量 birth，同时应用 @DateTimeFormat 注解，按照要求作格式化

/**
 * 出生日期
 */
@ExcelProperty(index = 3)
@DateTimeFormat("yyyy-MM-dd HH:mm:ss")
private String birth;

来看运行结果:

若是这里你指定 birth 的类型为 Date，试试看，你获得的结果是什么？

到这里都是以测试的方式来编写程序代码，做为 Java Web 开发人员，尤为在目前主流 Spring Boot 的架构下，因此如何实现 Web 方式读取 Excel 的信息呢？

web 读

简单 Web

很简单，只是将测试用例的关键代码移动到 Controller 中便可，咱们新建一个 UserController，在其添加 upload 方法

@RestController
@RequestMapping("/users")
@Slf4j
public class UserController {
    @PostMapping("/upload")
    public String upload(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), User.class, new UserExcelListener()).sheet().doRead();
        return "success";
    }
}

其实在写测试用例的时候你也许已经发现，listener 是以 new 的形式做为参数传入到 EasyExcel.read 方法中的，这是不符合 Spring IoC 的规则的，咱们一般读取 Excel 数据以后都要针对读取的数据编写一些业务逻辑的，而业务逻辑一般又会写在 Service 层中，咱们如何在 listener 中调用到咱们的 service 代码呢？

先不要向下看，你脑海中有哪些方案呢？

匿名内部类方式

匿名内部类是最简单的方式，咱们须要先新建 Service 层的信息:
新建 IUser 接口:

public interface IUser {
    public boolean saveData(List<User> users);
}

新建 IUser 接口实现类 UserServiceImpl:

@Service
@Slf4j
public class UserServiceImpl implements IUser {
    @Override
    public boolean saveData(List<User> users) {
        log.info("UserService {}条数据，开始存储数据库！", users.size());
        log.info(JSON.toJSONString(users));
        log.info("UserService 存储数据库成功！");
        return true;
    }
}

接下来，在 Controller 中注入 IUser:

@Autowired
private IUser iUser;

修改 upload 方法，以匿名内部类重写 listener 方法的形式来实现:

@PostMapping("/uploadWithAnonyInnerClass")
    public String uploadWithAnonyInnerClass(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), User.class, new AnalysisEventListener<User>(){
            /**
             * 批处理阈值
             */
            private static final int BATCH_COUNT = 2;
            List<User> list = new ArrayList<User>();

            @Override
            public void invoke(User user, AnalysisContext analysisContext) {
                log.info("解析到一条数据:{}", JSON.toJSONString(user));
                list.add(user);
                if (list.size() >= BATCH_COUNT) {
                    saveData();
                    list.clear();
                }
            }

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

            private void saveData(){
                iUser.saveData(list);
            }
        }).sheet().doRead();
        return "success";
    }

查看结果:

这种实现方式，其实这只是将 listener 中的内容所有重写，并在 controller 中展示出来，当你看着这么臃肿的 controller 是否是很是难受？很显然这种方式不是咱们的最佳编码实现

构造器传参

在以前分析 SpringBoot 统一返回源码时，不知道你是否发现，Spring 底层源码多数以构造器的形式传参，因此咱们能够将为 listener 添加有参构造器，将 Controller 中依赖注入的 IUser 以构造器的形式传入到 listener :

@Slf4j
public class UserExcelListener extends AnalysisEventListener<User> {

    private IUser iUser;

    public UserExcelListener(IUser iUser){
        this.iUser = iUser;
    }

    // 省略相应代码...

    private void saveData(){
        iUser.saveData(list); //调用 userService 中的 saveData 方法
    }

更改 Controller 方法:

@PostMapping("/uploadWithConstructor")
public String uploadWithConstructor(MultipartFile file) throws IOException {
    EasyExcel.read(file.getInputStream(), User.class, new UserExcelListener(iUser)).sheet().doRead();
    return "success";
}

运行结果: 同上

这样更改后，controller 代码看着很清晰，但若是后续业务还有别的 Service 须要注入，咱们难道要一直添加有参构造器吗？很明显，这种方式一样不是很灵活。

其实在使用匿名内部类的时候，你也许会想到，咱们能够经过 Java8 lambda 的方式来解决这个问题

Lambda 传参

为了解决构造器传参的痛点，同时咱们又但愿 listener 更具备通用性，不必为每一个 Excel 业务都新建一个 listener，由于 listener 都是逐行读取 Excel 数据，只须要将咱们的业务逻辑代码传入给 listener 便可，因此咱们需用到 Consumer<T> ，将其做为构造 listener 的参数。

新建一个工具类 ExcelDemoUtils，用来构造 listener:

咱们看到，getListener 方法接收一个 Consumer<List<T>> 的参数，这样下面代码被调用时，咱们的业务逻辑也就会被相应的执行了:

consumer.accept(linkedList);

继续改造 Controller 方法:

运行结果: 同上

到这里，咱们只须要将业务逻辑定制在 batchInsert 方法中:

  1. 知足 Controller RESTful API 的简洁性
  2. listener 更加通用和灵活，它更可能是扮演了抽象类的角色，具体的逻辑交给抽象方法的实现来完成
  3. 业务逻辑可扩展性也更好，逻辑更加清晰

总结

到这里，关于如何使用 EasyExcel 读取 Excel 信息的基本使用方式已经介绍完了，还有不少细节内容没有讲，你们能够自行查阅 EasyExcel Github 文档去发现更多内容。灵活使用 Java 8 的函数式接口，更容易让你提升代码的复用性，同时看起来更简洁规范

除了读取 Excel 的读取，还有 Excel 的写入，若是须要将其写入到指定位置，配合 HuTool 的工具类 FileWriter 的使用是很是方便的，针对 EasyExcel 的使用，若是你们有什么问题，也欢迎到博客下方探讨

完整代码请在公众号回复「demo」，点开连接，查看「easy-excel-demo」文件夹的内容便可，另外我的博客因为特殊缘由暂时关闭首页，其余目录访问一切正常，更多文章能够从 https://dayarch.top/archives 入口查看

感谢

很是感谢 EasyExcel 的做者 🌹🌹，让 Excel 的读写更加方便

灵魂追问

  1. 除了 Consumer，若是须要返回值的业务逻辑，须要用到哪一个函数式接口呢？
  2. 当出现复杂表头的时候要如何处理呢？
  3. 将 DB 数据写入到 Excel 并下载，如何实现呢？
  4. 从 EasyExcel 的设计上，你学到了什么，欢迎博客下方留言讨论

提升效率工具

推荐阅读

  1. 此次走进并发的世界，请不要错过
  2. 学并发编程，透彻理解这三个核心是关键
  3. 并发Bug之源有三，请睁大眼睛看清它们
  4. 可见性有序性，Happens-before来搞定
  5. 解决原子性问题？你首先须要的是宏观理解
  6. 面试并发volatile关键字时，咱们应该具有哪些谈资？
欢迎关注个人公众号 「日拱一兵」，趣味原创解析Java技术栈问题，将复杂问题简单化，将抽象问题图形化落地
若是对个人专题内容感兴趣，或抢先看更多内容，欢迎访问个人博客 dayarch.top
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程