TxtFileUtil-文本文件操作工具类

在写工具类或进行文本分析时, 对小文本文件的读写是一种很常见的操作. 对于小文件文件, 一次性读取到内存, 然后再做分析处理, 比边读边处理更快. 因此笔者封装了一个工具类, 专门用于读写小文本文件.

1. API 简介

• 核心API 分为三类: 读取文件, 写入文件, 追加文件. 笔者针对常用的默认参数做了一定的方法重载.
• filter API 需要jdk8 支持

方法签名	方法描述
List readFile(String filePath)	读取文件内容, 默认以UTF-8编码打开文件
public static List readFile(String filePath, String encoding)	读取文件内容, 以指定编码格式打开文件
public static List readFile(String filePath, boolean ignoreEmptyLine)	读取文件内容, 可忽略空行
public static List readFile(String filePath, boolean ignoreEmptyLine, String encoding)	读取文件内容, 以指定编码格式打开文件, 可忽略空行
public static List readFile(String filePath, Predicate filter)	读取文件内容, 可自定义过滤器, 过滤行. 默认以UTF-8编码打开文件
public static List readFile(String filePath, Predicate ignoreFilter, String encoding)	读取文件内容.
public static void writeFile(List contents, String filePath)	向文件中追加内容. 默认以UTF-8编码写入文件. 当文件已存在时, 进行文件覆盖
public static void writeFile(List contents, String filePath, boolean overrideFile)	向文件中追加内容, 默认以UTF-8编码写入文件
public static void writeFile(List contents, String filePath, String encoding)	向文件中追加内容, 当文件存在时, 会进行文件覆盖
public static void writeFile(List contents, String filePath, String encoding, boolean overrideFile)	向文件中追加内容.
public static void appendFile(List contents, String filePath)	向文件中追加内容, 默认以UTF-8格式写入文件, 当文件不存在时创建新的文件.
public static void appendFile(List contents, String filePath, boolean creatNewFile)	向文件中追加内容, 默认写入文件编码为UTF-8
public static void appendFile(List contents, String filePath, String encoding)	向文件中追加内容, 当文件不存在时, 创建新文件
public static void appendFile(List contents, String filePath, String encoding, boolean creatNewFile)	向文件中追加内容.

2. TxtFileUtil 源码

import java.io.*;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Predicate;

/**
 * @Description: 文本文件读写, 当文件内容过大时, 需要考虑内存
 * @author: zongf
 * @date: 2019-06-11 14:37
 */
public class TxtFileUtil {

    /** utf-8 编码*/
    private static String ENCODING_UTF8 = "UTF-8";

    /** gbk 编码 */
    private static String ENCODING_GBK = "GBK";

    /** gb2312 编码 */
    private static String ENCODING_GB2312 = "GB2312";

    /**
     * @Description: 读取文件内容, 默认以UTF-8编码打开文件
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath){
        return readFile(filePath, line -> true, ENCODING_UTF8);
    }

    /**
     * @Description: 读取文件内容, 以指定编码格式打开文件
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 文件编码
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath, String encoding){
        return readFile(filePath, line -> true, encoding);
    }

    /**
     * @Description: 读取文件内容, 可忽略空行
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param ignoreEmptyLine 忽略空行
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath, boolean ignoreEmptyLine){
        return readFile(filePath, line -> "".equals(line.trim()), ENCODING_UTF8);
    }

    /**
     * @Description: 读取文件内容, 以指定编码格式打开文件, 可忽略空行
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param ignoreEmptyLine 忽略空行
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath, boolean ignoreEmptyLine, String encoding){
        return readFile(filePath, line -> "".equals(line.trim()), encoding);
    }

    /**
     * @Description: 读取文件内容, 可自定义过滤器, 过滤行. 默认以UTF-8编码打开文件
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param filter 过滤器
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath, Predicate<String> filter){
        return readFile(filePath, filter, ENCODING_UTF8);
    }


    /**
     * @Description: 读取文件内容.
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 设置以哪种文件编码打开文件
     * @param ignoreFilter 忽略的行过滤器
     * @return List 文件内容
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static List<String> readFile(String filePath, Predicate<String> ignoreFilter, String encoding) {

        // 创建list 存储文件内容
        List<String> contents = new ArrayList<String>();

        File file = new File(filePath);

        BufferedReader br = null;
        try {
            br = new BufferedReader(new InputStreamReader(new FileInputStream(file), encoding));

            String line = null;

            while ((line = br.readLine()) != null) {
                if (!ignoreFilter.test(line)) {
                    contents.add(line);
                }
            }
        } catch (FileNotFoundException e) {
            throw new RuntimeException(filePath + "文件不存在");
        } catch (IOException e) {
            throw new RuntimeException(filePath + "文件打开失败");
        }finally {
            close(br);
        }
        return contents;
    }

    /**
     * @Description: 向文件中追加内容. 默认以UTF-8编码写入文件. 当文件已存在时, 进行文件覆盖
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void writeFile(List<String> contents, String filePath){
        writeFile(contents, filePath, ENCODING_UTF8, true);
    }

   /**
     * @Description: 向文件中追加内容, 默认以UTF-8编码写入文件
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param overrideFile 当文件已存在时, 是否进行文件覆盖.
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void writeFile(List<String> contents, String filePath, boolean overrideFile){
        writeFile(contents, filePath, ENCODING_UTF8, overrideFile);
    }

    /**
     * @Description: 向文件中追加内容, 当文件存在时, 会进行文件覆盖
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 指定新成文件文件编码
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void writeFile(List<String> contents, String filePath, String encoding){
        writeFile(contents, filePath, encoding, true);
    }

    /**
     * @Description: 向文件中追加内容.
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 指定新成文件文件编码
     * @param overrideFile 当文件已存在时, 是否进行文件覆盖.
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void writeFile(List<String> contents, String filePath, String encoding, boolean overrideFile) {

        File file = new File(filePath);

        // 校验文件是否存在
        if(file.exists() && !overrideFile){
            throw new RuntimeException("文件已存在!");
        }

        BufferedWriter bw = null;
        try {
            bw = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), encoding));
            for (String content : contents) {
                bw.write(content);
                bw.newLine();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            close(bw);
        }
    }

    /**
     * @Description: 向文件中追加内容, 默认以UTF-8格式写入文件, 当文件不存在时创建新的文件.
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void appendFile(List<String> contents, String filePath){
        appendFile(contents, filePath, ENCODING_UTF8, true);
    }

    /**
     * @Description: 向文件中追加内容, 默认写入文件编码为UTF-8
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param creatNewFile 当文件不存在时, 是否创建新的文件
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void appendFile(List<String> contents, String filePath, boolean creatNewFile){
        appendFile(contents, filePath, ENCODING_UTF8, creatNewFile);
    }

    /**
     * @Description: 向文件中追加内容, 当文件不存在时, 创建新文件
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 指定新成文件文件编码
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void appendFile(List<String> contents, String filePath, String encoding){
        appendFile(contents, filePath, encoding, true);
    }


    /**
     * @Description: 向文件中追加内容.
     * @param contents 文件内容
     * @param filePath 文件路径, 支持相对路径和绝对路径
     * @param encoding 指定新成文件文件编码
     * @param creatNewFile 当文件不存在时, 是否创建新的文件
     * @author: zongf
     * @time: 2019-06-11 15:09:28
     */
    public static void appendFile(List<String> contents, String filePath, String encoding, boolean creatNewFile) {

        File file = new File(filePath);

        // 校验文件是否存在
        if(!file.exists() && !creatNewFile){
            throw new RuntimeException("文件不存在!");
        }

        BufferedWriter bw = null;
        try {
            bw = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file, true), encoding));
            for (String content : contents) {
                bw.write(content);
                bw.newLine();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            close(bw);
        }
    }

    /**
     * @Description: 手工关闭流
     * @param closeable
     * @author: zongf
     * @time: 2019-06-11 15:08:41
     */
    private static void close(Closeable closeable) {
        if (closeable != null) {
            try {
                closeable.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

}