Java文件内容统计与字符串查找：Scanner使用陷阱与最佳实践-java教程-PHP中文网

Java文件内容统计与字符串查找：Scanner使用陷阱与最佳实践

本文详细介绍了如何在Java中实现一个文件统计类FileStats，用于计算文件行数和查找包含特定文本的行。重点解析了Scanner类在文件读取时常见的初始化错误及其正确用法，强调了使用File对象作为Scanner构造参数的重要性，并提供了健壮的代码示例，包括异常处理和资源管理，帮助开发者高效、准确地处理文件内容。

1. FileStats 类概述

在java中进行文件内容处理是常见的任务。filestats类旨在提供一个封装，使其能够方便地统计文件的总行数，以及查找包含特定文本的行数。该类通过管理文件路径，并提供相应的方法来实现这些功能。

类结构定义：

字段：
- filename: String 类型，存储待处理文件的路径。
方法：
- FileStats(String filename): 构造方法，初始化文件路径。
- getNumLines(): 返回文件的总行数。
- getNumLinesThatContain(String key): 返回文件中包含指定文本（不区分大小写）的行数。

2. 实现文件总行数统计 (getNumLines)

getNumLines() 方法的实现相对直接，它通过创建一个File对象，然后使用Scanner逐行读取文件并计数。

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

public class FileStats {
    private String filename;

    public FileStats(String f) {
        this.filename = f;
    }

    /**
     * 计算文件的总行数。
     * @return 文件的总行数。
     * @throws FileNotFoundException 如果文件不存在。
     */
    public int getNumLines() throws FileNotFoundException {
        // 使用try-with-resources确保Scanner资源自动关闭
        try (Scanner inputFile = new Scanner(new File(filename))) {
            int numLines = 0;
            while (inputFile.hasNextLine()) { // 检查是否有下一行
                inputFile.nextLine(); // 读取并丢弃该行
                numLines++;
            }
            return numLines;
        }
    }

    // ... 其他方法 ...
}

登录后复制

关键点：

new File(filename): 这是正确创建File对象的方式，它代表了文件系统中的一个文件。
new Scanner(new File(filename)): Scanner构造器接受一个File对象作为输入源，这样Scanner才能从指定的文件中读取内容。
try-with-resources: 这是一个Java 7+ 的特性，用于自动管理实现了AutoCloseable接口的资源（如Scanner）。当try块执行完毕或抛出异常时，Scanner会自动关闭，避免资源泄露。
hasNextLine() 和 nextLine(): 这是Scanner读取文本行的标准方式。

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

getNumLinesThatContain() 方法的目标是查找文件中包含特定子字符串的行，且不区分大小写。这个方法是原问题中出现错误的地方。

立即学习“Java免费学习笔记（深入）”；

叮当好记-AI音视频转图文

AI音视频转录与总结，内容学习效率 x10！

193

查看详情

3.1 常见错误分析

原代码中getNumLinesThatContain方法在初始化Scanner时犯了一个常见的错误：

// 错误示例：
// inputFile = new Scanner(filename); // filename 是一个String

登录后复制

这里的错误在于，Scanner有一个构造函数 Scanner(String source)，它会将传入的String参数本身作为要扫描的文本内容，而不是将其视为文件路径。例如，如果filename是"myFile.txt"，那么new Scanner("myFile.txt")会尝试扫描字符串字面量"myFile.txt"，而不是打开名为"myFile.txt"的文件。这导致Scanner很快就没有更多内容可读，从而使计数结果不正确（通常是0或1）。

3.2 正确实现

要解决这个问题，Scanner必须使用一个File对象作为输入源，就像在getNumLines()方法中那样。此外，为了实现不区分大小写的查找，我们需要将行内容和搜索关键字都转换为相同的大小写（例如，都转换为大写或小写）再进行比较。

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

public class FileStats {
    private String filename;

    public FileStats(String f) {
        this.filename = f;
    }

    // ... getNumLines() 方法 ...

    /**
     * 计算文件中包含指定文本（不区分大小写）的行数。
     * 如果一行中包含多次指定文本，仍只算作一行。
     * @param key 要查找的文本。
     * @return 包含指定文本的行数。
     * @throws FileNotFoundException 如果文件不存在。
     */
    public int getNumLinesThatContain(String key) throws FileNotFoundException {
        // 同样使用try-with-resources确保Scanner资源自动关闭
        try (Scanner inputFile = new Scanner(new File(filename))) { // 核心修正：使用File对象
            int numLines = 0;
            // 将搜索关键字转换为大写，以便进行不区分大小写的比较
            String searchKeyUpperCase = key.toUpperCase();

            while (inputFile.hasNextLine()) {
                String line = inputFile.nextLine();
                // 将当前行内容转换为大写，然后检查是否包含搜索关键字
                if (line.toUpperCase().contains(searchKeyUpperCase)) {
                    numLines++;
                }
            }
            return numLines;
        }
    }
}

登录后复制

关键修正和最佳实践：

new Scanner(new File(filename)): 这是解决问题的核心。它确保Scanner正确地从文件而不是字符串字面量中读取数据。
异常处理: 两个方法都声明抛出FileNotFoundException。在实际应用中，调用者需要捕获并处理此异常，例如提示用户文件不存在。
资源管理: 坚持使用try-with-resources语句来确保Scanner对象在使用完毕后能够被正确关闭，释放文件句柄，避免资源泄露。
大小写不敏感比较: 使用toUpperCase()（或toLowerCase()）方法将行内容和搜索关键字都转换为相同的大小写，再调用contains()方法进行比较，确保查找结果不依赖于字母的大小写。
contains() 方法: String.contains()方法在判断一行是否包含某个子字符串时非常有用。它会返回true，只要该行中出现一次或多次目标子字符串，这符合题目要求“如果一行包含文本hello hello hello，这也只算作一行”。

4. 完整 FileStats 类示例

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

/**
 * FileStats 类用于统计文件的行数和查找包含特定文本的行。
 */
public class FileStats {
    private String filename;

    /**
     * 构造方法，初始化文件路径。
     * @param filename 待处理文件的路径。
     */
    public FileStats(String filename) {
        this.filename = filename;
    }

    /**
     * 计算文件的总行数。
     *
     * @return 文件的总行数。
     * @throws FileNotFoundException 如果指定的文件不存在。
     */
    public int getNumLines() throws FileNotFoundException {
        // 使用try-with-resources确保Scanner资源自动关闭
        try (Scanner inputFile = new Scanner(new File(filename))) {
            int numLines = 0;
            while (inputFile.hasNextLine()) {
                inputFile.nextLine(); // 读取并丢弃该行
                numLines++;
            }
            return numLines;
        }
    }

    /**
     * 计算文件中包含指定文本（不区分大小写）的行数。
     * 如果一行中包含多次指定文本，仍只算作一行。
     *
     * @param key 要查找的文本。
     * @return 包含指定文本的行数。
     * @throws FileNotFoundException 如果指定的文件不存在。
     */
    public int getNumLinesThatContain(String key) throws FileNotFoundException {
        // 同样使用try-with-resources确保Scanner资源自动关闭
        try (Scanner inputFile = new Scanner(new File(filename))) { // 关键修正：使用File对象
            int numLines = 0;
            // 将搜索关键字转换为大写，以便进行不区分大小写的比较
            String searchKeyUpperCase = key.toUpperCase();

            while (inputFile.hasNextLine()) {
                String line = inputFile.nextLine();
                // 将当前行内容转换为大写，然后检查是否包含搜索关键字
                if (line.toUpperCase().contains(searchKeyUpperCase)) {
                    numLines++;
                }
            }
            return numLines;
        }
    }

    /**
     * 主方法，用于测试 FileStats 类。
     * 需要在项目根目录下创建一个名为 "test.txt" 的文件。
     * 例如：
     * Hello World
     * java programming
     * Java is fun
     * hello again
     */
    public static void main(String[] args) {
        String filePath = "test.txt"; // 确保此文件存在于项目根目录或提供完整路径
        FileStats stats = new FileStats(filePath);

        try {
            // 示例：获取总行数
            int totalLines = stats.getNumLines();
            System.out.println("文件总行数: " + totalLines);

            // 示例：查找包含 "java" 的行数 (不区分大小写)
            int linesWithJava = stats.getNumLinesThatContain("java");
            System.out.println("包含 'java' 的行数: " + linesWithJava);

            // 示例：查找包含 "hello" 的行数 (不区分大小写)
            int linesWithHello = stats.getNumLinesThatContain("hello");
            System.out.println("包含 'hello' 的行数: " + linesWithHello);

            // 示例：查找不存在的文本
            int linesWithXYZ = stats.getNumLinesThatContain("xyz");
            System.out.println("包含 'xyz' 的行数: " + linesWithXYZ);

        } catch (FileNotFoundException e) {
            System.err.println("错误：文件未找到 - " + filePath);
            System.err.println("请确保文件存在且路径正确。");
        } catch (Exception e) {
            System.err.println("发生未知错误: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

登录后复制

5. 总结与注意事项

Scanner的正确初始化: 使用new Scanner(new File(filename))是读取文件内容的正确方式。切勿将文件路径字符串直接传递给Scanner，除非你确实想扫描该字符串字面量本身。
资源管理: 始终使用try-with-resources语句来处理Scanner或其他需要关闭的资源，这可以有效防止资源泄露。
异常处理: 文件操作可能引发FileNotFoundException。在编写代码时，必须考虑并处理这些潜在的异常，以提高程序的健壮性。
大小写敏感性: 当进行文本比较时，根据需求选择是否进行大小写转换（如toUpperCase()或toLowerCase()），以确保比较逻辑的正确性。
效率考量: 对于非常大的文件，逐行读取并处理可能不是最高效的方法。在处理TB级别的数据时，可能需要考虑更高级的I/O流操作或内存映射文件等技术。然而，对于大多数常见的文件处理任务，Scanner已经足够方便和高效。

以上就是Java文件内容统计与字符串查找：Scanner使用陷阱与最佳实践的详细内容，更多请关注php中文网其它相关文章！