org.dromara.hutool.poi.csv

Class CsvReader

java.lang.Object

org.dromara.hutool.poi.csv.CsvBaseReader

org.dromara.hutool.poi.csv.CsvReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Iterable<CsvRow>

public class CsvReader
extends CsvBaseReader
implements Iterable<CsvRow>, Closeable

CSV文件读取器，参考：FastCSV

Since:

4.0.1

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dromara.hutool.poi.csv.CsvBaseReader

DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
CsvReader() 构造，使用默认配置项
CsvReader(CsvReadConfig config) 构造
CsvReader(File file, Charset charset, CsvReadConfig config) 构造
CsvReader(File file, CsvReadConfig config) 构造，默认CsvBaseReader.DEFAULT_CHARSET编码
CsvReader(Path path, Charset charset, CsvReadConfig config) 构造
CsvReader(Path path, CsvReadConfig config) 构造，默认CsvBaseReader.DEFAULT_CHARSET编码
CsvReader(Reader reader, CsvReadConfig config) 构造

Method Summary

Modifier and Type	Method and Description
void	close()
Iterator<CsvRow>	iterator()
CsvData	read() 读取CSV文件，此方法只能调用一次 调用此方法的前提是构造中传入文件路径或Reader
void	read(SerConsumer<CsvRow> rowHandler) 读取CSV数据，此方法只能调用一次 调用此方法的前提是构造中传入文件路径或Reader
Stream<CsvRow>	stream() 根据Reader创建Stream，以便使用stream方式读取csv行

Methods inherited from class org.dromara.hutool.poi.csv.CsvBaseReader

parse, read, read, read, read, read, read, read, read, readFromStr, readFromStr, readMapList, setContainsHeader, setErrorOnDifferentFieldCount, setFieldSeparator, setSkipEmptyRows, setTextDelimiter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CsvReader

public CsvReader()

构造，使用默认配置项

CsvReader

public CsvReader(CsvReadConfig config)

构造

Parameters:

config - 配置项

CsvReader

public CsvReader(File file,
                 CsvReadConfig config)

构造，默认CsvBaseReader.DEFAULT_CHARSET编码

Parameters:

file - CSV文件路径，null表示不设置路径

config - 配置项，null表示默认配置

Since:

5.0.4

CsvReader

public CsvReader(Path path,
                 CsvReadConfig config)

构造，默认CsvBaseReader.DEFAULT_CHARSET编码

Parameters:

path - CSV文件路径，null表示不设置路径

config - 配置项，null表示默认配置

Since:

5.0.4

CsvReader

public CsvReader(File file,
                 Charset charset,
                 CsvReadConfig config)

构造

Parameters:

file - CSV文件路径，null表示不设置路径

charset - 编码

config - 配置项，null表示默认配置

Since:

5.0.4

CsvReader

public CsvReader(Path path,
                 Charset charset,
                 CsvReadConfig config)

构造

Parameters:

path - CSV文件路径，null表示不设置路径

charset - 编码

config - 配置项，null表示默认配置

Since:

5.0.4

CsvReader

public CsvReader(Reader reader,
                 CsvReadConfig config)

构造

Parameters:

reader - Reader，null表示不设置默认reader

config - 配置项，null表示默认配置

Since:

5.0.4

Method Detail

read

public CsvData read()
             throws IORuntimeException

读取CSV文件，此方法只能调用一次
调用此方法的前提是构造中传入文件路径或Reader

Returns:

CsvData，包含数据列表和行信息

Throws:

IORuntimeException - IO异常

read

public void read(SerConsumer<CsvRow> rowHandler)
          throws IORuntimeException

读取CSV数据，此方法只能调用一次
调用此方法的前提是构造中传入文件路径或Reader

Parameters:

rowHandler - 行处理器，用于一行一行的处理数据

Throws:

IORuntimeException - IO异常

Since:

5.0.4

stream

public Stream<CsvRow> stream()

根据Reader创建Stream，以便使用stream方式读取csv行

Returns:

Stream

Since:

5.7.14

iterator

public Iterator<CsvRow> iterator()

Specified by:

iterator in interface Iterable<CsvRow>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable