SXSSFWorkbook.write 向 FileOutputStream 写入大文件

Question

我正在尝试使用 SXSSFWorkbook 从头开始编写 Excel 电子表格。

      wb = SXSSFWorkbook(500)
      wb.isCompressTempFiles = true
      sh = streamingWorkbook.createSheet(t.getMessage("template.sheet.name"))

一切都很好，但是当我调用最终代码时：

    val out = FileOutputStream(localPath)
    wb.write(out)
    out.close()
    // dispose of temporary files backing this workbook on disk
    wb.dispose()

我得到了一个巨大的 excel 文件，而不是我期望的压缩 XLSX。我尝试手动压缩文件，我可以从 120MB 的文件压缩到 9MB。那我错过了什么？

使用：Kotlin 和

    implementation group: 'org.apache.poi', name: 'poi-ooxml', version: '4.1.2'  // For `.xlsx` files

-- 更新一

我的印象是 xlsx 是本质上包含 xml 数据的压缩文件 [1]。通过 XSSFWorkbook 和 SXSSFWorkbook 输出的 POI 至少可以压缩 10 个数量级。我用这个简单的代码来演示：

fun main() {
  val workbook = XSSFWorkbook()
  writeRowsAndSave(workbook, "test.xlsx")
  workbook.close()

  val streamingWorkbook = SXSSFWorkbook(IN_MEMORY_ROWS_WINDOW_SIZE)
  streamingWorkbook.isCompressTempFiles = true
  writeRowsAndSave(streamingWorkbook, "test-streaming.xlsx")
  streamingWorkbook.dispose()
}

private fun writeRowsAndSave(workbook: Workbook, fileName: String) {
  val ROWS_COUNT = 2_000
  val COLS_COUNT = 1_000

  val sheet = workbook.createSheet("Test Sheet 1")
  for (i in 1..ROWS_COUNT) {
    val row = sheet.createRow(i)
    println("Row $i")
    for(j in 1..COLS_COUNT) {
        row.createCell(j).setCellValue("Test $i")
    }
  }

  FileOutputStream("./$fileName").use {
      workbook.write(it)
  }
}

这会产生 5MB 的文件，压缩后大约有 439KB (?!)。

Answer 1

SXSSFWorkbook 默认使用内联字符串而不是共享字符串 table。这意味着 SXSSFWorkbook 直接在 sheet 中写入文本，即使它是相同文本的多次。 XSSFWorkbook 和 Excel 的 GUI 都使用共享字符串 table，其中文本获取索引，相同的文本仅存储一次，索引用于 sheet然后。但这应该不会对结果 *.xlsx 的文件大小产生太大影响。

SXSSFWorkbook，以及所有其他 Office Open XML 格式的文件，apache poi 创建，使用 org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream 压缩。它使用 deflate 作为压缩算法，使用 Deflater.DEFAULT_COMPRESSION 作为默认压缩级别。可以覆盖 SXSSFWorkbook 的 protected ZipArchiveOutputStream createArchiveOutputStream(OutputStream out) 以设置另一个压缩级别。但这也不会对生成的 *.xlsx 的文件大小产生太大影响。

示例 Java 代码：

import java.io.File;
import java.io.OutputStream;
import java.io.FileOutputStream;

import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;

import org.apache.commons.compress.archivers.zip.Zip64Mode;
import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
import java.util.zip.Deflater;

class CreateSXSSFDifferentCompression {

 static SXSSFWorkbook createSXSSFWorkbook(int compressionLevel, int rowAccessWindowSize, 
                                          boolean compressTmpFiles, boolean useSharedStringsTable) {
  SXSSFWorkbook workbook = null;
  if (compressionLevel != Deflater.DEFAULT_COMPRESSION) {
   workbook = new SXSSFWorkbook(null, rowAccessWindowSize, compressTmpFiles, useSharedStringsTable) {
    protected ZipArchiveOutputStream createArchiveOutputStream(OutputStream out) {
     ZipArchiveOutputStream zos = new ZipArchiveOutputStream(out);
     zos.setUseZip64(Zip64Mode.AsNeeded);  
     zos.setLevel(compressionLevel);
     return zos;
    }    
   }; 
  } else {
   workbook = new SXSSFWorkbook(null, rowAccessWindowSize, compressTmpFiles, useSharedStringsTable);
  }
  return workbook;
 }

 public static void main(String[] args) throws Exception {

  SXSSFWorkbook workbook = null;

  // uses Deflater.DEFAULT_COMPRESSION and inline strings
  //workbook = createSXSSFWorkbook(Deflater.DEFAULT_COMPRESSION, 500, true, false); 

  // uses Deflater.DEFAULT_COMPRESSION and shared strings table
  //workbook = createSXSSFWorkbook(Deflater.DEFAULT_COMPRESSION, 500, true, true); 

  // uses Deflater.BEST_COMPRESSION and inline strings
  workbook = createSXSSFWorkbook(Deflater.BEST_COMPRESSION, 500, true, false); 

  // uses Deflater.BEST_COMPRESSION and shared strings table
  //workbook = createSXSSFWorkbook(Deflater.BEST_COMPRESSION, 500, true, true); 

  int ROWS_COUNT = 2000;
  int COLS_COUNT = 1000;

  Sheet sheet = workbook.createSheet("Test Sheet 1");
  for (int i = 1 ; i <= ROWS_COUNT; i++) {
   Row row = sheet.createRow(i);
   //System.out.println("Row " + i);
   for(int j = 1; j <= COLS_COUNT; j++) {
    row.createCell(j).setCellValue("Test " + i);
   }
  }

  FileOutputStream out = new FileOutputStream("./Excel.xlsx");
  workbook.write(out);
  out.close();
  workbook.close();
  workbook.dispose();

  File file = new File("./Excel.xlsx");
  System.out.println(file.length());

 }
}

这导致 Excel.xlsx 文件大小：

5,031,034 字节当使用 Deflater.DEFAULT_COMPRESSION 和内联字符串时。

4,972,663 字节当使用 Deflater.DEFAULT_COMPRESSION 和共享字符串 table 时。

4,972,915 字节当使用 Deflater.BEST_COMPRESSION 和内联字符串时。

并且 4,966,749 字节当使用 Deflater.BEST_COMPRESSION 和共享字符串 table 时。

已用：Java 12、apache poi 4.1.2、Ubuntu Linux。

对于 2,000 行 x 1,000 列的传播sheet，我既不会说那么大，也不会说不同设置的影响很大。

条目压缩得很好。

如果您查看 Excel.xlsx ZIP 存档，您会发现使用内联字符串时未压缩的大小为 xl/worksheets/sheet1.xml 112,380,273 字节。 xl/sharedStrings.xml 的未压缩大小为 138 字节，仅包含非常基本的 XML.

如果使用共享字符串table，则xl/worksheets/sheet1.xml的未压缩大小为68,377,273字节，xl/sharedStrings.xml的未压缩大小为49,045字节，包含2,000个条目。

如果Excel本身保存*.xlsx个文件，当内容相同时，它会创建文件大小大致相同的文件。所以 Excel 本身使用相同的压缩级别。

当然，当再次将Excel.xlsx 存储到*.zip 存档时，可以进一步压缩*.xlsx 文件。但这不是 Excel 期望的 *.xlsx 文件。

Microsoft 表示 What are the benefits of Open XML Formats?:

Compact files Files are automatically compressed and can be up to 75 percent smaller in some cases. The Open XML Format uses zip compression technology to store documents, offering potential cost savings as it reduces the disk space required to store files and decreases the bandwidth needed to send files via e-mail, over networks, and across the Internet. When you open a file, it is automatically unzipped. When you save a file, it is automatically zipped again. You do not have to install any special zip utilities to open and close files in Office.

这里的重要部分是：

When you open a file, it is automatically unzipped. When you save a file, it is automatically zipped again.

这意味着，如果 apache poi 会使用 Microsoft Office 本身之外的其他方法或压缩级别来压缩文件，那么 Microsoft Office 将无法对文件 apache poi 已创建。

因此，由于 apache poi 创建的文件 Excel (Microsoft Office) 可以直接打开，因此它使用与 Excel 相同的压缩方法和压缩级别 (Microsoft Office) 就可以了。

SXSSFWorkbook.write 向 FileOutputStream 写入大文件

SXSSFWorkbook.write to FileOutputStream writes huge files

java

openxml

apache-poi

kotlin