cn.hutool.poi.excel.sax.Excel07SaxReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hutool-poi Show documentation
Show all versions of hutool-poi Show documentation
Hutool POI工具类（对Office文档、OFD等操作）
package cn.hutool.poi.excel.sax;
import cn.hutool.core.io.IORuntimeException;
import cn.hutool.core.io.IoUtil;
import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.ReflectUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.poi.excel.sax.handler.RowHandler;
import cn.hutool.poi.exceptions.POIException;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackageAccess;
import org.apache.poi.xssf.eventusermodel.XSSFReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;
/**
* Sax方式读取Excel文件
* Excel2007格式说明见：http://www.cnblogs.com/wangmingshun/p/6654143.html
*
* @author Looly
* @since 3.1.2
*/
public class Excel07SaxReader implements ExcelSaxReader {
private final SheetDataSaxHandler handler;
/**
* 构造
*
* @param rowHandler 行处理器
*/
public Excel07SaxReader(RowHandler rowHandler) {
this.handler = new SheetDataSaxHandler(rowHandler);
}
/**
* 设置行处理器
*
* @param rowHandler 行处理器
* @return this
*/
public Excel07SaxReader setRowHandler(RowHandler rowHandler) {
this.handler.setRowHandler(rowHandler);
return this;
}
// ------------------------------------------------------------------------------ Read start
@Override
public Excel07SaxReader read(File file, int rid) throws POIException {
return read(file, RID_PREFIX + rid);
}
@Override
public Excel07SaxReader read(File file, String idOrRidOrSheetName) throws POIException {
try (OPCPackage open = OPCPackage.open(file, PackageAccess.READ)){
return read(open, idOrRidOrSheetName);
} catch (InvalidFormatException | IOException e) {
throw new POIException(e);
}
}
@Override
public Excel07SaxReader read(InputStream in, int rid) throws POIException {
return read(in, RID_PREFIX + rid);
}
@Override
public Excel07SaxReader read(InputStream in, String idOrRidOrSheetName) throws POIException {
try (final OPCPackage opcPackage = OPCPackage.open(in)) {
return read(opcPackage, idOrRidOrSheetName);
} catch (IOException e) {
throw new IORuntimeException(e);
} catch (InvalidFormatException e) {
throw new POIException(e);
}
}
/**
* 开始读取Excel，Sheet编号从0开始计数
*
* @param opcPackage {@link OPCPackage}，Excel包，读取后不关闭
* @param rid Excel中的sheet rid编号，如果为-1处理所有编号的sheet
* @return this
* @throws POIException POI异常
*/
public Excel07SaxReader read(OPCPackage opcPackage, int rid) throws POIException {
return read(opcPackage, RID_PREFIX + rid);
}
/**
* 开始读取Excel，Sheet编号从0开始计数
*
* @param opcPackage {@link OPCPackage}，Excel包，读取后不关闭
* @param idOrRidOrSheetName Excel中的sheet id或者rid编号或sheet名，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
* @return this
* @throws POIException POI异常
*/
public Excel07SaxReader read(OPCPackage opcPackage, String idOrRidOrSheetName) throws POIException {
try {
return read(new XSSFReader(opcPackage), idOrRidOrSheetName);
} catch (OpenXML4JException e) {
throw new POIException(e);
} catch (IOException e) {
throw new IORuntimeException(e);
}
}
/**
* 开始读取Excel，Sheet编号从0开始计数
*
* @param xssfReader {@link XSSFReader}，Excel读取器
* @param idOrRidOrSheetName Excel中的sheet id或者rid编号或sheet名，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
* @return this
* @throws POIException POI异常
* @since 5.4.4
*/
public Excel07SaxReader read(XSSFReader xssfReader, String idOrRidOrSheetName) throws POIException {
// 获取共享样式表，样式非必须
try {
this.handler.stylesTable = xssfReader.getStylesTable();
} catch (IOException | InvalidFormatException ignore) {
// ignore
}
// 获取共享字符串表
// POI-5.2.0开始返回值有所变更，导致实际使用时提示方法未找到，此处使用反射调用，解决不同版本返回值变更问题
//this.handler.sharedStrings = xssfReader.getSharedStringsTable();
this.handler.sharedStrings = ReflectUtil.invoke(xssfReader, "getSharedStringsTable");
return readSheets(xssfReader, idOrRidOrSheetName);
}
// ------------------------------------------------------------------------------ Read end
// --------------------------------------------------------------------------------------- Private method start
/**
* 开始读取Excel，Sheet编号从0开始计数
*
* @param xssfReader {@link XSSFReader}，Excel读取器
* @param idOrRidOrSheetName Excel中的sheet id或者rid编号或sheet名，从0开始，rid必须加rId前缀，例如rId0，如果为-1处理所有编号的sheet
* @return this
* @throws POIException POI异常
* @since 5.4.4
*/
private Excel07SaxReader readSheets(XSSFReader xssfReader, String idOrRidOrSheetName) throws POIException {
this.handler.sheetIndex = getSheetIndex(xssfReader, idOrRidOrSheetName);
InputStream sheetInputStream = null;
try {
if (this.handler.sheetIndex > -1) {
// 根据 rId# 或 rSheet# 查找sheet
sheetInputStream = xssfReader.getSheet(RID_PREFIX + (this.handler.sheetIndex + 1));
ExcelSaxUtil.readFrom(sheetInputStream, this.handler);
this.handler.rowHandler.doAfterAllAnalysed();
} else {
this.handler.sheetIndex = -1;
// 遍历所有sheet
final Iterator sheetInputStreams = xssfReader.getSheetsData();
while (sheetInputStreams.hasNext()) {
// 重新读取一个sheet时行归零
this.handler.index = 0;
this.handler.sheetIndex++;
sheetInputStream = sheetInputStreams.next();
ExcelSaxUtil.readFrom(sheetInputStream, this.handler);
this.handler.rowHandler.doAfterAllAnalysed();
}
}
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw new POIException(e);
} finally {
IoUtil.close(sheetInputStream);
}
return this;
}
/**
* 获取sheet索引，从0开始
*
* - 传入'rId'开头，直接去除rId前缀
* - 传入纯数字，表示sheetIndex，通过{@link SheetRidReader}转换为rId
* - 传入其它字符串，表示sheetName，通过{@link SheetRidReader}转换为rId
*
*
* @param xssfReader {@link XSSFReader}，Excel读取器
* @param idOrRidOrSheetName Excel中的sheet id或者rid编号或sheet名称，从0开始，rid必须加rId前缀，例如rId0，如果为-1处理所有编号的sheet
* @return sheet索引，从0开始
* @since 5.5.5
*/
private int getSheetIndex(XSSFReader xssfReader, String idOrRidOrSheetName) {
// rid直接处理
if (StrUtil.startWithIgnoreCase(idOrRidOrSheetName, RID_PREFIX)) {
return Integer.parseInt(StrUtil.removePrefixIgnoreCase(idOrRidOrSheetName, RID_PREFIX));
}
// sheetIndex需转换为rid
final SheetRidReader ridReader = SheetRidReader.parse(xssfReader);
if (StrUtil.startWithIgnoreCase(idOrRidOrSheetName, SHEET_NAME_PREFIX)) {
// name:开头的被认为是sheet名称直接处理
idOrRidOrSheetName = StrUtil.removePrefixIgnoreCase(idOrRidOrSheetName, SHEET_NAME_PREFIX);
final Integer rid = ridReader.getRidByNameBase0(idOrRidOrSheetName);
if (null != rid) {
return rid;
}
} else {
// 尝试查找名称
Integer rid = ridReader.getRidByNameBase0(idOrRidOrSheetName);
if (null != rid) {
return rid;
}
try {
final int sheetIndex = Integer.parseInt(idOrRidOrSheetName);
rid = ridReader.getRidBySheetIdBase0(sheetIndex);
// 如果查找不到对应index，则认为用户传入的直接是rid
return ObjectUtil.defaultIfNull(rid, sheetIndex);
} catch (NumberFormatException ignore) {
// 非数字，说明非index，且没有对应名称，抛出异常
}
}
throw new IllegalArgumentException("Invalid rId or id or sheetName: " + idOrRidOrSheetName);
}
// --------------------------------------------------------------------------------------- Private method end
}