用于解析excel表格内容到 java bean 目前支持xls、xlsx格式文件 对于大数据量文件自动使用sax方式解析,防止内存溢出
- 开始
- 扩展功能
- 注意
// Maven导入第三方poi依赖,或者直接把master pull下来发布到本地
<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>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.9.1</version>
</dependency>
首先你需要创建好你的实体类,假设现在有这样一个excel表格需要解析
姓名 | 手机号 | 生日 |
---|---|---|
王文娟 | 18888888888 | 1996-01-01 |
大美丽 | 16666666666 | 1996-01-01 |
首先你需要一个实体类 有几点要求,必须正确封装,包含get\set方法 属性上包含必要的Mapping注解,key属性填入与表格对应的名称,属性类型根据需要自己定义
public class People {
@Mapping(key = "姓名")
private String name;
@Mapping(key = "手机号")
private String phone;
@Mapping(key = "生日")
private Date birth;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
}
然后将你的文档以File的方式加载进来,通过以下代码开始解析 现在支持传入流对象了,new Init提供了多个构造(但是当时为什么没弄流对象是因为在测试Apache poi的那个部分的时候,发现使用传入流对象的方法会导致消耗更多的内存)
// Init接受一个File对象,以及一个实体对象
// 调用start开始
// 通过ActionContext获取需要的信息
// 参数依次为-文件-实体class-是否去重
File file = new File("excel.xlsx");
Init<ExcelPojo> init = new Init<ExcelPojo>(file, ExcelPojo.class, false);
ActionContext<ExcelPojo> act = init.start();
// 现在支持传入流对象了,new Init提供了多个构造
(注意:如果要去重的话请重写实体中的hashCode和equals方法,内部使用set来去重,false表示不去重) ActionContext中包含了所需要的所有信息,信息格式如下,这里以json的形式展示
{
"sheets":[
{
"line":5,
"sheetName":"Sheet1",
"column":6,
"correctLine":5,
"blankLineSize":0,
"errorLineSize":0,
"repeatLineSize":0,
"info":[
{
"date":1331481600000,
"name":"王文娟",
"phone":"15035214458"
},
{
"date":1331481600000,
"name":"大美丽",
"phone":"14555874458"
}
],
"blankLine":[],
"errorLine":[],
"repeatLine":[]
}
],
"fileType":"XLSX",
"SheetSize":1,
"fileSizeByte":9138,
"useSax":true,
"distinct":false,
"result":true
}
属性名 | 含义 |
---|---|
sheets | sheet数组 |
line | 解析当前sheet一共多少行数据,不算表头 |
sheetName | sheet的名称 |
column | 列数 |
info | 实体对象数组,包含实体的列表,也就是行数据 |
correctLine | 实际正确解析出的数量(行数) |
blankLineSize | 空行的数量 |
errorLineSize | 错误行的数量,包括正则不通过被删除的 |
repeatLineSize | 重复行的数量 |
fileType | 文件类型 |
blankLine | 空白行的行号-数组 |
errorLine | 错误行的行号-数组 |
repeatLine | 重复行的行号-数组 |
fileSizeByte | 文件大小(字节) |
useSax | 是否使用了sax方式 |
distinct | 是否去重 |
result | 最后是否解析成功,如果中间出错则是false |
sheetSize | 文件中有几个sheet |
useSax | 是否使用sax解析,即是否解析的是xlsx文件 |
distinct | 是否去重 |
使用ActionContext的getXXX方法获取上面的内容
@Mapping注解有三个非必选属性
@Mapping(key = "手机号", rex = "^[0-9]{11}$", delNull = true, length = 11)
private String phone;
属性名 | 含义 | 是否必填 |
---|---|---|
key | 填写与excel文件头的映射名称 | 必填 |
rex | 填写解析内容时使用的正则表达式,如果不符合正则则不赋值 | 非必填 |
delNull | 如果该属性为null的话,是否删除整条信息,默认false不删除 | 非必填 |
length | 填写提取内容的最大长度,默认不限制 | 非必填 |
@LineNumber注解,获取当前记录是第几行,不算表头那行
@LineNumber
private Integer line;
@MappingSheetName注解,将sheet名称作为属性值添加
@MappingSheetName
private String type;
单元测试的最下方有导出的test案例
- 解析xlsx大文件的时候,POI本身会占据较大内存,例如100W行15列,POI自身将消耗400M+的内存,加上解析出来的内容会大于这个值,以100W为例大概需要700M+内存
- 实体中请使用包装类,不支持int等类型,请使用Integer
- 列与列之间不能包含表头为空的列,即不能有空列将信息隔开,如果有,以空列前一列为末尾解析
- excel文件请使用第一行表头,其余行信息的标准格式,如果有合并单元格情况,可能会解析失败(可以包含空行和空单元格,会自动过滤,但必须有表头)
- 实体类的属性不严格要求与列的数量一致,根据需要添加映射注解即可
- 实体类 的属性和表头的顺序没有严格要求,只要key匹配即可
- 如果需要去重,请重写实体的hashCode和equals方法,内部使用HashSet方式去重,重写时请注意
- 最后是否解析成功请以result属性为准
2018/05/11