记录一下今天遇到的一个 POI 导出 Excel 报错 权限不足 的问题
今天测试环境有人反映,说是报表导出的时候,导出来的报表一片空白,甚至于连表头都没有
我第一反映是,最近也没有动过代码呀,唯一有改动的就是切换了一下启动服务的账号
随即登上服务器看日志,错误信息如下:
java.lang.RuntimeException: java.io.IOException: 权限不够
at org.apache.poi.xssf.streaming.SXSSFWorkbook.createAndRegisterSXSSFSheet(SXSSFWorkbook.java:662)
at org.apache.poi.xssf.streaming.SXSSFWorkbook.createSheet(SXSSFWorkbook.java:679)
at org.apache.poi.xssf.streaming.SXSSFWorkbook.createSheet(SXSSFWorkbook.java:90)
at com.alibaba.excel.util.WorkBookUtil.createSheet(WorkBookUtil.java:51)
at com.alibaba.excel.context.WriteContext.currentSheet(WriteContext.java:112)
at com.alibaba.excel.write.ExcelBuilderImpl.addContent(ExcelBuilderImpl.java:69)
at com.alibaba.excel.ExcelWriter.write(ExcelWriter.java:78)
从异常栈中可以定位到是 SXSSFWorkbook.java
662 行抛出的异常
找到 SXSSFWorkbook.java
的 662 行可以看到以下代码:
SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet) {
final SXSSFSheet sxSheet;
try {
sxSheet = new SXSSFSheet(this,xSheet);
} catch (IOException ioe) {
throw new RuntimeException(ioe);//662行抛出异常的地方
}
registerSheetMapping(sxSheet,xSheet);
return sxSheet;
}
从上面的代码中可以看出,是在执行 new SXSSFSheet(this,xSheet)
的时候出现了异常,然后异常被捕获,重新抛出了一个运行时异常。
具体是什么原因造成的异常就还需要再看看执行 new SXSSFSheet(this,xSheet)
的时候,SXSSFSheet
对应的构造函数干了啥,找到这个构造函数,代码如下:
public SXSSFSheet(SXSSFWorkbook workbook, XSSFSheet xSheet) throws IOException {
_workbook = workbook;
_sh = xSheet;
_writer = workbook.createSheetDataWriter();
setRandomAccessWindowSize(_workbook.getRandomAccessWindowSize());
_autoSizeColumnTracker = new AutoSizeColumnTracker(this);
}
在上面的代码中,看到在 SXSSFSheet
的这个构造函数中执行了一些赋值的操作,经过一番查看,发现问题应该是出在 workbook.createSheetDataWriter()
这个调用里面。
再往下跟进去,会发现最终都会调用到 SheetDataWriter
这个类的无参构造方法,构造方法代码如下:
public SheetDataWriter() throws IOException {
_fd = createTempFile();
_out = createWriter(_fd);
}
据方法名不难看出,构造函数里面的操作应该是,创建临时文件,然后根据创建好的临时文件,再创建一个 Sheet 的 Writer。
跟到这里大概已经找到问题的原因了,应该就是当前启动服务的账号,没有临时文件目录的写入权限,具体的临时文件保存路径在哪里呢?
跟到 createTempFile
这个方法中便知道了,进入到 createTempFile
方法一路跟下去会看到 org.apache.poi.util.DefaultTempFileCreationStrategy#createPOIFilesDirectory
这个方法,代码如下:
private void createPOIFilesDirectory() throws IOException {
// Identify and create our temp dir, if needed
// The directory is not deleted, even if it was created by this TempFileCreationStrategy
if (dir == null) {
String tmpDir = System.getProperty(JAVA_IO_TMPDIR);
if (tmpDir == null) {
throw new IOException("Systems temporary directory not defined - set the -D" + JAVA_IO_TMPDIR + " jvm property!");
}
dir = new File(tmpDir, POIFILES);
}
createTempDirectory(dir);
}
方法中有两个常量 JAVA_IO_TMPDIR
和 POIFILES
。
两个常量的值分别为 java.io.tmpdir
和 poifiles
。
这个方法,就可以看出,临时文件的创建路径为:系统配置的 java.io.tmpdir
路径下的 poifiles
目录下。
如果没有手动设置过 java.io.tmpdir
的值的话,在 Linux 下获取到这个配置的默认的路径应该是 /tmp
目录。
那么,临时文件的创建路径为 /tmp/poifiles
。这时再去看下这个临时文件目录的权限,果然当前启动服务的账号没有写入权限,所以导出的时候报了权限不足的异常。
解决这个最粗暴的方式,直接使用 chmod -R 777 /tmp/poifiles
将临时文件目录权限设为 777,或者是在服务启动的时候设置临时文件的路径为当前启动服务的账号有权限写入的路径,可以使用 System.setProperty(java.io.tmpdir, "xxxx")
来设置,也可以在启动时加 -Djava.io.tmpdir=xxxx
来设置。