File 、Files 与 Path
Java 的标准库 java.io 提供了 File 对象来操作文件和目录。构造 File 对象时,既可以传入绝对路径,也可以传入相对路径。绝对路径是以根目录开头的完整路径,例如:
File f = new File("C:\\Windows\\notepad.exe");
注意 Windows 平台使用 \ 作为路径分隔符,在 Java 字符串中需要用 \ 表示一个 \ 。Linux 平台使用 / 作为路径分隔符:
File f = new File("/usr/bin/javac");
传入相对路径时,相对路径前面加上当前目录就是绝对路径:
// 假设当前目录是 C:\Docs
File f1 = new File("sub\\javac"); // 绝对路径是 C:\Docs\sub\javac
File f3 = new File(".\\sub\\javac"); // 绝对路径是 C:\Docs\sub\javac
File f3 = new File("..\\sub\\javac"); // 绝对路径是 C:\sub\javac
可以用 . 表示当前目录,.. 表示上级目录。
File 对象有 3 种形式表示的路径,一种是 getPath() ,返回构造方法传入的路径,一种是getAbsolutePath() ,返回绝对路径,一种是 getCanonicalPath() ,它和绝对路径类似,但是返回的是规范路径。
什么是规范路径?我们看以下代码:
import java.io.*;
public class Main {
public static void main(String[] args) throws IOException {
File f = new File("..");
System.out.println(f.getPath());
System.out.println(f.getAbsolutePath());
System.out.println(f.getCanonicalPath());
}
}
绝对路径可以表示成 C:\Windows\System32..\notepad.exe ,而规范路径就是把 . 和 .. 转换成标准的绝对路径后的路径:C:\Windows\notepad.exe 。
因为 Windows 和 Linux 的路径分隔符不同,File 对象有一个静态变量用于表示当前平台的系统分隔符:
System.out.println(File.separator); // 根据当前平台打印 "\" 或 "/"
文件和目录
File 对象既可以表示文件,也可以表示目录。特别要注意的是,构造一个File对象,即使传入的文件或目录不存在,代码也不会出错,因为构造一个 File 对象,并不会导致任何磁盘操作。只有当我们调用 File 对象的某些方法的时候,才真正进行磁盘操作。
例如,调用 isFile() ,判断该 File 对象是否是一个已存在的文件,调用 isDirectory() ,判断该 File 对象是否是一个已存在的目录:
import java.io.*;
public class Main {
public static void main(String[] args) throws IOException {
File f1 = new File("C:\\Windows");
File f2 = new File("C:\\Windows\\notepad.exe");
File f3 = new File("C:\\Windows\\nothing");
System.out.println(f1.isFile());
System.out.println(f1.isDirectory());
System.out.println(f2.isFile());
System.out.println(f2.isDirectory());
System.out.println(f3.isFile());
System.out.println(f3.isDirectory());
}
}
用 File 对象获取到一个文件时,还可以进一步判断文件的权限和大小:
- boolean canRead():是否可读
- boolean canWrite():是否可写
- boolean canExecute():是否可执行
- long length():文件字节大小
创建和删除文件
当 File 对象表示一个文件时,可以通过 createNewFile() 创建一个新文件,用 delete() 删除该文件:
File file = new File("/path/to/file");
if (file.createNewFile()) {
// 文件创建成功:
// TODO:
if (file.delete()) {
// 删除文件成功:
}
}
有些时候,程序需要读写一些临时文件,File 对象提供了 createTempFile() 来创建一个临时文件,以及 deleteOnExit() 在 JVM 退出时自动删除该文件。
import java.io.*;
public class Main {
public static void main(String[] args) throws IOException {
File f = File.createTempFile("tmp-", ".txt"); // 提供临时文件的前缀和后缀
f.deleteOnExit(); // JVM退出时自动删除
System.out.println(f.isFile());
System.out.println(f.getAbsolutePath());
}
}
遍历文件和目录
当 File 对象表示一个目录时,可以使用 list() 和 listFiles() 列出目录下的文件和子目录名。listFiles() 提供了一系列重载方法,可以过滤不想要的文件和目录:
import java.io.*;
public class Main {
public static void main(String[] args) throws IOException {
File f = new File("C:\\Windows");
File[] fs1 = f.listFiles(); // 列出所有文件和子目录
printFiles(fs1);
File[] fs2 = f.listFiles(new FilenameFilter() { // 仅列出.exe文件
public boolean accept(File dir, String name) {
return name.endsWith(".exe"); // 返回true表示接受该文件
}
});
printFiles(fs2);
}
static void printFiles(File[] files) {
System.out.println("==========");
if (files != null) {
for (File f : files) {
System.out.println(f);
}
}
System.out.println("==========");
}
}
和文件操作类似,File 对象如果表示一个目录,可以通过以下方法创建和删除目录:
- boolean mkdir():创建当前 File 对象表示的目录
- boolean mkdirs():创建当前 File 对象表示的目录,并在必要时将不存在的父目录也创建出来
- boolean delete():删除当前 File 对象表示的目录,当前目录必须为空才能删除成功
Path
Java 标准库还提供了一个 Path 对象,它位于 java.nio.file 包。Path 对象和 File 对象类似,但操作更加简单:
import java.io.*;
import java.nio.file.*;
public class Main {
public static void main(String[] args) throws IOException {
Path p1 = Paths.get(".", "project", "study"); // 构造一个Path对象
System.out.println(p1);
Path p2 = p1.toAbsolutePath(); // 转换为绝对路径
System.out.println(p2);
Path p3 = p2.normalize(); // 转换为规范路径
System.out.println(p3);
File f = p3.toFile(); // 转换为 File 对象
System.out.println(f);
for (Path p : Paths.get("..").toAbsolutePath()) { // 可以直接遍历 Path
System.out.println(" " + p);
}
}
}
使用 Files
从 Java 7 开始,提供了 Files 这个工具类,能极大地方便我们读写文件。
虽然 Files 是 java.nio 包里面的类,但他俩封装了很多读写文件的简单方法,例如,我们要把一个文件的全部内容读取为一个 byte[] ,可以这么写:
byte[] data = Files.readAllBytes(Path.of("/path/to/file.txt"));
如果是文本文件,可以把一个文件的全部内容读取为String:
// 默认使用UTF-8编码读取:
String content1 = Files.readString(Path.of("/path/to/file.txt"));
// 可指定编码:
String content2 = Files.readString(Path.of("/path", "to", "file.txt"), StandardCharsets.ISO_8859_1);
// 按行读取并返回每行内容:
List<String> lines = Files.readAllLines(Path.of("/path/to/file.txt"));
写入文件也非常方便:
// 写入二进制文件:
byte[] data = ...
Files.write(Path.of("/path/to/file.txt"), data);
// 写入文本并指定编码:
Files.writeString(Path.of("/path/to/file.txt"), "文本内容...", StandardCharsets.ISO_8859_1);
// 按行写入文本:
List<String> lines = ...
Files.write(Path.of("/path/to/file.txt"), lines);
此外,Files 工具类还有 copy() 、delete() 、exists() 、move() 等快捷方法操作文件和目录。
最后需要特别注意的是,Files 提供的读写方法,受内存限制,只能读写小文件,例如配置文件等,不可一次读入几个 G 的大文件。读写大型文件仍然要使用文件流,每次只读写一部分文件内容。