Java文件统计工具：FileStats类高效实现

本文详细讲解了如何使用Java构建高效的`FileStats`类，实现文本文件的行数统计与关键词检索功能。重点剖析了`Scanner`类的正确用法，强调应使用`File`对象而非文件名字符串初始化`Scanner`，避免文件读取错误。同时，强调了`try-with-resources`语句在资源管理中的重要性，确保文件资源在使用完毕后能够自动关闭，有效防止资源泄露，提升代码健壮性。通过本文，你将学会如何编写更规范、更高效的Java文件处理代码，提升你的Java编程技能。掌握`FileStats`类，轻松应对文件统计分析任务！

本教程详细介绍了如何构建一个Java FileStats类，用于统计文本文件的总行数以及包含特定文本内容的行数。文章重点解析了文件读取中Scanner类的正确使用方法，特别是避免将文件名字符串直接作为Scanner构造参数的常见错误，并强调了使用try-with-resources语句进行资源管理的最佳实践，以确保文件资源被正确关闭，提升代码的健壮性。

1. FileStats类概述

FileStats类旨在提供一个简单易用的接口，用于执行基本的文本文件分析。它的核心功能包括：

• 获取文件的总行数。
• 统计文件中包含指定文本（不区分大小写）的行数。

该类将封装文件路径，并通过其方法提供上述统计功能。

2. 类结构定义

FileStats类包含一个私有字段 filename 用于存储文件路径，以及一个构造器用于初始化该路径。

import java.io.File;
import java.io.FileNotFoundException;
import java.util.Scanner;

public class FileStats {
    private String filename;

    /**
     * 构造器，初始化FileStats对象，指定要分析的文件路径。
     * @param f 文件路径字符串
     */
    public FileStats(String f) {
        this.filename = f;
    }

    // 后续方法将在此处添加
}

3. 实现获取总行数的方法 (getNumLines)

getNumLines() 方法负责打开文件并逐行读取，统计总行数。在此方法中，正确使用 Scanner 读取 File 对象是关键。为了确保资源被妥善关闭，我们强烈推荐使用 Java 7 引入的 try-with-resources 语句。

    /**
     * 获取文件的总行数。
     * @return 文件的总行数
     * @throws FileNotFoundException 如果指定的文件不存在
     */
    public int getNumLines() throws FileNotFoundException {
        File fileObj = new File(filename);
        int numLines = 0;
        // 使用try-with-resources确保Scanner资源被自动关闭
        try (Scanner inputFile = new Scanner(fileObj)) {
            while (inputFile.hasNextLine()) {
                inputFile.nextLine(); // 读取一行但不需要其内容
                numLines++;
            }
        } // Scanner在此处自动关闭
        return numLines;
    }

注意事项：

• new File(filename) 创建一个 File 对象，代表文件系统中的文件。
• new Scanner(fileObj) 使用 File 对象作为输入源来创建 Scanner。
• hasNextLine() 和 nextLine() 用于逐行遍历文件。
• try-with-resources 结构确保 Scanner 对象在 try 块结束时（无论正常结束还是异常发生）都会自动调用其 close() 方法，避免资源泄露。

4. 实现统计包含特定文本行数的方法 (getNumLinesThatContain)

getNumLinesThatContain(String key) 方法用于统计文件中包含指定 key 的行数。这个方法是原始问题中出现错误的地方，核心问题在于 Scanner 的初始化。

常见错误分析： 在原始代码中，getNumLinesThatContain 方法内部使用了 inputFile = new Scanner(filename);。这是一个常见的错误，因为 Scanner 构造器接收 String 参数时，它会将该字符串本身视为要扫描的数据，而不是将其作为文件路径来打开文件。因此，Scanner 实际上并没有读取文件的内容，而是试图扫描字符串 filename。

正确实现： 为了正确读取文件内容，Scanner 必须接收一个 File 对象或一个 InputStream。

    /**
     * 统计文件中包含指定文本内容的行数（不区分大小写）。
     * @param key 要搜索的文本
     * @return 包含指定文本的行数
     * @throws FileNotFoundException 如果指定的文件不存在
     */
    public int getNumLinesThatContain(String key) throws FileNotFoundException {
        File fileObj = new File(filename);
        int numLines = 0;
        // 同样使用try-with-resources确保Scanner资源被自动关闭
        try (Scanner inputFile = new Scanner(fileObj)) { // 正确：传入File对象
            while (inputFile.hasNextLine()) {
                String line = inputFile.nextLine();
                // 将行内容和搜索关键词都转换为大写进行不区分大小写的比较
                if (line.toUpperCase().contains(key.toUpperCase())) {
                    numLines++;
                }
            }
        } // Scanner在此处自动关闭
        return numLines;
    }

关键点：

• new Scanner(fileObj)：这是解决问题的关键。确保 Scanner 实例通过 File 对象初始化，这样它才能正确地读取文件的内容。
• line.toUpperCase().contains(key.toUpperCase())：这种方式实现了不区分大小写的文本包含检查。contains() 方法会检查一个字符串是否包含另一个字符串。

5. 完整的 FileStats 类代码

结合上述所有部分，完整的 FileStats 类代码如下：

import java.io.File;
import java.io.FileNotFoundException;
import java.util.Scanner;

public class FileStats {
    private String filename;

    /**
     * 构造器，初始化FileStats对象，指定要分析的文件路径。
     * @param f 文件路径字符串
     */
    public FileStats(String f) {
        this.filename = f;
    }

    /**
     * 获取文件的总行数。
     * @return 文件的总行数
     * @throws FileNotFoundException 如果指定的文件不存在
     */
    public int getNumLines() throws FileNotFoundException {
        File fileObj = new File(filename);
        int numLines = 0;
        try (Scanner inputFile = new Scanner(fileObj)) {
            while (inputFile.hasNextLine()) {
                inputFile.nextLine();
                numLines++;
            }
        }
        return numLines;
    }

    /**
     * 统计文件中包含指定文本内容的行数（不区分大小写）。
     * @param key 要搜索的文本
     * @return 包含指定文本的行数
     * @throws FileNotFoundException 如果指定的文件不存在
     */
    public int getNumLinesThatContain(String key) throws FileNotFoundException {
        File fileObj = new File(filename);
        int numLines = 0;
        try (Scanner inputFile = new Scanner(fileObj)) {
            while (inputFile.hasNextLine()) {
                String line = inputFile.nextLine();
                if (line.toUpperCase().contains(key.toUpperCase())) {
                    numLines++;
                }
            }
        }
        return numLines;
    }

    // 示例用法（可选，用于测试）
    public static void main(String[] args) {
        // 创建一个测试文件
        String testFileName = "test_file.txt";
        try {
            java.io.FileWriter writer = new java.io.FileWriter(testFileName);
            writer.write("Hello World!\n");
            writer.write("This is a test line.\n");
            writer.write("Another line with hello.\n");
            writer.write("JAVA programming.\n");
            writer.write("hello again.\n");
            writer.close();
            System.out.println("测试文件 '" + testFileName + "' 已创建。");
        } catch (java.io.IOException e) {
            System.err.println("创建测试文件时发生错误: " + e.getMessage());
            return;
        }

        FileStats stats = new FileStats(testFileName);

        try {
            int totalLines = stats.getNumLines();
            System.out.println("文件总行数: " + totalLines); // 预期输出 5

            int linesWithHello = stats.getNumLinesThatContain("hello");
            System.out.println("包含 'hello' 的行数: " + linesWithHello); // 预期输出 3 (Hello World!, Another line with hello., hello again.)

            int linesWithJava = stats.getNumLinesThatContain("JAVA");
            System.out.println("包含 'JAVA' 的行数: " + linesWithJava); // 预期输出 1 (JAVA programming.)

            int linesWithNonExistent = stats.getNumLinesThatContain("xyz");
            System.out.println("包含 'xyz' 的行数: " + linesWithNonExistent); // 预期输出 0

        } catch (FileNotFoundException e) {
            System.err.println("错误：文件未找到 - " + e.getMessage());
        } finally {
            // 清理测试文件
            File testFile = new File(testFileName);
            if (testFile.exists()) {
                testFile.delete();
                System.out.println("测试文件 '" + testFileName + "' 已删除。");
            }
        }
    }
}

6. 总结与最佳实践

本教程通过构建 FileStats 类，演示了在 Java 中进行文件行数统计和关键词行数统计的方法。核心要点包括：

• Scanner 的正确初始化： 当从文件读取数据时，Scanner 必须使用 File 对象或 InputStream 作为其构造参数，而不是直接使用文件路径字符串。这是避免文件读取错误的根本。
• 资源管理： 始终使用 try-with-resources 语句来处理 Scanner 或其他实现了 AutoCloseable 接口的资源。这能确保资源在不再需要时自动关闭，即使发生异常也能有效防止资源泄露。
• 异常处理： 文件操作可能抛出 FileNotFoundException 等受检异常。在方法签名中使用 throws 声明，或在方法内部使用 try-catch 块进行捕获处理。
• 不区分大小写比较： 对于文本搜索，通常需要进行不区分大小写的比较。将字符串转换为统一的大小写（如全部大写或全部小写）后再进行比较是一个简单有效的方法。

遵循这些最佳实践将有助于编写出健壮、高效且易于维护的 Java 文件处理代码。

以上就是《Java文件统计工具：FileStats类高效实现》的详细内容，更多关于的资料请关注golang学习网公众号！