Java IO 中常用的目录和文件操作,用到的时候从这里拷贝就行了

7,569 阅读10分钟

本文为掘金社区首发签约文章,14天内禁止转载,14天后未获授权禁止转载,侵权必究!

上篇文章我们学习了用 Java 的 IO 流进行读写文件操作,这篇文章继续再把 Java IO 与文件、目录的创建、删除、权限等相关的操作再学习一下。

文件是操作系统对磁盘上数据的组织形式。文件包括文件路径和文件名,比如:

/Users/Calvin/Desktop/demo.txt

文件名的后缀其实是文件名的一部分,文件不一定要有后缀,但是一定要有文件路径和文件名,后缀名只是为了让一些操作系统更好的分辨文件的类型,以便对文件进行正确的操作,真正进行操作时,应用一般会检验文件的 MIME 类型,验证它属于哪种文件,而不是简单地靠后缀名判断。

所有的文件,不管是什么后缀名,都是一堆在磁盘上的二进制数据。这些二进制数据需要被正确的解析,文件才能被正确的使用。比如 PPT 文件,我们也可以用文本编辑器打开它,但是文本编辑器并不能正确解析PPT,所以显示的是一堆乱码。

即使是压缩文件,其实也只是一个文件,它通过内部的组织,将很多文件的数据以及目录结构信息压缩到了一个文件中。

本文我们来学习一下 Java 中常用的文件和目录操作,我们会写一个 Java 程序,每讲解完一个操作,程序就多一个文件操作的功能,到最后我们就有一个包含了常用文件操作功能的程序了,后续遇到相关的开发任务可以直接拿来参考。

Java IO 中对文件的抽象

上面我们介绍了文件是操作系统组织磁盘上数据的形式,在 Java 传统的 BIO 中通过 File 类( java.io.File)对文件的抽象,让我们可以通过 File 类访问系统的文件系统。使用 File 类提供的方法,可以完成以下操作:

  • 检查文件/目录是否存在。
  • 检查文件路径是文件还是目录。
  • 创建目录/文件
  • 读取目录中的文件列表。
  • 读取文件的长度。
  • 重命名或移动文件。
  • 删除一个文件或者空的目录。

下面我们通过几个实际的例子来介绍下使用 File 类完成上面这些文件操作。有一点需要注意的是,通过 File 类只能访问文件和目录元数据。如果需要读取或写入文件内容,应该使用 Java IO 的 FileInputStream 和 FileOutputStream 来完成,这部分内容我们放到后面的章节再介绍。

使用 File 类完成文件和目录操作

文件和环境变量分隔符

在使用 File 类操作文件和文件夹之前,我们先来看两个分隔符,一个叫文件路径分隔符,另外一个叫环境变量分隔符。之所以介绍这两种分隔符,原因是,它们在不同操作系统下的表示方式不一样。

比如说,文件路径分隔符在 Windows 系统里使用的是反斜线符合"" ,而在Unix 、Linux 的系统里使用的则是斜线符号 "",比如同样一个文件路径在 Windows 和 Mac 系统下会分别表示为

// 在 Windows 里的路径
C:\Users\Adminr\DeskTop\file.txt

// 在 Linux 或者 Mac 里的路径
/Users/Admin/Desktop/file.txt

所以为了提供跨平台的兼容性,针对文件路径的分隔符 Java 提供了静态变量 File.separator 表示文件路径分隔符,它会自动判断底层是什么操作系统返回正确的路径分隔符。

与文件路径分隔符有相似问题的还有环境变量的分隔符,也是在Windows 和 Linux 系统上有所不同,Windows 上使用分号";",Linux、Mac 这些系统上使用冒号":"。

// Windows 上的环境变量
C:\Windows\System32\cmd.exe;D:\Program Files\Java\jdk1.8.0
// Linux 上的环境变量
/usr/local/bin:/usr/bin:/bin

所以 Java 也提供了 File.pathSeparator 静态变量来帮我们处理环境变量分隔符在不同系统上的差异。

package com.example.learnfile;

import java.io.File;

public class SeparatorAppMain {
    public static void main(String[] args) {
        System.out.println("文件路径分隔符:" + File.separator);
        System.out.println("环境变量分隔符:" + File.pathSeparator);
    }
}

上面这个例程我们可以运行试一下,在Mac 上会有如下输出,使用 Windows 的读者们可以自己运行试一下,看看会不会输出Windows 对应的文件路径和环境变量分隔符。

文件路径分隔符:/
环境变量分隔符::

下面开始,我们通过编写一个简易的文件和目录操作类的形式讲解一下 File 提供的文件和目录操作功能。 首先我们给类添加两个属性

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Scanner;
import java.util.stream.Collectors;
public class CreateDirAndFileAppMain {
    public static final String ROOT = "." + File.separator;
    private static Scanner scanner = new Scanner(System.in);
 	...   
}
  • ROOT 表示我们这些操作所在的根目录,这里我们直接设置成了 ". " 代表执行 java 命令的所在目录。
  • scanner 是 java.util.Scanner 类的实例,它能以命令行交互的形式接受用户的输入,并把输入以字符串的形式一行行的读入到程序中。具体用法看后面的例子。

创建 File 实例

Java 在对文件系统类进行任何操作之前,必须先创建一个 File 类的实例。

File dir = new File(ROOT + "file-demo/");

File 类的构造方法以文件的路径作为参数,如果参数指定的是一个文件系统上不存在的文件或目录,构造方法也不会抛出异常而是会正常返回 File 类的实例,通过 File 实例我们再来判断文件/目录是否存在,进行文件操作等等。

创建文件夹

在了解所有文件和目录操作都是通过 File 实例的方法完成的这一点后,我们编写第一个工具方法,用 File 实例检查路径是否是目录,是且目录不存在则用 File 实例创建之。

    private static File createDir(String... restPaths) {

        String rest = joinRestDir(restPaths);
        System.out.println("将在" + ROOT + "下创建" + rest);
        File dir = new File(ROOT, rest);
        if (dir.exists() && dir.isDirectory()) {
            System.out.println("文件夹已经存在" + dir.toString());
            return dir;
        } else {
            boolean createSuccess = dir.mkdirs();
            if (createSuccess) {
                return dir;
            } else {
                throw new IllegalArgumentException("无法在" + ROOT + "下创建" + rest);
            }
        }

    }

    private static String joinRestDir(String... restPaths) {
        return Arrays.stream(restPaths).map(String::trim).collect(Collectors.joining(File.separator));
    }

这个方法有以下几点需要注意

  • File 的构造方法有好几个重载版本,这里使用的构造方法第一个参数是父目录,第二个参数是父目录下的子路径,两个参数拼接起来构成了 File 实例指向的完整路径。
  • dir.exists(),File 实例的 exists 方法能判断出实例指向的文件路径,在文件系统中是否真实存在;
  • dir.isDirectory(),File 实例的 isDirectory 方法能判断出实例指向的文件路径是否是文件夹;
  • dir.mkdirs(),最后调用 File 实例的 mkdirs() 方法逐层创建文件夹,整个路径上不存在的文件夹都会被创建出来。
  • joinRestDir 方法内使用 Lambda 把参数数组里的各级目录以文件分隔符作为分隔符合并成一个路径字符串。

CreateDir 方法的参数我们是从命令行用户的输入中读到的。

    private static File createDirs() {
        List<String> pathList = new ArrayList<>();
        while (true) {
            System.out.println("请输入文件路径,如果为空则结束");
            String path = scanner.nextLine();
            if (path.isBlank()) {
                break;
            }
            pathList.add(path);
        }

        return createDir(pathList.toArray(new String[0]));
    }
  • scanner.nextLine() 从用户命令行输入中读取一行,并以字符串形式返回。

该方法最后把用户输入的逐层目录名放到数组里,传递给了我们上面的创建目录的工具方法。

重命名目录/文件

    private static File renameDir(File dir) {
        System.out.println("请输入新的文件夹的名字:");
        String newDirName = scanner.nextLine().trim();

        File newDir = new File(dir.getParentFile(), newDirName);
        boolean renameSuccess = dir.renameTo(newDir);

        if (renameSuccess) {
            System.out.println("改名为" + newDirName + "成功");
        } else {
            System.out.println("改名为" + newDirName + "失败");
            return null;
        }

        return newDir;
    }
  • 重命名文件夹前,首先我们需要创建一个新的 File 对象,指向新的目标文件夹。
  • 使用源文件夹的 File 对象的 renameTo 方法,该方法接收目标文件夹对应的 File 实例作为参数,最终完成文件夹的重命名名。

其实通过例程我们也能看出来,重命名也能完成移动文件夹的操作,只要我们指定一个不同的父级目录的 File 对象作为 renameTo 的参数即可。同样我们这里演示的是重命名文件夹,如果 File 实例是指向一个文件的,那自然可以完成文件的重命名和移动。

所以使用 File 实例的 renameTo 方法我们能够完成:

  • 文件夹的重命名 / 移动
  • 文件的重命名 / 移动

创建文件

如果 File 实例指向的文件在文件系统里不存在,那么使用其 createNewFile() 方法,就能在文件系统里创建(持久化)该文件。

File file = new File"/tmp/file-demo/file.txt");
file.createNewFile();

这个我们不做过多解释,直接上我们创建文件的工具方法。

    private static String createFiles(File newDir) throws IOException {
        System.out.println("请输入文件名的前缀:");
        String fileName = scanner.next().trim();

        for (int i = 0; i < 20; i++) {
            File f = new File(newDir, fileName + i + ".txt");
            System.out.println("创建文件" + f.getName() + ": " + f.createNewFile());
        }

        return fileName;
    }

删除文件

要删除文件,调用 File 的 delete() 方法。

File file = new File"/tmp/file-demo/file.txt");
result = file.delete()

delete() 方法返回布尔值(true 或 false),表示删除是否成功。删除文件可能会因各种原因而失败,比如文件已打开、文件权限错误等。delete() 方法也能用于删除目录,但是只能删除不包含任何文件和子目录的空目录。 下面我们看一下删除文件的交互式演示程序。

    private static void deleteFiles(File newDir, String fileNameNew) {
        System.out.println("删除文件?");
		// 命令行里要输入 true 或者 false 只是是否删除文件
        boolean deleteFiles = scanner.nextBoolean();

        if (deleteFiles) {
            for (int i = 0; i < 20; i++) {
                File fn = new File(newDir, fileNameNew + i + ".txt");
                System.out.println("删除文件:" + fn.delete());
            }
        }
    }

上面的演示程序,通过读取命令行里输入的 true ,来确认用户想删除后再完成删除操作。

用递归完成目录删除

File 实例的 delete() 方法只能在目录为空时删除目录,如果要删除包含文件和子目录的目录,我们必须先遍历目录并删除所有文件和子目录,然后才能删除根目录。

这个迭代必须递归执行,才能完成目录的删除。

public static boolean deleteDir(File dir){
    File[] files = dir.listFiles();
    if(files != null){
        for(File file : files){
            if(file.isDirectory()){
                deleteDir(file);
            } else {
                file.delete();
            }
        }
    }
    return dir.delete();
}

上面这个方法使用了一个还未介绍的 listFiles(),不过相信你已经猜到它的作用了。File 实例的 listFiles() 方法能列出File实例指向的目录下的所有文件和子目录,然后我们遍历删除目录下的文件,如果遇到子目录则再次调用 deleteDir 方法完成子目录内文件的删除,最终,通过这种递归的方式完成整个目录的删除。

同样我们也写个交互确认删除文件夹的函数达到演示效果。

    private static void removeDir(File dir) {
        System.out.println("删除文件夹?");

        boolean deleteDir = scanner.nextBoolean();

        if (deleteDir) {
            deleteDir(dir);
        }
    }

执行演示程序

介绍完 File 类的方法操作文件和目录的功能后,我们整个演示程序就写完了,最后补充执行它的 Main 方法,让我们能运行这个演示程序

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Scanner;
import java.util.stream.Collectors;

public class CreateDirAndFileAppMain {
    // TODO 不同操作系统可以更改这个值,比如mac或者linux可以写为~代表home目录
    public static final String ROOT = "." + File.separator;
    private static Scanner scanner = new Scanner(System.in);

    public static void main(String[] args) throws IOException{
        // TODO 使用File类,依次创建多层文件夹,修改文件夹名字,在指定文件夹创建文件,删除文件,删除文件夹
        File dir = createDirs();

        File newDir = renameDir(dir);

        String fileName = createFiles(newDir);

        String fileNameNew = renameFiles(newDir, fileName);

        deleteFiles(newDir, fileNameNew);

        removeDir(newDir);
    }
    
    ......
}

最后

本文整体学习下来,我们一起完成的完整可运行程序,因为篇幅太长,放在了下面的链接里,需要的可自行取用