我要评论一、前言
excel 导出功能：大数据量的情况下，很容易出现 oom。
数据量不大没有什么问题，做法是直接查全量数据，然后直接往excel里写。但是当数据量逐渐多了起来后，达到一万多条，导出的时候就会报oom。然后换成了阿里开源的easyexcel，但是导出的时候也不太稳定，偶尔也会出现oom。所以应该是数据量太大了，在写入的时候把内存占满了。解决方式：放弃了查全量数据一次性写入excel的做法，采用分页查询，分批次写入excel的方式，果然不会出现oom了。
封装了一个easyexcel的导出工具类，这样只要在分页查询的基础上写少量的代码，就可以实现分批次写入excel，简化代码的编写并且解决oom的问题。
二、实现
@slf4j
public abstract class easyexcelexport<t, s> {
/**
* easyexcel导出excel表格,每个sheet默认最大10万条数据
*
* @param filename excel文件前缀名
* @param sheetname 表页名
*/
public void easyexcelbatchexport(string filename, string sheetname, httpservletresponse response) {
this.easyexcelbatchexport(filename, sheetname, 100000, response);
}
/**
* 分批次导出excel数据
*
* @param filename excel文件前缀名
* @param sheetsize 每个sheet的数据量,默认10万,excel有限制不能大于1048576
* @param sheetname 表页名
*/
public void easyexcelbatchexport(string filename, string sheetname, integer sheetsize, httpservletresponse response) {
filename = filename + localdatetime.now().format(datetimeformatter.ofpattern("yyyymmddhhmmss")) + ".xlsx";
int currentsheet = 1; // 当前处于第几个sheet
int totalline = 0; // 总共写入的条数
int currentbatch = 1; // 当前写入excel的批次(第几页)
int linenum = 1; // 行号,当前写入的是第几条数据
long starttime = system.currenttimemillis();
try {
response.setcharacterencoding("utf-8");
// 告诉浏览器用什么软件可以打开此文件
response.setheader("content-type", "application/vnd.ms-excel");
// 下载文件的默认名称
response.setheader("content-disposition", "attachment;filename=" + urlencoder.encode(filename, "utf-8"));
excelwriter excelwriter = easyexcel.write(response.getoutputstream(), (class<t>) ((parameterizedtype) getclass().getgenericsuperclass()).getactualtypearguments()[0]).build();
writesheet sheet = easyexcel.writersheet(sheetname).build();
while (true) {
// 获取数据，然后currentbatch+1,下次调用就会获取新的数据
list<s> sourcedatalist = getdata(currentbatch);
currentbatch++;
list<t> exportentitylist = new arraylist<>();
if (collutil.isnotempty(sourcedatalist)) {
totalline += sourcedatalist.size();
log.info("easyexcel开始写入第{}批数据,当前批次数据大小为{}", currentbatch - 1, sourcedatalist.size());
for (s sourcedata : sourcedatalist) {
exportentitylist.add(convertsourcedata2exportentity(sourcedata, linenum));
linenum++;
// 当前sheet数据已经到达最大值，将当前数据全写入当前sheet，下一条数据就会写入新sheet
if (linenum > sheetsize) {
excelwriter.write(exportentitylist, sheet);
exportentitylist.clear();
linenum = 1;
currentsheet++;
sheet = easyexcel.writersheet(sheetname + currentsheet).build();
}
}
// 写入excel
excelwriter.write(exportentitylist, sheet);
} else {
// 未获取到数据,结束
break;
}
}
excelwriter.finish();
} catch (exception e) {
log.error("easyexcel导出异常", e);
}
log.info("easyexcel导出数据结束,总数据量为{},耗时{}ms", totalline, (system.currenttimemillis() - starttime));
}
/**
* 不分批次导出excel。一次性获取所有数据写入excel,确定数据量不大时可以使用该方法，数据量过大时使用分批次导出，否则会oom
*
* @param filename excel文件前缀名
* @param sheetname 表页名
*/
public void easyexcelexport(string filename, string sheetname, httpservletresponse response) {
filename = filename + localdatetime.now().format(datetimeformatter.ofpattern("yyyymmddhhmmss")) + ".xlsx";
int totalline = 0; // 总共写入的条数
int linenum = 1; // 行号,当前写入的是第几条数据
long starttime = system.currenttimemillis();
try {
response.setcharacterencoding("utf-8");
// 告诉浏览器用什么软件可以打开此文件
response.setheader("content-type", "application/vnd.ms-excel");
// 下载文件的默认名称
response.setheader("content-disposition", "attachment;filename=" + urlencoder.encode(filename, "utf-8"));
list<s> sourcedatalist = getdata(1);
list<t> exportentitylist = new arraylist<>();
if (collutil.isnotempty(sourcedatalist)) {
totalline += sourcedatalist.size();
log.info("easyexcel开始写入数据,数据大小为{}", sourcedatalist.size());
for (s sourcedata : sourcedatalist) {
exportentitylist.add(convertsourcedata2exportentity(sourcedata, linenum));
linenum++;
}
}
response.setcharacterencoding("utf-8");
// 告诉浏览器用什么软件可以打开此文件
response.setheader("content-type", "application/vnd.ms-excel");
// 下载文件的默认名称
response.setheader("content-disposition", "attachment;filename=" + urlencoder.encode(filename, "utf-8"));
easyexcel.write(response.getoutputstream(), (class<t>) ((parameterizedtype) getclass().getgenericsuperclass()).getactualtypearguments()[0]).sheet(sheetname).dowrite(exportentitylist);
} catch (exception e) {
log.error("easyexcel导出异常", e);
}
log.info("easyexcel导出数据结束,总数据量为{},耗时{}ms", totalline, (system.currenttimemillis() - starttime));
}
/**
* 将原数据对象转换为需要导出的目标对象
*
* @param sourcedata 原对象
* @param linenum 行号
*/
public abstract t convertsourcedata2exportentity(s sourcedata, integer linenum);
/**
* 获取原始数据,通过currentbatch参数分页获取数据。
*
* @param currentbatch 获取第几批(页)数据,通过该参数分页查询,每次调用自动递增。不分批次导出时可以忽略该参数
*/
public abstract list<s> getdata(int currentbatch);
}
首先，这是easyexcelexport是一个抽象类，指定了泛型 t 和 s，t是target目标类，也就是导出时对应的类，s是source原对象所对应的类。
easyexcelexport里还有两个抽象方法，getdata() 和 convertsourcedata2exportentity() 。
这两个方法是需要在平时使用时自己去实现的，getdata是数据查询的方法，可以在这里面去实现分页查询的逻辑，currentbatch参数是用来控制分页查询页码的，从1开始，会自动递增。如果确定数据量不大不需要分批次导出的话，那么getdata()里只需要进行普通的查询即可，忽略currentbatch参数不用分页查询。还有一个方法是convertsourcedata2exportentity(),这个是用来将对象s转为对象t的方法，因为从数据库查询或者是从其他地方获取到的对象类型可能是s，而导出时需要的对象类型是t，所以通过该方法进行对象转换。
最核心的是 easyexcelbatchexport() 方法，里面有一个while循环，while循环里首先会去调用getdata()方法获取数据，然后将currentbatch加1便于下次获取数据，接下来有个for循环去进行对象的转换并添加到exportentitylist集合中，这个集合中装的是最终写到excel里的对象。当转换完成后就将当前批次的数据写入excel中，然后进行下一次循环，当getdata()方法未获取到数据时，就结束循环。
同时支持指定每个sheet页的最大行数。在对对象进行转换时有一个判断，当前sheet页的数据是否到达指定值，到达后，直接写入excel，然后新建一个sheet页，这样新的数据就会写入新的sheet页。
使用
那么如何使用这个工具类呢。很简单，只要new出easyexcelexport的对象，然后实现一下 convertsourcedata2exportentity() 方法和 getdata() 方法即可，然后再根据需要去调用不同的导出方法即可。导出方法有指定和不指定sheet数据页大小的分批写入方法 easyexcelbatchexport() 和不分批次直接一次性写入的 easyexcelexport() 方法。
下面通过一个小案例展示一下。假设现在有个导出用户列表的需求，数据库user表对应的是userpo类：
@data
@builder
@noargsconstructor
@allargsconstructor
public class userpo {
private long id;
/**
* 用户编号
*/
private string code;
/**
* 姓名
*/
private string name;
/**
* 手机号码
*/
private string phone;
/**
* 性别。1-男，2-女
*/
private integer sex;
}
导出对应的类是userexportentity：
@data
public class userexportentity {
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 0, value = "序号")
private integer line;
@columnwidth(35)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 1, value = "用户编号")
private string code;
@columnwidth(35)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 2, value = "姓名")
private string name;
@columnwidth(35)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 3, value = "手机号码")
private string phone;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 4, value = "性别")
private string sexstr;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 5, value = "fielda")
private string fielda;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 6, value = "fieldb")
private string fieldb;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 7, value = "fieldc")
private string fieldc;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 8, value = "fieldd")
private string fieldd;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 9, value = "fielde")
private string fielde;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 10, value = "fieldf")
private string fieldf;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 11, value = "fieldg")
private string fieldg;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 12, value = "fieldh")
private string fieldh;
@columnwidth(10)
@contentstyle(horizontalalignment = horizontalalignmentenum.center, verticalalignment = verticalalignmentenum.center)
@excelproperty(index = 13, value = "fieldi")
private string fieldi;
}
先测试一下不分批次导出，导出123456条数据。
@getmapping("/testexport")
public void testexport(httpservletresponse response) {
new easyexcelexport<userexportentity, userpo>() {
@override
public userexportentity convertsourcedata2exportentity(userpo sourcedata, integer linenum) {
userexportentity entity = new userexportentity();
entity.setline(linenum);
entity.setcode(sourcedata.getcode());
entity.setname(sourcedata.getname());
entity.setphone(sourcedata.getphone());
entity.setsexstr(objects.equals(sourcedata.getsex(), 1) ? "男" : objects.equals(sourcedata.getsex(), 2) ? "女" : strutil.empty);
return entity;
}
@override
public list<userpo> getdata(int currentbatch) {
list<userpo> userpolist = new arraylist<>();
// 模拟查询数据库，假设每次查询会查出123456条数据
for (int i = 0; i < 123456; i++) {
userpolist.add(userpo.builder()
.code("user_" + randomutil.randomstring("1234567890", 6))
.name(randomutil.randomstring("qwertyuiopasdfghjklzxcvbnm", 10))
.phone("138" + randomutil.randomstring("1234567890", 8))
.sex(randomutil.randomint(1, 3))
.build());
}
log.info("userpolist-->{}", jsonutil.tojsonstr(userpolist));
return userpolist;
}
}.easyexcelexport("测试不分批次导出", "测试不分批次导出", response);
}
为了更清晰地看到效果，我将内存大小限制为128m。
调用一下测试接口，可以看到，导出十几万条数据时发生了oom。
再来看看分批次导出的效果，模拟一下分页查询，假设有200页数据，每页8888条，一共是170多万条数据。
@getmapping("/testbatchexport")
public void testbatchexport(httpservletresponse response) {
new easyexcelexport<userexportentity, userpo>() {
@override
public userexportentity convertsourcedata2exportentity(userpo sourcedata, integer linenum) {
userexportentity entity = new userexportentity();
entity.setline(linenum);
entity.setcode(sourcedata.getcode());
entity.setname(sourcedata.getname());
entity.setphone(sourcedata.getphone());
entity.setsexstr(objects.equals(sourcedata.getsex(), 1) ? "男" : objects.equals(sourcedata.getsex(), 2) ? "女" : strutil.empty);
return entity;
}
@override
public list<userpo> getdata(int currentbatch) {
// 模拟分页查询，假设数据库中有200页数据
if (currentbatch <= 200) {
list<userpo> userpolist = new arraylist<>();
// 模拟查询数据库，假设每次查询会查出8888条数据
for (int i = 0; i < 8888; i++) {
userpolist.add(userpo.builder()
.code("user_" + randomutil.randomstring("1234567890", 6))
.name(randomutil.randomstring("qwertyuiopasdfghjklzxcvbnm", 10))
.phone("138" + randomutil.randomstring("1234567890", 8))
.sex(randomutil.randomint(1, 3))
.build());
}
return userpolist;
} else {
return new arraylist<>();
}
}
}.easyexcelbatchexport("测试分批次导出", "测试分批次导出", response);
}
通过分批次写入excel的方式，成功导出了170多万条数据，相较于不分批次导出，效果显而易见。而且通过调用工具类的方式，进一步简化了导出时代码的编写。
到此这篇关于java使用easyexcel导出上万数据如何避免oom的文章就介绍到这了,更多相关java easyexcel导出数据避免oom内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！
发表评论