工作薄中常用的方法(XSSF)

赖翰

2023-12-01

一.XSSF类

public class XSSFWorkbook extends POIXMLDocument implements Workbook,Date1904Support

构造函数：

构造函数和说明
`XSSFWorkbook()` 创建新的 SpreadsheetML 工作簿。
`XSSFWorkbook(java.io.File file)` 从给定文件构造 XSSFWorkbook 对象。
`XSSFWorkbook(java.io.InputStream is)` 构造一个 XSSFWorkbook 对象，方法是将整个流缓冲到内存中，然后为其打开一个 OPCPackage 对象。
`XSSFWorkbook(OPCPackage pkg)` 构造一个给定 OpenXML4J 对象的 XSSFWorkbook 对象，请参见 http://poi.apache.org/oxml4j/。`Package`
`XSSFWorkbook(PackagePart part)` 使用包部件构造 XSSFWorkbook 对象。
`XSSFWorkbook(java.lang.String path)` 构造给定文件名的 XSSFWorkbook 对象。
`XSSFWorkbook(XSSFFactory factory)`
`XSSFWorkbook(XSSFWorkbookType workbookType)` 创建新的 SpreadsheetML 工作簿。

常用方法

`XSSFSheet`	`createSheet()` 为此工作簿创建一个 XSSFSheet，将其添加到工作表中并返回高级表示形式。
`int`	`getNumberOfSheets()` 获取此工作簿中的工作表数
`XSSFSheet`	`getSheet(java.lang.String name)` 获取包含给定名称的工作表（不区分大小写匹配）
`XSSFSheet`	`getSheetAt(int index)` 获取给定索引处的 XSSFSheet 对象。
`int`	`getSheetIndex(Sheet sheet)` 返回给定工作表的索引
`int`	`getSheetIndex(java.lang.String name)` 按其姓名返回工作表的索引（不区分大小写匹配）
`XSSFCellStyle`	`createCellStyle()` 创建新的 XSSFCellStyle 并将其添加到工作簿的样式表中

类 XSSFSheet

构造函数

修饰语构造函数和说明protectedXSSFSheet()

创建新的 XSSFSheet - 由 XSSFWorkbook 调用以从头开始创建工作表。

创建一个 XSSFSheet，表示给定的包部件和关系。

`int`	`getFirstRowNum()` 获取工作表上的第一行
`int`	`getLastRowNum()` 获取工作表上的最后一行注意：以前有内容并且以后设置为空的行可能仍被Excel和Apache POI计为行，因此此方法的结果将包含此类行，因此返回的值可能高于预期
`XSSFRow`	`createRow(int rownum)` 在工作表中创建新行并返回高级表示法注意：如果此位置已存在一行，则会删除/覆盖该行，并删除任何现有单元格！
`XSSFRow`	`getRow(int rownum)` 返回逻辑行（从 0 开始）。
`java.lang.String`	`getSheetName()` 返回此工作表的名称

XSSFRow 类

public class XSSFRow
extends java.lang.Object
implements Row, java.lang.Comparable<XSSFRow>

构造函数
修饰语	构造函数和说明
`protected`	`XSSFRow(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRow row, XSSFSheet sheet)` 构造一个 XSSFRow。

方法

`XSSFCell`	`createCell(int columnIndex)` 使用此选项可在行中创建新单元格并返回它。
`XSSFCell`	`createCell(int columnIndex, CellType type)` 使用此选项可在行中创建新单元格并返回它。
`short`	`getFirstCellNum()` 获取此行中包含的第一个单元格的从 0 开始的编号。
`short`	`getLastCellNum()` 获取此行中包含的最后一个单元格的索引加 1。

public final class XSSFCell
extends CellBase

修饰语	构造函数和说明
`protected`	`XSSFCell(XSSFRow row, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell cell)` 构造一个 XSSFCell。

方法

`XSSFCellStyle`	`getCellStyle()` 返回单元格的样式。
`CellType`	`getCellType()` 返回单元格类型。

getLastRowNum

如果sheet中一行数据都没有则返回-1，只有第一行有数据则返回0，最后有数据的行是第n行则返回 n-1；

getLastCellNum

如果 row中一列数据都没有则返回-1，只有第一列有数据则返回1，最后有数据的列是第n列则返回 n；

getPhysicalNumberOfRows

获取有记录的行数，即：最后有数据的行是第n行，前面有m行是空行没数据，则返回n-m；

getPhysicalNumberOfCells

获取有记录的列数，即：最后有数据的列是第n列，前面有m列是空列没数据，则返回n-m；

奇怪的是getLastRowNum和getLastCellNum的逻辑不一致，根据方法命名的话，应该是返回最后一行（或一列）的行（列）数。

如果没有行或列应该返回0，而不应该返回-1。而且getLastRowNum 返回的是最后一行的索引而不是最后一行的行数，getLastCellNum 则是返回的最后一列的列数。