本文详细指导如何在Java中构建一个FileStats类，用于统计文件的总行数以及查找包含特定文本内容的行数。教程涵盖了类的设计、方法实现、文件I/O操作的最佳实践（如try-with-resources），并着重纠正了在使用Scanner读取文件时常见的初始化错误，确保代码的健壮性和正确性。
1. FileStats 类概述
在java应用程序中，处理文件是常见的任务。FileStats 类旨在封装文件相关的统计功能，提供一个简洁的接口来获取文件的基本信息，例如总行数和包含特定文本的行数。这有助于提高代码的模块化和可重用性。
2. 类结构与核心字段
FileStats 类主要包含一个字段：filename，用于存储待处理文件的路径。需要注意的是，Scanner 对象通常不建议作为类的字段，因为文件流是需要及时关闭的资源。将其作为局部变量并在每次操作时创建和关闭，配合try-with-resources语句，可以更好地管理资源，避免资源泄露和状态混乱。
import java.io.File; import java.io.FileNotFoundException; import java.util.Scanner; public class FileStats { private String filename; /** * 构造方法，初始化文件路径 * @param filename 文件的路径 */ public FileStats(String filename) { this.filename = filename; } // 后续方法将在此处添加 }
3. 获取文件总行数：getNumLines() 方法
getNumLines() 方法用于计算文件中包含的总行数。实现此功能需要以下步骤：
- 创建一个 File 对象，代表要读取的文件。
- 使用 Scanner 对象逐行读取文件内容。
- 在读取过程中，每读取一行就增加计数器。
- 确保文件资源在使用完毕后被关闭。
为了保证文件资源（如Scanner）能够被正确关闭，即使在发生异常的情况下，我们强烈推荐使用Java 7引入的 try-with-resources 语句。
立即学习“Java免费学习笔记（深入）”；
/** * 获取文件的总行数 * @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; }
4. 查找包含特定文本的行数：getNumLinesThatContain(String key) 方法
getNumLinesThatContain() 方法用于统计文件中包含特定文本的行数。此方法的核心在于正确地读取文件内容，并进行大小写不敏感的文本匹配。
关键点：Scanner 初始化错误纠正
在原有的实现中，一个常见的错误是将Scanner初始化为new Scanner(filename)。这里的filename是一个字符串，当Scanner用字符串初始化时，它会将该字符串本身作为输入源进行扫描，而不是去读取由该字符串代表的文件。因此，它只会处理这个文件名字符串一次，导致计数结果不正确（通常是0或1）。
正确的做法是，Scanner必须用一个File对象来初始化，即new Scanner(fileObj)，这样Scanner才能真正地打开并读取文件内容。
/** * 获取文件中包含特定文本的行数（不区分大小写） * @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 对象初始化 Scanner // 将搜索关键字转换为大写，以便进行不区分大小写的比较 String upperCaseKey = key.toUpperCase(); while (inputFile.hasNextLine()) { String line = inputFile.nextLine(); // 将当前行转换为大写，然后检查是否包含搜索关键字 if (line.toUpperCase().contains(upperCaseKey)) { numLines++; } } } // Scanner 在此自动关闭 return numLines; }
5. 完整 FileStats 类实现
结合上述方法，一个完整且健壮的FileStats类实现如下：
import java.io.File; import java.io.FileNotFoundException; import java.util.Scanner; /** * FileStats 类用于提供文件的统计功能，包括总行数和包含特定文本的行数。 */ public class FileStats { private String filename; /** * 构造方法，初始化 FileStats 对象，指定要操作的文件路径。 * @param filename 文件的完整路径或相对路径。 */ public FileStats(String filename) { this.filename = filename; } /** * 获取文件的总行数。 * 该方法会打开文件，逐行读取并计数，最后关闭文件资源。 * @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; } /** * 获取文件中包含特定文本的行数（不区分大小写）。 * 该方法会打开文件，逐行读取，将行内容和搜索关键字都转换为大写后进行匹配。 * @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)) { // 将搜索关键字转换为大写，以便进行不区分大小写的比较 String upperCaseKey = key.toUpperCase(); while (inputFile.hasNextLine()) { String line = inputFile.nextLine(); // 将当前行内容转换为大写，然后检查是否包含转换后的关键字 if (line.toUpperCase().contains(upperCaseKey)) { numLines++; // 如果包含，则计数器递增 } } } // Scanner 会在此处自动关闭 return numLines; } // 示例用法（可选，通常放在单独的测试类中） public static void main(String[] args) { // 假设有一个名为 "example.txt" 的文件在项目根目录下 // example.txt 内容可能如下： // Hello World // hello java // LINE three // another line with hello String testFilename = "example.txt"; // 请确保此文件存在于运行目录下 try { FileStats stats = new FileStats(testFilename); int totalLines = stats.getNumLines(); System.out.println("文件总行数: " + totalLines); String searchKey = "hello"; int linesWithKey = stats.getNumLinesThatContain(searchKey); System.out.println("包含 '" + searchKey + "' 的行数: " + linesWithKey); // 预期输出 3 (Hello World, hello java, another line with hello) searchKey = "LINE"; linesWithKey = stats.getNumLinesThatContain(searchKey); System.out.println("包含 '" + searchKey + "' 的行数: " + linesWithKey); // 预期输出 1 (LINE three) searchKey = "nonexistent"; linesWithKey = stats.getNumLinesThatContain(searchKey); System.out.println("包含 '" + searchKey + "' 的行数: " + linesWithKey); // 预期输出 0 } catch (FileNotFoundException e) { System.err.println("错误：文件未找到 - " + testFilename); e.printStackTrace(); } catch (Exception e) { System.err.println("发生未知错误: " + e.getMessage()); e.printStackTrace(); } } }
6. 注意事项与最佳实践
- 资源管理 (try-with-resources): 始终使用 try-with-resources 语句来处理文件I/O流（如Scanner, FileReader, BufferedReader等）。这确保了资源在不再需要时或发生异常时能够自动关闭，有效避免了资源泄露。
- 异常处理: FileNotFoundException 是在文件操作中常见的受检异常。它必须被捕获或在方法签名中声明抛出。在实际应用中，除了打印堆栈跟踪，还可以考虑向用户提供更友好的错误信息，或者将异常包装为自定义的运行时异常抛出。
- 文件路径: 确保提供的文件路径是正确的。可以是绝对路径，也可以是相对于程序运行目录的相对路径。
- 性能考量: 对于非常大的文件，逐行读取并进行字符串操作可能会消耗较多内存和CPU。如果需要处理GB级别的文件，可以考虑使用 BufferedReader 配合 Stream API 或其他更高效的库。然而，对于大多数常见大小的文件，上述 Scanner 的实现已足够高效。
- 可测试性: 建议将 main 方法中的示例代码移到一个单独的测试类中，例如使用junit进行单元测试，以确保类功能的正确性。
7. 总结
通过本文的指导，我们成功构建了一个功能完善且健壮的 FileStats 类。它不仅能够准确地统计文件的总行数和包含特定文本的行数，还演示了Java文件I/O操作中的最佳实践，特别是Scanner的正确初始化和try-with-resources语句的应用。掌握这些知识对于编写高质量的Java文件处理程序至关重要。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
