org.dromara.hutool.poi.csv.CsvBaseReader Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.poi.csv;
import org.dromara.hutool.core.func.SerConsumer;
import org.dromara.hutool.core.io.IORuntimeException;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.io.file.PathUtil;
import org.dromara.hutool.core.lang.Assert;
import org.dromara.hutool.core.util.CharsetUtil;
import org.dromara.hutool.core.util.ObjUtil;
import java.io.File;
import java.io.Reader;
import java.io.Serializable;
import java.io.StringReader;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* CSV文件读取器基础类，提供灵活的文件、路径中的CSV读取，一次构造可多次调用读取不同数据，参考：FastCSV
*
* @author Looly
* @since 5.0.4
*/
public class CsvBaseReader implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 默认编码
*/
protected static final Charset DEFAULT_CHARSET = CharsetUtil.UTF_8;
private final CsvReadConfig config;
//--------------------------------------------------------------------------------------------- Constructor start
/**
* 构造，使用默认配置项
*/
public CsvBaseReader() {
this(null);
}
/**
* 构造
*
* @param config 配置项
*/
public CsvBaseReader(final CsvReadConfig config) {
this.config = ObjUtil.defaultIfNull(config, CsvReadConfig::defaultConfig);
}
//--------------------------------------------------------------------------------------------- Constructor end
/**
* 设置字段分隔符，默认逗号','
*
* @param fieldSeparator 字段分隔符，默认逗号','
*/
public void setFieldSeparator(final char fieldSeparator) {
this.config.setFieldSeparator(fieldSeparator);
}
/**
* 设置 文本分隔符，文本包装符，默认双引号'"'
*
* @param textDelimiter 文本分隔符，文本包装符，默认双引号'"'
*/
public void setTextDelimiter(final char textDelimiter) {
this.config.setTextDelimiter(textDelimiter);
}
/**
* 设置是否首行做为标题行，默认false
*
* @param containsHeader 是否首行做为标题行，默认false
*/
public void setContainsHeader(final boolean containsHeader) {
this.config.setContainsHeader(containsHeader);
}
/**
* 设置是否跳过空白行，默认true
*
* @param skipEmptyRows 是否跳过空白行，默认true
*/
public void setSkipEmptyRows(final boolean skipEmptyRows) {
this.config.setSkipEmptyRows(skipEmptyRows);
}
/**
* 设置每行字段个数不同时是否抛出异常，默认false
*
* @param errorOnDifferentFieldCount 每行字段个数不同时是否抛出异常，默认false
*/
public void setErrorOnDifferentFieldCount(final boolean errorOnDifferentFieldCount) {
this.config.setErrorOnDifferentFieldCount(errorOnDifferentFieldCount);
}
/**
* 读取CSV文件，默认UTF-8编码
*
* @param file CSV文件
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public CsvData read(final File file) throws IORuntimeException {
return read(file, DEFAULT_CHARSET);
}
/**
* 从字符串中读取CSV数据
*
* @param csvStr CSV字符串
* @return {@link CsvData}，包含数据列表和行信息
*/
public CsvData readFromStr(final String csvStr) {
return read(new StringReader(csvStr), true);
}
/**
* 从字符串中读取CSV数据
*
* @param csvStr CSV字符串
* @param rowHandler 行处理器，用于一行一行的处理数据
*/
public void readFromStr(final String csvStr, final SerConsumer rowHandler) {
read(parse(new StringReader(csvStr)), true, rowHandler);
}
/**
* 读取CSV文件
*
* @param file CSV文件
* @param charset 文件编码，默认系统编码
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public CsvData read(final File file, final Charset charset) throws IORuntimeException {
return read(Objects.requireNonNull(file.toPath(), "file must not be null"), charset);
}
/**
* 读取CSV文件，默认UTF-8编码
*
* @param path CSV文件
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public CsvData read(final Path path) throws IORuntimeException {
return read(path, DEFAULT_CHARSET);
}
/**
* 读取CSV文件
*
* @param path CSV文件
* @param charset 文件编码，默认系统编码
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public CsvData read(final Path path, final Charset charset) throws IORuntimeException {
Assert.notNull(path, "path must not be null");
return read(PathUtil.getReader(path, charset), true);
}
/**
* 从Reader中读取CSV数据，读取后关闭Reader
*
* @param reader Reader
* @param closeReader 是否关闭Reader
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public CsvData read(final Reader reader, final boolean closeReader) throws IORuntimeException {
final CsvParser csvParser = parse(reader);
final List rows = new ArrayList<>();
read(csvParser, closeReader, rows::add);
final List header = config.headerLineNo > -1 ? csvParser.getHeader() : null;
return new CsvData(header, rows);
}
/**
* 从Reader中读取CSV数据，结果为Map，读取后关闭Reader。
* 此方法默认识别首行为标题行。
*
* @param reader Reader
* @param closeReader 是否关闭Reader
* @return {@link CsvData}，包含数据列表和行信息
* @throws IORuntimeException IO异常
*/
public List> readMapList(final Reader reader, final boolean closeReader) throws IORuntimeException {
// 此方法必须包含标题
this.config.setContainsHeader(true);
final List> result = new ArrayList<>();
read(reader, closeReader, (row) -> result.add(row.getFieldMap()));
return result;
}
/**
* 从Reader中读取CSV数据并转换为Bean列表，读取后关闭Reader。
* 此方法默认识别首行为标题行。
*
* @param Bean类型
* @param reader Reader
* @param closeReader 是否关闭Reader
* @param clazz Bean类型
* @return Bean列表
*/
public List read(final Reader reader, final boolean closeReader, final Class clazz) {
// 此方法必须包含标题
this.config.setContainsHeader(true);
final List result = new ArrayList<>();
read(reader, closeReader, (row) -> result.add(row.toBean(clazz)));
return result;
}
/**
* 从字符串中读取CSV数据并转换为Bean列表，读取后关闭Reader。
* 此方法默认识别首行为标题行。
*
* @param Bean类型
* @param csvStr csv字符串
* @param clazz Bean类型
* @return Bean列表
*/
public List read(final String csvStr, final Class clazz) {
// 此方法必须包含标题
this.config.setContainsHeader(true);
final List result = new ArrayList<>();
read(new StringReader(csvStr), true, (row) -> result.add(row.toBean(clazz)));
return result;
}
/**
* 从Reader中读取CSV数据，读取后关闭Reader
*
* @param reader Reader
* @param closeReader 是否关闭Reader
* @param rowHandler 行处理器，用于一行一行的处理数据
* @throws IORuntimeException IO异常
*/
public void read(final Reader reader, final boolean closeReader, final SerConsumer rowHandler) throws IORuntimeException {
read(parse(reader), closeReader, rowHandler);
}
//--------------------------------------------------------------------------------------------- Private method start
/**
* 读取CSV数据，读取后关闭Parser
*
* @param csvParser CSV解析器
* @param closeParser 是否关闭解析器
* @param rowHandler 行处理器，用于一行一行的处理数据
* @throws IORuntimeException IO异常
* @since 5.0.4
*/
private void read(final CsvParser csvParser, final boolean closeParser, final SerConsumer rowHandler) throws IORuntimeException {
try {
while (csvParser.hasNext()) {
rowHandler.accept(csvParser.next());
}
} finally {
if (closeParser) {
IoUtil.closeQuietly(csvParser);
}
}
}
/**
* 构建 {@link CsvParser}
*
* @param reader Reader
* @return CsvParser
* @throws IORuntimeException IO异常
*/
protected CsvParser parse(final Reader reader) throws IORuntimeException {
return new CsvParser(reader, this.config);
}
//--------------------------------------------------------------------------------------------- Private method start
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy