ExcelReader (Excel Write/Read Framework 0.5.12 API)

java.lang.Object
- org.ttzero.excel.reader.ExcelReader

所有已实现的接口:

Closeable, AutoCloseable
```
public class ExcelReader
extends Object
implements Closeable
```
Excel读取工具
ExcelReader提供一组静态的read(java.nio.file.Path)方法，支持Iterator和Stream+Lambda读取xls和xlsx文件，你可以像操作集合类一样操作Excel。通过Row.to(java.lang.Class<T>)和Row.too(java.lang.Class<T>)方法可以将行数据转为指定对象，还可以使用Row.toMap()方法转为LinkedHashMap，同时Row也提供更基础的类似于JDBC方式获取单元格的值。

使用ExcelReader读取文件时不需要提前判断文件格式，Reader已内置类型判断并加载相应的解析器， ExcelReader默认只能解析xlsx格式，如果需要解析xls则必须将eec-e3-support添加到classpath，它包含一个 BIFF8Reader用于解析BIFF8编码的xls格式文件。为保证功能统一几乎所有接口都由eec定义由support实现，大多数情况下ExcelReader和BIFF8Reader提供相同的功能，所以用ExcelReader读取excel文件时只需要一份代码

读取过程中可能会产生一些临时文件，比如SharedString索引等临时文件，所以读取结束后需要关闭流并删除临时文件，建议使用try...with...resource块

一个典型的读取示例如下：
```
 try (ExcelReader reader = ExcelReader.read(path)) {
     // 读取所有工作表并打印
     reader.sheets().flatMap(Sheet::rows)
         .forEach(System.out::println);
 } catch (IOException e) { }
```
作者:

guanquan.wang on 2018-09-22

字段概要

字段
限定符和类型	字段和说明
`static int`	`COPY_ON_MERGED` 解析模式-复制合并单元格的值
`protected Drawings`	`drawings` 图片管理器
`protected boolean`	`hasFormula` 是否包含公式标记，此标记不可信，因为它只检查是否包含`calcChain.xml`文件，并不检查单元格中的内嵌公式。
`protected static org.slf4j.Logger`	`LOGGER` LOGGER
`static Set<String>`	`MUST_CHECK_PART` 配置必要的安全检查项，解析Excel文件之前会检查是否包含这些必须项，只要有一个不包含就抛`ExcelReadException`异常，可以在外部移除/添加检查项，当前支持的资源类型看请查看`Const.ContentType`
`protected int`	`option` 解析模式 0: `VALUE_ONLY` 2: `VALUE_AND_CALC` 4: `COPY_ON_MERGED`
`protected Sheet[]`	`sheets` 保存所有工作表，读取工作表之前必须调用`Sheet.load()`方法加载初始信息
`protected Styles`	`styles` 全局的样式管理器
`protected Path`	`tempDir` 临时文件路径，读文件过程中产生的临时文件
`static int`	`VALUE_AND_CALC` 解析模式-解析公式
`static int`	`VALUE_ONLY` 解析模式-只解析值（默认）
`protected ZipFile`	`zipFile` Excel原始文件

构造器概要

构造器
限定符	构造器和说明
`protected`	`ExcelReader()`
	`ExcelReader(InputStream stream)` 以只读"值"的方式读取Excel字节流
	`ExcelReader(InputStream stream, int option)` 指定解析模式读取Excel文件
	`ExcelReader(InputStream stream, int bufferSize, int cacheSize, int option)`
	`ExcelReader(Path path)` 以只读"值"的方式读取指定路径的Excel文件
	`ExcelReader(Path path, int option)` 指定解析模式读取Excel文件
	`ExcelReader(Path path, int bufferSize, int cacheSize, int option)` 指定解析模式读取Excel文件

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Sheet[]`	`all()` 获取全部工作表，通过此方法获取的工作表在读取前需要先调用`load`方法
`static long`	`cellRangeToLong(String r)` 将单元格坐标转为long类型，Excel单元格坐标由列+行组成如A1, B2等，转为long类型后第`0-16`位为列号`17-48`位为行号单元格坐标 \| 转换后long值 ------------\|------------ A1 \| 65537 AA10 \| 655387
`protected ContentType`	`checkContentType()` 解析Content_Types并进行安全检查，必要安全检查不通过将抛`ExcelReadException`异常，必要检查项配置在`MUST_CHECK_PART`中，外部可以视情况进行添加/移除
`void`	`close()` 关闭流并删除临时文件
`ExcelReader`	`copyOnMergeCells()` 复制合并单元格，默认情况下合并单元格的值仅存储在第一个单元格中其他单元格没有值。
`AppInfo`	`getAppInfo()` Excel文件基础信息包含作者、日期等信息，在windows操作系统上使用鼠标右键->属性->详细信息查看
`ZipEntry`	`getEntry(String name)` 从压缩包中获取一个压缩文件
`static ZipEntry`	`getEntry(ZipFile zipFile, String name)` 从压缩包中获取一个压缩文件，为了兼容windows和linux系统的路径会进行`'/'`和`'\\'` 两种分隔符匹配，如果路径无法匹配则遍历压缩包所有文件并忽略大小写匹配
`InputStream`	`getEntryStream(String name)` 从压缩包中获取一个压缩文件字节流
`protected AppInfo`	`getGeneralInfo()` 解析`docProps/app.xml`和`docProps/core.xml`文件获取文件基础信息，比如创建者、创建时间、分类等信息
`int`	`getSize()` 获取当前excel包含的工作表数量
`Styles`	`getStyles()` 获取一个全局的样式对象 `Styles`
`ExcelType`	`getType()` 获取当前Excel的文件类型，返回`xlsx`或`xls`，当文件不是excel时返回`unknown`
`static ExcelType`	`getType(Path path)` 判断文件格式，读取少量文件头字节来判断是否为BIFF和ZIP的文件签名
`boolean`	`hasFormula()` 已过时。此方法无法准确反映工作簿是否包含公式，这里仅检查是否包含一个通用的calcChain文件，某些工具生成的Excel文件不包含calcChain文件而是内嵌在每个单元格中，这部分公式只有在读取单元格时才明确知道，通过`Row.hasFormula(int)`可以精准判断某些单元格是否包含公式。
`protected ExcelReader`	`init(Path path, int bufferSize, int cacheSize, int option)` 初始化，初始化过程将进行内容检查，和创建全局属性（样式，字符共享区）以及工作表但不会实际读取工作表
`List<Drawings.Picture>`	`listPictures()` 获取Excel包含的所有图片，`Drawings.Picture`对象包含工作表的单元格行列信息，最重要的是包含`localPath`属性，它是图片的临时路径可以通过此路径复制图片
`ExcelReader`	`parseFormula()` 强制解析公式，将所有工作表转换为`CalcSheet`，也可以在单个工作表中使用`Sheet.asCalcSheet()`转换单个工作表
`static ExcelReader`	`read(InputStream stream)` 以只读"值"的方式读取Excel字节流
`static ExcelReader`	`read(InputStream stream, int option)` 指定解析模式读取Excel文件
`static ExcelReader`	`read(InputStream stream, int bufferSize, int option)` 指定解析模式读取Excel字节流
`static ExcelReader`	`read(InputStream stream, int bufferSize, int cacheSize, int option)` 指定解析模式读取Excel字节流
`static ExcelReader`	`read(Path path)` 以只读"值"的方式读取指定路径的Excel文件
`static ExcelReader`	`read(Path path, int option)` 指定解析模式读取Excel文件
`static ExcelReader`	`read(Path path, int bufferSize, int option)` 指定解析模式读取Excel文件
`static ExcelReader`	`read(Path path, int bufferSize, int cacheSize, int option)` 指定解析模式读取Excel文件，如果文件为`xls`格式将加载`org.ttzero.excel.reader.BIFF8Reader` 如果要支持`xls`格式需要将`eec-e3-support`添加进classpath，如果未识别到文件类型则抛`ExcelReadException`
`Sheet`	`sheet(int index)` 获取指定位置的工作表，此方法默认`load`工作表所以外部无需再次调用`load`方法
`Sheet`	`sheet(String sheetName)` 获取指定名称的工作表，此方法默认`load`工作表所以外部无需再次调用`load`方法
`protected Sheet`	`sheetFactory(int option)` 通过OPTION创建相应工作表
`Stream<Sheet>`	`sheets()` 返回一个工作表的流，它将按顺序解析当前excel包含所有工作表（含隐藏工作表），此方法默认`load`工作表所以外部无需再次调用`load`方法
`static String`	`toZipPath(String path)` 将string转换为zip允许的路径，将相对路径的前缀去掉

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
    LOGGER
  - VALUE_ONLY
```
public static final int VALUE_ONLY
```
    解析模式-只解析值（默认）
    
    另请参阅:
    
    常量字段值
  - VALUE_AND_CALC
```
public static final int VALUE_AND_CALC
```
    解析模式-解析公式
    
    另请参阅:
    
    常量字段值
  - COPY_ON_MERGED
```
public static final int COPY_ON_MERGED
```
    解析模式-复制合并单元格的值
    
    另请参阅:
    
    常量字段值
  - sheets
```
protected Sheet[] sheets
```
    保存所有工作表，读取工作表之前必须调用Sheet.load()方法加载初始信息
  - tempDir
```
protected Path tempDir
```
    临时文件路径，读文件过程中产生的临时文件
  - option
```
protected int option
```
    解析模式
    - 0: VALUE_ONLY
    - 2: VALUE_AND_CALC
    - 4: COPY_ON_MERGED
  - hasFormula
```
protected boolean hasFormula
```
    是否包含公式标记，此标记不可信，因为它只检查是否包含calcChain.xml文件，并不检查单元格中的内嵌公式。
  - drawings
```
protected Drawings drawings
```
    图片管理器
  - styles
```
protected Styles styles
```
    全局的样式管理器
  - zipFile
```
protected ZipFile zipFile
```
    Excel原始文件
  - MUST_CHECK_PART
```
public static final Set<String> MUST_CHECK_PART
```
    配置必要的安全检查项，解析Excel文件之前会检查是否包含这些必须项，只要有一个不包含就抛ExcelReadException异常，可以在外部移除/添加检查项，当前支持的资源类型看请查看Const.ContentType
- 构造器详细资料
  - ExcelReader
```
protected ExcelReader()
```
  - ExcelReader
```
public ExcelReader(InputStream stream)
            throws IOException
```
    以只读"值"的方式读取Excel字节流
    
    参数:
    
    stream - excel字节流
    
    抛出:
    
    IOException - if I/O error occur
  - ExcelReader
```
public ExcelReader(InputStream stream,
                   int option)
            throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    stream - excel字节流
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    抛出:
    
    IOException - if I/O error occur
  - ExcelReader
```
public ExcelReader(InputStream stream,
                   int bufferSize,
                   int cacheSize,
                   int option)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(Path path)
            throws IOException
```
    以只读"值"的方式读取指定路径的Excel文件
    
    参数:
    
    path - excel绝对路径
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - ExcelReader
```
public ExcelReader(Path path,
                   int option)
            throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    path - excel文件路径
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - ExcelReader
```
public ExcelReader(Path path,
                   int bufferSize,
                   int cacheSize,
                   int option)
            throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    path - excel文件路径
    
    bufferSize - 共享字符区的大小，默认64
    
    cacheSize - 共享字符区缓存大小，默认512
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    抛出:
    
    IOException - if path not exists or I/O error occur
- 方法详细资料
  - read
```
public static ExcelReader read(Path path)
                        throws IOException
```
    以只读"值"的方式读取指定路径的Excel文件
    
    参数:
    
    path - excel绝对路径
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream)
                        throws IOException
```
    以只读"值"的方式读取Excel字节流
    
    参数:
    
    stream - excel字节流
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    path - excel文件路径
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    stream - excel字节流
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int bufferSize,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel文件
    
    参数:
    
    path - excel文件路径
    
    bufferSize - 共享字符区的大小，默认64
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int bufferSize,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel字节流
    
    参数:
    
    stream - excel字节流
    
    bufferSize - 共享字符区的大小，默认64
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int bufferSize,
                               int cacheSize,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel字节流
    
    参数:
    
    stream - excel字节流
    
    bufferSize - 共享字符区的大小，默认16
    
    cacheSize - 共享字符区的缓存大小，默认512
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - getType
```
public ExcelType getType()
```
    获取当前Excel的文件类型，返回xlsx或xls，当文件不是excel时返回unknown
    
    返回:
    
    ExcelType枚举
  - sheets
```
public Stream<Sheet> sheets()
```
    返回一个工作表的流，它将按顺序解析当前excel包含所有工作表（含隐藏工作表），此方法默认load工作表所以外部无需再次调用load方法
    
    返回:
    
    一个顺序的工作表流
  - sheet
```
public Sheet sheet(int index)
```
    获取指定位置的工作表，此方法默认load工作表所以外部无需再次调用load方法
    
    参数:
    
    index - 工作表在excel的下标（从0开始）
    
    返回:
    
    指定工作表，如果指定下标无工作表将抛IndexOutOfBoundException
  - sheet
```
public Sheet sheet(String sheetName)
```
    获取指定名称的工作表，此方法默认load工作表所以外部无需再次调用load方法
    
    参数:
    
    sheetName - 工作表名
    
    返回:
    
    指定工作表，如果不存在则返回null
  - all
```
public Sheet[] all()
```
    获取全部工作表，通过此方法获取的工作表在读取前需要先调用load方法
    
    返回:
    
    当前excel包含的所有工作表
  - getSize
```
public int getSize()
```
    获取当前excel包含的工作表数量
    
    返回:
    
    当前excel包含的工作表数量
  - close
```
public void close()
           throws IOException
```
    关闭流并删除临时文件
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - when fail close readers
  - getAppInfo
```
public AppInfo getAppInfo()
```
    Excel文件基础信息包含作者、日期等信息，在windows操作系统上使用鼠标右键->属性->详细信息查看
    
    返回:
    
    AppInfo通过此对象可以获取excel详细属性
  - hasFormula
```
@Deprecated
public boolean hasFormula()
```
    已过时。此方法无法准确反映工作簿是否包含公式，这里仅检查是否包含一个通用的calcChain文件，某些工具生成的Excel文件不包含calcChain文件而是内嵌在每个单元格中，这部分公式只有在读取单元格时才明确知道，通过Row.hasFormula(int)可以精准判断某些单元格是否包含公式。
    
    是否包含"公式"，返回true一定包含公式，返回false则不一定不包含
    
    返回:
    
    true: 包含 false: 不确认是否包含
  - parseFormula
```
public ExcelReader parseFormula()
```
    强制解析公式，将所有工作表转换为CalcSheet，也可以在单个工作表中使用Sheet.asCalcSheet()转换单个工作表
    
    返回:
    
    当前 ExcelReader
  - copyOnMergeCells
```
public ExcelReader copyOnMergeCells()
```
    复制合并单元格，默认情况下合并单元格的值仅存储在第一个单元格中其他单元格没有值。读取到这部分单元格时将直接返回null值，需要在业务代码里特殊处理合并单元格，本工具内置处理合并单格，调用此方法可将值复制到合并中的其他单元格中。
    本方法将当前所有工作表都转换为MergeSheet，也可以在单个工作表中使用Sheet.asMergeSheet() ()}转换单个工作表， 注意：MergeSheet性能不佳，建议读完合并单元格后使用Sheet.asSheet()将其转换为普通工作表，它们之间可以无缝切换无需担心漏读或重复读的问题
    |---------| |---------| |---------| | | | 1 | | | 1 | 1 | | 1 | => |----|----| => |----|----| | | | | | | 1 | 1 | |---------| |---------| |---------| Merged(A1:B2) Default Copy Value in A1 others are `null`
    返回:
    
    当前 ExcelReader
  - checkContentType
```
protected ContentType checkContentType()
```
    解析Content_Types并进行安全检查，必要安全检查不通过将抛ExcelReadException异常，必要检查项配置在MUST_CHECK_PART中，外部可以视情况进行添加/移除
    
    返回:
    
    当前excel包含的全部资源类型
  - init
```
protected ExcelReader init(Path path,
                           int bufferSize,
                           int cacheSize,
                           int option)
                    throws IOException
```
    初始化，初始化过程将进行内容检查，和创建全局属性（样式，字符共享区）以及工作表但不会实际读取工作表
    
    参数:
    
    path - excel文件路径
    
    bufferSize - 共享字符区的大小，默认64
    
    cacheSize - 共享字符区缓存大小，默认512
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int bufferSize,
                               int cacheSize,
                               int option)
                        throws IOException
```
    指定解析模式读取Excel文件，如果文件为xls格式将加载org.ttzero.excel.reader.BIFF8Reader 如果要支持xls格式需要将eec-e3-support添加进classpath，如果未识别到文件类型则抛ExcelReadException
    
    参数:
    
    path - excel文件路径
    
    bufferSize - 共享字符区的大小，默认16
    
    cacheSize - 共享字符区的缓存大小，默认512
    
    option - 解析模式，有VALUE_ONLY, VALUE_AND_CALC, COPY_ON_MERGED三种属性可选
    
    返回:
    
    一个Excel解析器 ExcelReader
    
    抛出:
    
    FileNotFoundException - 文件不存在
    
    IOException - if I/O error occur
  - sheetFactory
```
protected Sheet sheetFactory(int option)
```
    通过OPTION创建相应工作表
    
    参数:
    
    option - the reader option.
    
    返回:
    
    Sheet extends XMLSheet
  - getType
```
public static ExcelType getType(Path path)
```
    判断文件格式，读取少量文件头字节来判断是否为BIFF和ZIP的文件签名
    
    参数:
    
    path - 临时文件路径
    
    返回:
    
    ExcelType枚举，非excel格式时返回ExcelType.UNKNOWN类型
  - getGeneralInfo
```
protected AppInfo getGeneralInfo()
```
    解析docProps/app.xml和docProps/core.xml文件获取文件基础信息，比如创建者、创建时间、分类等信息
    
    返回:
    
    App信息
  - cellRangeToLong
```
public static long cellRangeToLong(String r)
```
    将单元格坐标转为long类型，Excel单元格坐标由列+行组成如A1, B2等，转为long类型后第0-16位为列号17-48位为行号
    单元格坐标 | 转换后long值 ------------|------------ A1 | 65537 AA10 | 655387
    参数:
    
    r - 单元格坐标
    
    返回:
    
    转换后的值
  - listPictures
```
public List<Drawings.Picture> listPictures()
```
    获取Excel包含的所有图片，Drawings.Picture对象包含工作表的单元格行列信息，最重要的是包含localPath属性，它是图片的临时路径可以通过此路径复制图片
    
    返回:
    
    图片数组，如果不存在图片则返回null
  - getStyles
```
public Styles getStyles()
```
    获取一个全局的样式对象 Styles
    
    返回:
    
    全局样式对象
  - getEntry
```
public ZipEntry getEntry(String name)
```
    从压缩包中获取一个压缩文件
    
    参数:
    
    name - 压缩文件路径，必须是一个完整的路径
    
    返回:
    
    如果实体存在则返回 ZipEntry 否则返回null
  - getEntryStream
```
public InputStream getEntryStream(String name)
                           throws IOException
```
    从压缩包中获取一个压缩文件字节流
    
    参数:
    
    name - 压缩文件路径，必须是一个完整的路径
    
    返回:
    
    如果实体存在则返回该实体的InputStream 否则返回null
    
    抛出:
    
    IOException - if I/O error occur.
  - getEntry
```
public static ZipEntry getEntry(ZipFile zipFile,
                                String name)
```
    从压缩包中获取一个压缩文件，为了兼容windows和linux系统的路径会进行'/'和'\\' 两种分隔符匹配，如果路径无法匹配则遍历压缩包所有文件并忽略大小写匹配
    
    参数:
    
    zipFile - 压缩包
    
    name - 压缩文件路径，必须是一个完整的路径
    
    返回:
    
    如果实体存在则返回 ZipEntry 否则返回null
  - toZipPath
```
public static String toZipPath(String path)
```
    将string转换为zip允许的路径，将相对路径的前缀去掉
    
    参数:
    
    path - 实体路径
    
    返回:
    
    zip允许的路径

类 ExcelReader

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

LOGGER

VALUE_ONLY

VALUE_AND_CALC

COPY_ON_MERGED

sheets

tempDir

option

hasFormula

drawings

styles

zipFile

MUST_CHECK_PART

构造器详细资料

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

方法详细资料

read

read

read

read

read

read

read

getType

sheets

sheet

sheet

all

getSize

close

getAppInfo

hasFormula

parseFormula

copyOnMergeCells

checkContentType

init

read

sheetFactory

getType

getGeneralInfo

cellRangeToLong

listPictures

getStyles

getEntry

getEntryStream

getEntry

toZipPath