关于easyexcel:EasyExcel太方便易用了强烈推荐

零碎中常常要导出大量的数据，格局基本上都是 Excel，然而每次导表都是对系统内存的一次挑战。

在 Java 畛域，生成或解析 Excel 的框架比拟有名的当属 Apache 的 poi 和 jxl 了。但应用它们，会面临着重大的内存损耗问题。如果零碎的并发量还不行，一旦导出大量数据，便会呈现 JVM 频繁 full gc，甚至导致 OOM。

EasyExcel 是阿里巴巴开源的一个 Excel 解决框架，应用简略、节俭内存。节俭内存的原理也很简略，在解析 Excel 时没有将文件数据全副加载到内存当中，而是从磁盘文件中一行行读取。

明天这篇文章就带大家来理解一下 EasyExcel 的应用，集体应用后的感叹是：太简略易用了。

首先创立一个 Maven 我的项目，在 pom 文件中增加如下依赖：

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

当引入该依赖之后，会发现在我的项目的依赖文件中同时多出了 poi 的类库。也就是说，EasyExcel 是基于 poi 来进行实现的，间接地引入了如下依赖：

<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>

所以，当你的我的项目中曾经引入了 poi 的依赖，要考虑一下版本的兼容问题。

EasyExcel 易用性的体现之一就是能够通过在实体类中应用注解的模式，来与 Excel 中的表头进行绑定。

当初间接上实体类：

@Data
public class UserData {@ExcelProperty(index = 0, value = "姓名")
    private String username;

    @ExcelProperty(index = 1, value = "年龄")
    private int age;

    @DateTimeFormat("yyyy-MM-dd")
    @ExcelProperty(index = 2, value = "生日")
    private Date birthday;
}

在下面的实体类中 @Data 为 Lombok 的注解，当然你能够自行生成 getter/setter 办法，其余的注解均为 EasyExcel 提供的：

@ExcelProperty：用于设置 Excel 表头，其中 index 用户表头的编号，从 0 开始；value 为表头对应的内容。
@DateTimeFormat：用于日期的格式化。

实现上述性能筹备工作之后，咱们先来生成一个 Excel。

上面间接展现生成 Excel 的示例代码：

public class EasyExcelDemo {public static void main(String[] args) {
        // 实现 excel 写操作
        //1. 设置写入文件夹地址和 excel 文件名称
        String fileName = "/Users/zzs/temp/excel/write.xlsx";
        // 调用 easyExcel 外面的办法实现写操作
        // 2 个参数，第一个参数是文件名称，第二个参数是实体类
        EasyExcel.write(fileName, UserData.class).sheet("学生信息表").doWrite(getData());
    }

    // 创立办法返回 list 汇合
    public static List<UserData> getData() {List<UserData> list = new ArrayList<>();

        UserData userData1 = new UserData();
        userData1.setUsername("张三");
        userData1.setAge(22);
        userData1.setBirthday(formatDate("2000-10-11"));
        list.add(userData1);

        UserData userData2 = new UserData();
        userData2.setUsername("李四");
        userData2.setAge(23);
        userData2.setBirthday(formatDate("1999-5-3"));
        list.add(userData2);

        return list;
    }

    public static Date formatDate(String birthday) {SimpleDateFormat sdf = new SimpleDateFormat("yyy-MM-dd");
        try {return sdf.parse(birthday);
        } catch (ParseException e) {e.printStackTrace();
        }
        return null;
    }
}

除了筹备数据的代码，外围代码只有 main 办法中调用的 EasyExcel.write 办法，就是如此的简略。EasyExcel 的 write 办法会依据传入的数据和实体类 UserData 进行绑定，生成 Excel 文件。

咱们来看一下 Excel 的成果：

生成成果还不错，而且应用起来是不是非常简单？

再来看看解析 Excel 的操作，间接用下面生成的 Excel 文件。

首先创立一个监听器 ExcelListener，集成 EasyExcel 提供 AnalysisEventListener 类：

public class ExcelListener extends AnalysisEventListener<UserData> {

    /**
     * 一行一行的读取 excel 内容
     */
    @Override
    public void invoke(UserData data, AnalysisContext analysisContext) {System.out.println("****" + data);
    }

    /**
     * 读取表头内容
     */
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {System.out.println("表头" + headMap);
    }

    /**
     * 读取实现操作
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {System.out.println("读取 Excel 结束");
    }
}

在该监听器中，通过重写 AnalysisEventListener 的办法来取得解析的数据、表头信息，以及解析结束之后执行的操作信息。

同样写 Excel 一样，通过 EasyExcel 类的静态方法来执行读操作：

public class EasyExcelReadDemo {public static void main(String[] args) {
        // 实现 excel 写操作
        //1. 设置写入文件夹地址和 excel 文件名称
        String fileName = "/Users/zzs/temp/excel/write.xlsx";
        // 调用 easyExcel 外面的办法实现写操作
        // 2 个参数，第一个参数是文件名称，第二个参数是实体类
        EasyExcel.read(fileName, UserData.class, new ExcelListener()).sheet().doRead();
    }
}

执行上述办法，打印信息如下：

 表头 {0= 姓名, 1= 年龄, 2= 生日}
****UserData(username= 张三, age=22, birthday=Wed Oct 11 00:00:00 CST 2000)
****UserData(username= 李四, age=23, birthday=Mon May 03 00:00:00 CST 1999)
读取 Excel 结束

最先是打印了表头信息，这里也能够看到表头的排序是从 0 开始的。而后，读取并打印了对应的 Excel 内容，两条数据；最初，执行读取完的办法中的日志打印。

看完了下面的整个操作，解析 Excel 是不是变得非常简单了？再也不为解析 Excel 犯愁了。

下面提到的 @DateTimeFormat 注解可转换日期格局，还有其余相似性能的注解和自定义转换器。

通过自定义转换器，比方将 1、0 转换成男、女的实例：

import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.property.ExcelContentProperty;

public class SexConverter implements Converter<Integer> {

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

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

    @Override
    public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {return "男".equals(cellData.getStringValue()) ? 1 : 0;
    }

    @Override
    public CellData<String> convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {return new CellData<>(integer.equals(1) ? "男" : "女");
    }
}

性别属性注入 SexConverter 转换器：

@ExcelProperty(value = "性别", converter = SexConverter.class)
private Integer sex;

再次生成 Excel，性别字段内容便显示为：男、女字样。

比方体重须要保留两位小数，可通过 @NumberFormat 注解实现：

@ExcelProperty(value = "体重 KG")
@NumberFormat("0.##") // 会以字符串模式生成单元格，要计算的列不举荐
private BigDecimal weight;

另外一种办法是应用 @ContentStyle 注解：

@ContentStyle(dataFormat = 2)
private BigDecimal weight2;

这样也能达到保留两位小数的成果。

当然，也能够应用实现 Converter 接口的形式实现（同性别实现）。

在很多场景下，Excel 的列与实体类可能并不完全一致，这时就须要排除一些实体类的字段。

形式一：类上加注解 @ExcelIgnoreUnannotated，过滤属性没有 @ExcelProperty 注解的字段

@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor  // 肯定要有无参构造方法
@ExcelIgnoreUnannotated
public class UserData {.....}

形式二：指定字段加 @ExcelIgnore 注解

@ExcelIgnore // 该字段不生成 excel
private String remark;

形式三：代码指定过滤字段，通过 excludeColumnFiledNames 办法：

        EasyExcel.write(fileName, UserData.class).sheet("学生信息表").excludeColumnFiledNames(Arrays.asList("remark")).doWrite(getData());

这种办法的益处是：同一 Excel 能够在调用办法时排除不同的数据列。

本文介绍了 EasyExcel 的应用，整体而言操作简略、使用方便，提供了不少注解，不便与实体对象之间的关系绑定。而且官网也提供了相干的性能数据，更多的 API 应用大家还能够持续摸索。

无论从性能或易用性上来说，都值得你尝试。特地是长期写一个 Excel 的解析或生成的工具，再也不必惆怅一行行的解析了，连忙珍藏用起来吧。

博主简介：《SpringBoot 技术底细》技术图书作者，热爱钻研技术，写技术干货文章。

公众号：「程序新视界」，博主的公众号，欢送关注~

技术交换：请分割博主微信号：zhuan2quan

关于easyexcel:EasyExcel太方便易用了强烈推荐

背景

我的项目构建及依赖

创立实体类

生成 Excel

解析 Excel

其余相干非凡用法

自定义转换器

保留两位小数

排除指定 Excel 列

小结

Just My Socks（注册教程内含优惠码）

关于easyexcel:EasyExcel太方便易用了强烈推荐

背景

我的项目构建及依赖

创立实体类

生成 Excel

解析 Excel

其余相干非凡用法

自定义转换器

保留两位小数

排除指定 Excel 列

小结

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）