行遍历器 - LineIter

简介

LineIter 是一个用于按行遍历文本内容的工具类，它将 Reader 包装成一个按照行读取的 Iterator，从而可以轻松地逐行处理文本数据。LineIter 的实现参考了 Apache Commons IO 和 Guava 项目，简化了逐行读取文件或其他文本数据的操作。

1. 使用场景

在处理大文件或需要按行读取文本内容时，LineIter 提供了一种优雅且易于操作的方式。它可以避免将整个文件内容一次性加载到内存中的问题，从而提高内存使用效率。LineIter 特别适合日志文件、配置文件等逐行处理的场景。

2. 主要方法

2.1 构造方法

LineIter 通过构造方法接受一个 Reader，然后将其转换为按行读取的迭代器。

• LineIter(Reader reader)：将指定的 Reader 包装为一个 LineIter 对象。

示例：创建一个按行读取的迭代器

import cn.hutool.core.io.LineIter;
import cn.hutool.core.util.ResourceUtil;

import java.io.Reader;

public class LineIterExample {
    public static void main(String[] args) {
        // 获取指定文件的 Reader（UTF-8 编码）
        Reader reader = ResourceUtil.getUtf8Reader("test_lines.csv");

        // 将 Reader 包装为 LineIter 对象
        LineIter lineIter = new LineIter(reader);

        // 逐行读取并打印内容
        for (String line : lineIter) {
            System.out.println(line);
        }
    }
}

• 参数说明：
  • reader: 需要按行读取的 Reader 对象。
• 作用：将 Reader 包装为按行读取的迭代器，便于逐行处理文本内容。
• 实际开发场景：在处理大文件时，通过 LineIter 可以逐行读取数据，避免一次性加载整个文件。

2.2 逐行遍历文本内容

LineIter 实现了 Iterator<String> 接口，可以直接用于增强 for 循环中进行逐行遍历。它支持常规的迭代器操作，包括 hasNext() 和 next()。

示例：逐行读取文件内容

import cn.hutool.core.io.LineIter;
import cn.hutool.core.util.ResourceUtil;

import java.io.Reader;

public class LineIterExample {
    public static void main(String[] args) {
        // 获取指定文件的 Reader（UTF-8 编码）
        Reader reader = ResourceUtil.getUtf8Reader("test_lines.csv");

        // 将 Reader 包装为 LineIter 对象
        LineIter lineIter = new LineIter(reader);

        // 使用迭代器逐行读取
        while (lineIter.hasNext()) {
            String line = lineIter.next();
            System.out.println(line);
        }
    }
}

• 方法签名：
  • boolean hasNext()：检查是否还有下一行。
  • String next()：读取并返回下一行。
• 返回值：
  • hasNext()：boolean，表示是否还有未读取的行。
  • next()：String，返回下一行的内容。
• 作用：逐行读取文件或文本内容，适合处理大文件或按行处理逻辑。
• 实际开发场景：在日志分析、逐行处理大数据文件时，可以使用此方法逐行读取并处理数据。

3. 关闭资源

LineIter 通过实现 Closeable 接口，提供了 close() 方法用于关闭底层的 Reader，确保资源被正确释放。在实际使用中，可以将 LineIter 放在 try-with-resources 语句中，以自动管理资源。

示例：使用 try-with-resources 自动关闭资源

import cn.hutool.core.io.LineIter;
import cn.hutool.core.util.ResourceUtil;

import java.io.Reader;

public class LineIterExample {
    public static void main(String[] args) {
        // 使用 try-with-resources 自动关闭资源
        try (Reader reader = ResourceUtil.getUtf8Reader("test_lines.csv");
             LineIter lineIter = new LineIter(reader)) {

            // 逐行读取并打印内容
            for (String line : lineIter) {
                System.out.println(line);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

• 方法签名：void close()
• 作用：关闭底层的 Reader 资源，防止资源泄漏。
• 实际开发场景：在需要确保资源正确释放的场景中，建议使用 try-with-resources 或显式调用 close() 方法。

4. 实际应用场景

• 日志文件处理：逐行读取和分析日志文件，提取关键信息。
• 大数据文件分析：处理大规模数据文件时，逐行读取可以避免内存溢出问题。
• 配置文件解析：读取并解析逐行格式的配置文件，如 CSV 文件或属性文件。