1. FileStats 类设计与目的
在Java应用程序中，对文本文件进行内容分析是常见的需求，例如统计文件的总行数、查找特定内容出现的行数等。为了封装这些功能，我们可以设计一个名为FileStats的类。
FileStats类的核心职责是：
- 管理一个文件的路径。
- 提供方法计算文件的总行数。
- 提供方法计算文件中包含指定文本的行数（不区分大小写）。
其基本结构定义如下：
-
字段:
- filename: String 类型，存储待分析文件的完整路径或文件名。
-
方法:
- FileStats(String filename): 构造方法，初始化文件路径。
- getNumLines(): int 类型，返回文件的总行数。
- getNumLinesThatContain(String key): int 类型，返回包含指定key文本的行数。
2. 实现 getNumLines() 方法：统计文件总行数
getNumLines() 方法的目标是读取文件并计算其包含的行数。实现此功能，我们需要使用java.io.File来表示文件，以及java.util.Scanner来逐行读取文件内容。为了确保资源（文件句柄）的正确关闭，即使发生异常，也应采用Java 7及以上版本引入的try-with-resources语句。
立即学习“Java免费学习笔记（深入）”；
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 {
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;
}
// 其他方法将在此处添加
}代码解析:
- File fileObj = new File(filename);: 创建一个File对象，它代表了磁盘上的文件。
- try (Scanner inputFile = new Scanner(fileObj)): 这是关键部分。Scanner被初始化为从fileObj（即实际的文件）中读取数据。try-with-resources确保了Scanner对象在代码块执行完毕后（无论正常结束还是发生异常）都会被自动关闭，从而避免资源泄露。
- while (inputFile.hasNextLine()): 循环检查是否还有下一行可读。
- inputFile.nextLine();: 读取当前行。在此方法中，我们只关心行数，因此不需要存储或处理行的内容。
- numLines++;: 每读取一行，计数器加一。
3. 实现 getNumLinesThatContain(String key) 方法：统计包含特定文本的行数
getNumLinesThatContain() 方法旨在查找文件中包含特定key文本的行数，且查找过程不区分大小写。此方法与getNumLines()类似，都需要读取文件，但在此基础上增加了内容匹配的逻辑。
常见陷阱分析：new Scanner(filename) 的误用
在实现此方法时，一个常见的错误是尝试使用new Scanner(filename)来初始化Scanner。例如：
// 错误示例：试图从字符串字面量 "filename" 中读取，而非文件内容 // inputFile = new Scanner(filename);
当您将一个String类型的变量直接传递给Scanner的构造函数时，Scanner会将其视为要扫描的“文本字符串”本身，而不是一个文件路径。这意味着Scanner将尝试从字符串"your_file_name.txt"中读取内容，而不是打开并读取your_file_name.txt这个文件的实际内容。这会导致Scanner很快就没有更多内容可读（因为它只读取了作为其输入参数的那个字符串），从而返回不正确的结果（通常是0或1）。
正确初始化 Scanner
正确的做法是始终将File对象传递给Scanner构造函数，以便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;
}
// ... getNumLines() 方法 ...
/**
* 计算文件中包含指定文本的行数（不区分大小写）。
* 一行中无论包含多少次关键词，只计数一次。
*
* @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)) { // 修正：从 File 对象读取
while (inputFile.hasNextLine()) {
String line = inputFile.nextLine();
// 将行内容和搜索关键词都转换为大写，然后进行包含性检查
if (line.toUpperCase().contains(key.toUpperCase())) {
numLines++;
}
}
}
return numLines;
}
}代码解析:
- File fileObj = new File(filename);: 同样，首先创建File对象。
- try (Scanner inputFile = new Scanner(fileObj)): 这是关键的修正点，确保Scanner是从File对象中读取数据。
- String line = inputFile.nextLine();: 逐行读取文件内容。
- if (line.toUpperCase().contains(key.toUpperCase())): 这是实现不区分大小写查找的核心逻辑。
- line.toUpperCase(): 将当前行内容转换为大写。
- key.toUpperCase(): 将搜索关键词转换为大写。
- .contains(): 检查转换后的行内容是否包含转换后的关键词。如果包含，则表示该行匹配。
4. 完整 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) {
// 创建一个用于测试的文件
// 假设当前目录下有一个名为 "test.txt" 的文件，内容如下：
// Hello World
// hello java
// Java Programming
// This is a test line.
// Hello again.
String testFileName = "test.txt"; // 请确保此文件存在于运行目录下或提供完整路径
// 简单的文件创建辅助函数 (实际应用中文件应已存在)
try {
java.io.FileWriter writer = new java.io.FileWriter(testFileName);
writer.write("Hello World\n");
writer.write("hello java\n");
writer.write("Java Programming\n");
writer.write("This is a test line.\n");
writer.write("Hello again.\n");
writer.close();
} catch (java.io.IOException e) {
System.err.println("创建测试文件失败: " + e.getMessage());
return;
}
try {
FileStats stats = new FileStats(testFileName);
// 测试 getNumLines()
int totalLines = stats.getNumLines();
System.out.println("文件总行数: " + totalLines); // 预期输出: 5
// 测试 getNumLinesThatContain()
String searchKey1 = "hello";
int linesWithHello = stats.getNumLinesThatContain(searchKey1);
System.out.println("包含 '" + searchKey1 + "' 的行数: " + linesWithHello); // 预期输出: 3 (Hello World, hello java, Hello again.)
String searchKey2 = "java";
int linesWithJava = stats.getNumLinesThatContain(searchKey2);
System.out.println("包含 '" + searchKey2 + "' 的行数: " + linesWithJava); // 预期输出: 2 (hello java, Java Programming)
String searchKey3 = "nonexistent";
int linesWithNonexistent = stats.getNumLinesThatContain(searchKey3);
System.out.println("包含 '" + searchKey3 + "' 的行数: " + linesWithNonexistent); // 预期输出: 0
} catch (FileNotFoundException e) {
System.err.println("错误：文件未找到 - " + e.getMessage());
}
}
}5. 注意事项与最佳实践
- 资源管理 (try-with-resources): 始终使用try-with-resources来处理需要关闭的资源（如Scanner、文件流等）。这能确保资源在不再需要时自动关闭，即使发生异常也能避免资源泄露。这是现代Java编程的推荐做法。
- 异常处理 (FileNotFoundException): 文件操作可能抛出FileNotFoundException。在方法签名中声明此异常（throws FileNotFoundException），并将异常处理的责任传递给调用者，或者在方法内部捕获并处理它（例如，打印错误信息或返回特定值）。在我们的例子中，选择了前者，让调用者决定如何处理文件不存在的情况。
- 可重用性与效率: 在这个FileStats设计中，每次调用getNumLines()或getNumLinesThatContain()时，都会重新打开和关闭文件。对于小型文件或不频繁的操作，这通常不是问题。但如果需要对同一个文件进行大量不同类型的分析操作，考虑在FileStats构造函数中打开文件流并将其作为字段维护，或者提供一个方法来重置文件读取位置，以避免重复打开/关闭文件的开销。然而，这种优化会增加资源管理的复杂性，需要更细致的try-finally或更复杂的流管理。对于本教程的简单统计需求，当前的设计是清晰且安全的。
- 路径处理: 确保filename参数是正确的文件路径。如果文件不在当前工作目录下，需要提供绝对路径或相对于工作目录的正确相对路径。
- 空文件处理: 如果文件为空，hasNextLine()会立即返回false，两个方法都会正确返回0。
- 性能考量 (大文件): 对于非常大的文件，逐行读取并转换为大写可能会消耗较多内存和CPU。如果性能是关键因素，可以考虑使用BufferedReader进行更高效的行读取，或者在contains操作前进行更细粒度的优化（例如，先检查首字母，或使用更高级的文本搜索算法）。但对于大多数常见文件大小，当前方法足够高效。
总结
通过本文，我们学习了如何构建一个FileStats类来执行基本的文件内容统计任务。关键点在于：
- 正确使用java.io.File对象来表示文件。
- 利用java.util.Scanner逐行读取文件内容。
- 避免将文件路径字符串直接传递给Scanner构造函数，而应传递File对象。 这是导致文件读取错误的常见陷阱。
- 利用try-with-resources结构来确保文件资源的正确关闭，提高代码的健壮性。
- 结合toUpperCase()和contains()方法实现不区分大小写的文本搜索。
掌握这些基本的文件I/O操作和错误处理技巧，是进行更复杂Java文件处理任务的基础。
