java poi SXSSFWorkbook 删除临时文件

原创已于 2024-04-08 11:00:46 修改 · 3.1k 阅读

35 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2024-04-08 10:44:33 首次发布

本文介绍了使用ApachePOI库中的SXSSFWorkbook处理大量Excel数据时，如何避免内存溢出并删除临时文件的方法。方法包括使用SXSSFWorkbook#dispose自动删除临时文件，以及通过反射获取SheetDataWriter._fd并手动删除。作者建议优先使用官方提供的接口来释放资源。

使用的maven依赖:

<!--poi开始-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.16</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.16</version>
</dependency>
<!--poi结束-->

SXSSFWorkbook 一般用于导出海量excel数据的一种方案，如何数据全部放到内存中会导致OOM内存不足，所以在合成过程中超过阈值(SXSSFWorkbook._randomAccessWindowSize成员变量的)，就会把数据刷新到磁盘中，有兴趣可以看一下源码。

SXSSFSheet#createRow 代码清单

本篇文章重点讲如何删除

方案1：

把excel文件流返回给前端后，执行SXSSFWorkbook#dispose方法，会把临时文件删除。

debug。

SXSSFWorkbook#dispose 代码清单

不管创建多少个sheet都会把相关资源释放掉。

SXSSFSheet#dispose 代码清单

SheetDataWriter#dispose 代码清单

注意SheetDataWriter._fd为File成员变量。

综上通过SXSSFWorkbook#dispose方法，会删除响应的临时磁盘文件

方案二：通过reflect反射获取SheetDataWriter._fd成员变量

@Test
public void searchObject()throws IllegalAccessException{
    SXSSFWorkbook workbook=new SXSSFWorkbook(13);
    Sheet sheet = workbook.createSheet("测试");
    Field field = null;
    String fieldName="_writer";
    String[] fieldNames = new String[2];
    fieldNames[0] ="_writer";
    fieldNames[1]="_fd";
    Object searchValue = ReflectUtil.searchObject(sheet,fieldNames);
    System.out.println(searchValue);
}

import java.lang.reflect.Field;
/**
 * 反射工具包
 * @author skl
 */
public class ReflectUtil {

    public static final Object searchObject(Object obj,String[] fieldNames) throws IllegalAccessException{
        Object sub = obj;
        for(String fieldName :fieldNames){
            sub = ReflectUtil.searchObject(sub,fieldName);
        }
        return sub;
    }
    public static final Object searchObject(Object obj,String fieldName)throws IllegalAccessException{
        if(obj == null){
            return null;
        }
        Class clazz =obj.getClass();
        Field[] fields = clazz.getDeclaredFields();
        Field field= null;
        for(Field temp:fields){
            if(temp.getName().equals(fieldName)){
                field = temp;
                break;
            }
        }
        if(field == null){
            return null;
        }
        field.setAccessible(true);
        Object fieldValue = field.get(obj);
        return fieldValue;
    }
}

运行结果：

C:\Users\XX\AppData\Local\Temp\poifiles\poi-sxssf-sheet1403199809394906786.xml

拿到File,在执行SXSSFWorkbook#dispose的地方执行File#delete方法即可删除磁盘文件。

当然了该文章侧重删除产出的临时文件，SXSSFWorkbook#dispose除了删除临时文件还做了其它业务逻辑，感兴趣的小伙伴可以自行看源码。

建议使用官方提供的接口释放相关资源。