org.aoju.bus.core.text.csv

Class CsvReader

java.lang.Object

org.aoju.bus.core.text.csv.CsvReader

public final class CsvReader
extends Object

CSV文件读取器,参考：FastCSV

Since:

JDK 1.8+

Version:

6.0.2

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
CsvReader() 构造,使用默认配置项
CsvReader(CsvReadConfig config) 构造

Method Summary

Modifier and Type	Method and Description
CsvData	read(File file) 读取CSV文件,默认UTF-8编码
CsvData	read(File file, Charset charset) 读取CSV文件
CsvData	read(Path path) 读取CSV文件,默认UTF-8编码
CsvData	read(Path path, Charset charset) 读取CSV文件
CsvData	read(Reader reader) 从Reader中读取CSV数据,读取后关闭Reader
<T> List<T>	read(Reader reader, Class<T> clazz) 从Reader中读取CSV数据并转换为Bean列表，读取后关闭Reader 此方法默认识别首行为标题行
void	read(Reader reader, CsvHandler rowHandler) 从Reader中读取CSV数据，读取后关闭Reader
List<Map<String,String>>	readMapList(Reader reader) 从Reader中读取CSV数据，结果为Map，读取后关闭Reader 此方法默认识别首行为标题行
void	setContainsHeader(boolean containsHeader) 设置是否首行做为标题行,默认false
void	setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) 设置每行字段个数不同时是否抛出异常,默认false
void	setFieldSeparator(char fieldSeparator) 设置字段分隔符,默认逗号
void	setSkipEmptyRows(boolean skipEmptyRows) 设置是否跳过空白行,默认true
void	setTextDelimiter(char textDelimiter) 设置 文本分隔符,文本包装符,默认双引号

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReader

public CsvReader()

构造,使用默认配置项

CsvReader

public CsvReader(CsvReadConfig config)

构造

Parameters:

config - 配置项

Method Detail

setFieldSeparator

public void setFieldSeparator(char fieldSeparator)

设置字段分隔符,默认逗号

Parameters:

fieldSeparator - 字段分隔符,默认逗号

setTextDelimiter

public void setTextDelimiter(char textDelimiter)

设置 文本分隔符,文本包装符,默认双引号

Parameters:

textDelimiter - 文本分隔符,文本包装符,默认双引号

setContainsHeader

public void setContainsHeader(boolean containsHeader)

设置是否首行做为标题行,默认false

Parameters:

containsHeader - 是否首行做为标题行,默认false

setSkipEmptyRows

public void setSkipEmptyRows(boolean skipEmptyRows)

设置是否跳过空白行,默认true

Parameters:

skipEmptyRows - 是否跳过空白行,默认true

setErrorOnDifferentFieldCount

public void setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount)

设置每行字段个数不同时是否抛出异常,默认false

Parameters:

errorOnDifferentFieldCount - 每行字段个数不同时是否抛出异常,默认false

read

public CsvData read(File file)
             throws InstrumentException

读取CSV文件,默认UTF-8编码

Parameters:

file - CSV文件

Returns:

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

Throws:

InstrumentException - IO异常

read

public CsvData read(File file,
                    Charset charset)
             throws InstrumentException

读取CSV文件

Parameters:

file - CSV文件

charset - 文件编码,默认系统编码

Returns:

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

Throws:

InstrumentException - IO异常

read

public CsvData read(Path path)
             throws InstrumentException

读取CSV文件,默认UTF-8编码

Parameters:

path - CSV文件

Returns:

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

Throws:

InstrumentException - IO异常

read

public CsvData read(Path path,
                    Charset charset)
             throws InstrumentException

读取CSV文件

Parameters:

path - CSV文件

charset - 文件编码,默认系统编码

Returns:

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

Throws:

InstrumentException - IO异常

read

public CsvData read(Reader reader)
             throws InstrumentException

从Reader中读取CSV数据,读取后关闭Reader

Parameters:

reader - Reader

Returns:

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

Throws:

InstrumentException - IO异常

read

public void read(Reader reader,
                 CsvHandler rowHandler)

从Reader中读取CSV数据，读取后关闭Reader

Parameters:

reader - Reader

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

readMapList

public List<Map<String,String>> readMapList(Reader reader)
                                     throws InstrumentException

从Reader中读取CSV数据，结果为Map，读取后关闭Reader 此方法默认识别首行为标题行

Parameters:

reader - Reader

Returns:

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

Throws:

InstrumentException - IO异常

read

public <T> List<T> read(Reader reader,
                        Class<T> clazz)

从Reader中读取CSV数据并转换为Bean列表，读取后关闭Reader 此方法默认识别首行为标题行

Type Parameters:

T - Bean类型

Parameters:

reader - Reader

clazz - Bean类型

Returns:

Bean列表