Java 文件操作工具类（FileUtils）

引言

在 Java 开发中，文件操作是一个非常常见的需求，例如读取文件、写入文件、复制文件、删除文件、遍历目录等。虽然 Java 提供了丰富的 java.io 和 java.nio 包来处理文件操作，但这些 API 的使用往往需要编写大量的样板代码。为简化文件操作，提高开发效率，通常会封装一个文件操作工具类，如 FileUtils。本文将介绍如何构建一个功能丰富的 FileUtils 工具类，并演示其在各种文件操作场景中的应用。

FileUtils 工具类设计

FileUtils 是一个专注于文件操作的实用工具类。为了实现文件操作的便捷性和代码的复用性，FileUtils 可以包含以下主要功能：

1. 读取文件内容：读取文本文件或二进制文件的内容。
2. 写入文件：将数据写入文本文件或二进制文件。
3. 复制文件：将一个文件复制到另一个位置。
4. 删除文件：删除文件或目录。
5. 遍历目录：遍历目录下的所有文件和子目录。
6. 获取文件属性：获取文件的大小、最后修改时间、是否为目录等属性。
7. 创建文件或目录：创建新文件或目录。
8. 检查文件或目录是否存在：判断文件或目录是否存在。

以下是一个完整的 FileUtils 工具类的实现，包括这些常用的文件操作方法。

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;
import java.util.ArrayList;
import java.util.List;

public class FileUtils {

    // 读取文本文件内容为字符串
    public static String readFileToString(File file) throws IOException {
        StringBuilder content = new StringBuilder();
        try (BufferedReader reader = new BufferedReader(new FileReader(file))) {
            String line;
            while ((line = reader.readLine()) != null) {
                content.append(line).append(System.lineSeparator());
            }
        }
        return content.toString();
    }

    // 读取文件内容为字节数组
    public static byte[] readFileToByteArray(File file) throws IOException {
        return Files.readAllBytes(file.toPath());
    }

    // 将字符串写入文本文件
    public static void writeStringToFile(File file, String data) throws IOException {
        try (BufferedWriter writer = new BufferedWriter(new FileWriter(file))) {
            writer.write(data);
        }
    }

    // 将字节数组写入文件
    public static void writeByteArrayToFile(File file, byte[] data) throws IOException {
        Files.write(file.toPath(), data);
    }

    // 复制文件
    public static void copyFile(File source, File destination) throws IOException {
        Files.copy(source.toPath(), destination.toPath(), StandardCopyOption.REPLACE_EXISTING);
    }

    // 删除文件或目录
    public static void delete(File file) throws IOException {
        if (file.isDirectory()) {
            // 删除目录及其内容
            try (Stream<Path> paths = Files.walk(file.toPath())) {
                paths.sorted(Comparator.reverseOrder())
                     .map(Path::toFile)
                     .forEach(File::delete);
            }
        } else {
            // 删除文件
            Files.deleteIfExists(file.toPath());
        }
    }

    // 遍历目录，获取所有文件
    public static List<File> listFiles(File directory) {
        List<File> fileList = new ArrayList<>();
        if (directory.isDirectory()) {
            File[] files = directory.listFiles();
            if (files != null) {
                for (File file : files) {
                    if (file.isDirectory()) {
                        fileList.addAll(listFiles(file));
                    } else {
                        fileList.add(file);
                    }
                }
            }
        }
        return fileList;
    }

    // 获取文件大小
    public static long getFileSize(File file) {
        return file.length();
    }

    // 获取文件最后修改时间
    public static long getLastModifiedTime(File file) {
        return file.lastModified();
    }

    // 检查文件或目录是否存在
    public static boolean exists(File file) {
        return file.exists();
    }

    // 创建新文件
    public static boolean createNewFile(File file) throws IOException {
        return file.createNewFile();
    }

    // 创建目录
    public static boolean createDirectory(File directory) {
        return directory.mkdirs();
    }
}

方法详解

1. 读取文件内容：

   • readFileToString(File file): 使用 BufferedReader 按行读取文本文件的内容，并将其拼接成一个字符串。
   • readFileToByteArray(File file): 使用 Files.readAllBytes() 将文件读取为字节数组，适用于读取二进制文件。

2. 写入文件：

   • writeStringToFile(File file, String data): 使用 BufferedWriter 将字符串写入到指定的文本文件中。
   • writeByteArrayToFile(File file, byte[] data): 使用 Files.write() 将字节数组写入到文件中。

3. 复制文件：

   • copyFile(File source, File destination): 使用 Files.copy() 方法复制文件，如果目标文件已存在，则替换。

4. 删除文件或目录：

   • delete(File file): 使用 Files.deleteIfExists() 删除文件或使用 Files.walk() 遍历并删除目录及其所有内容。

5. 遍历目录：

   • listFiles(File directory): 递归遍历指定目录，返回该目录下所有文件和子目录中的文件。

6. 获取文件属性：

   • getFileSize(File file): 使用 file.length() 获取文件的大小。
   • getLastModifiedTime(File file): 使用 file.lastModified() 获取文件的最后修改时间。

7. 检查文件或目录是否存在：

   • exists(File file): 使用 file.exists() 方法检查文件或目录是否存在。

8. 创建文件或目录：

   • createNewFile(File file): 使用 file.createNewFile() 创建新文件。
   • createDirectory(File directory): 使用 directory.mkdirs() 创建多层目录。

实际应用示例

public class FileUtilsExample {
    public static void main(String[] args) {
        File file = new File("example.txt");
        
        // 写入数据到文件
        try {
            FileUtils.writeStringToFile(file, "Hello, FileUtils!");
            System.out.println("File written successfully.");
        } catch (IOException e) {
            e.printStackTrace();
        }
        
        // 读取文件内容
        try {
            String content = FileUtils.readFileToString(file);
            System.out.println("File content: " + content);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 复制文件
        File copy = new File("copy_example.txt");
        try {
            FileUtils.copyFile(file, copy);
            System.out.println("File copied successfully.");
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 删除文件
        try {
            FileUtils.delete(copy);
            System.out.println("File deleted successfully.");
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 检查文件是否存在
        if (FileUtils.exists(file)) {
            System.out.println("File exists.");
        } else {
            System.out.println("File does not exist.");
        }
    }
}

结论

通过封装常用的文件操作方法，FileUtils 工具类极大地简化了 Java 文件处理的复杂性。它提供了高效、直观的文件操作接口，使得开发者可以专注于业务逻辑而无需关注底层实现细节。无论是读取、写入、复制、删除文件，还是遍历目录、获取文件属性，FileUtils 都能够提供简洁且功能强大的支持。随着 Java 文件 API 的不断发展，FileUtils 也可以不断扩展，以满足更多的应用需求。

总结

Java文件操作工具类（FileUtils）是一个常见的工具类，用于简化Java程序中对文件的操作。它提供了许多静态方法，可以帮助开发人员快速读取、写入、复制、移动、删除文件等操作。

以下是Java文件操作工具类（FileUtils）的一些常用方法和功能：

读取文件内容：提供了读取文件内容的方法，包括读取全部内容和按行读取内容。可以使用这些方法将文件内容读取到String或List对象中。

写入文件内容：提供了写入文件内容的方法，可以将指定的字符串或字节数组写入文件中。还可以选择是否追加内容到文件末尾。

复制文件：提供了复制文件的方法，可以将一个文件复制到指定的目标文件夹中。

移动文件：提供了移动文件的方法，可以将一个文件从一个位置移动到另一个位置。

删除文件：提供了删除文件的方法，可以删除指定的文件或文件夹（包括子文件夹和文件）。

判断文件是否存在：提供了判断文件是否存在的方法，可以检查指定的文件或文件夹是否存在。

获取文件信息：提供了获取文件信息的方法，包括文件大小、最后修改时间等。

创建文件夹：提供了创建文件夹的方法，可以创建指定路径的文件夹。