java.io.File 的功能相當完整,幾乎所有檔案系統層級的操作都能透過它完成。本文依「建構、建立、刪除、判斷、取得、過濾、遞迴」七個主題,把常用方法整理成一份可查的清單,並附上可執行的範例。
public class FileDemo {
public static void main(String[] args) {
// File(String pathname)
File f1 = new File("c:\\abc\\1.txt");
// File(String parent, String child)
File f2 = new File("c:\\abc", "2.txt");
// File(File parent, String child)
File f3 = new File("c:" + File.separator + "abc"); // separator 為跨平台分隔符
File f4 = new File(f3, "3.txt");
System.out.println(f1); // c:\abc\1.txt
}
}
這裡最值得記的是 File.separator。它是平台相關的路徑分隔字元:Windows 上是 \,Linux 與 macOS 上是 /。寫死 \ 的程式碼一搬到 Linux 就會出問題,因此組裝路徑時一律用它(或直接用 Paths.get(a, b, c))。
1、boolean createNewFile()——不存在時建立並回傳 true,已存在則回傳 false。
2、boolean mkdir()——建立單層目錄,父目錄不存在時會失敗。
3、boolean mkdirs()——建立多層目錄,缺的父層會一併補上。
1、boolean delete()——刪除檔案或空目錄;非空目錄會刪失敗。
2、boolean deleteOnExit()——登記為「JVM 結束時刪除」,常用於暫存檔。
import java.io.File;
import java.io.IOException;
public class FileDemo2 {
public static void main(String[] args) {
File f = new File("d:\\1.txt");
try {
System.out.println(f.createNewFile()); // 檔案已存在時回傳 false
System.out.println(f.delete()); // 檔案不存在時回傳 false
} catch (IOException e) {
e.printStackTrace();
}
}
}
1、canExecute()——是否可執行
2、canRead()——是否可讀
3、canWrite()——是否可寫
4、exists()——是否存在
5、isDirectory()——是否為目錄
6、isFile()——是否為一般檔案
7、isHidden()——是否為隱藏檔
8、isAbsolute()——是否為絕對路徑(檔案不存在也能判斷)
1、getName()——檔名
2、getPath()——路徑字串
3、getAbsolutePath()——絕對路徑
4、getParent()——父目錄,無父目錄時回傳 null
5、lastModified()——最後修改時間(毫秒時間戳)
6、length()——檔案大小(位元組)
7、renameTo(File f)——重新命名或移動
8、listRoots()——取得機器上的各個根目錄(即磁碟機)
9、list()——列出目錄下的名稱
10、list(FilenameFilter filter)——依條件列出
public class FileDemo3 {
public static void main(String[] args) {
File[] files = File.listRoots();
for (File file : files) {
System.out.println(file);
if (file.length() > 0) {
String[] filenames = file.list();
for (String filename : filenames) {
System.out.println(filename);
}
}
}
}
}
注意 file.length() 對目錄而言回傳的並不是「檔案數」,這個判斷其實並不可靠。若目的是確認它真的是可讀目錄,應該用 file.isDirectory() 搭配 file.canRead();而 list() 在目錄不存在、不是目錄或發生 I/O 錯誤時會回傳 null,直接 foreach 會丟 NullPointerException,實務上必須先判空。
import java.io.File;
import java.io.FilenameFilter;
public class FileDemo4 {
public static void main(String[] args) {
File[] files = File.listRoots();
for (File file : files) {
System.out.println(file);
if (file.isDirectory() && file.canRead()) {
String[] filenames = file.list(new FilenameFilter() {
// file 為被檢查的目錄,name 為檔名
public boolean accept(File dir, String name) {
return name.endsWith(".mp3");
}
});
if (filenames != null) {
for (String filename : filenames) {
System.out.println(filename);
}
}
}
}
}
}
另有 File[] listFiles() 與 File[] listFiles(FilenameFilter filter) 兩個方法,回傳的是 File 陣列而非字串陣列,後續要做判斷或操作時更方便。
public class FileDemo5 {
public static void main(String[] args) {
File f = new File("e:\\音樂");
showDir(f);
}
public static void showDir(File dir) {
System.out.println(dir);
File[] files = dir.listFiles();
if (files == null) { return; } // 防呆:非目錄或無權限時為 null
for (File file : files) {
if (file.isDirectory()) {
showDir(file); // 是目錄就遞迴下去
} else {
System.out.println(file);
}
}
}
}
需求:找出 D 槽下所有的 .java 檔,複製到 c:\jad,並把副檔名改成 .jad。
public class Test5 {
public static void main(String[] args) {
File f1 = new File("d:\\");
moveFile(f1);
}
public static void moveFile(File dir) {
File[] files = dir.listFiles();
if (files == null) { return; }
for (File file : files) {
if (file.isDirectory()) {
moveFile(file);
} else {
if (file.getName().endsWith(".java")) {
file.renameTo(new File("c:\\jad\\" +
file.getName().substring(0, file.getName().lastIndexOf('.')) + ".jad"));
}
}
}
}
}
這裡有個必須澄清的錯誤:renameTo 是重新命名/移動,不是複製。原檔案會消失,而不是留下兩份。若需求真的是「複製」,得改用串流或 Files.copy() 自行搬位元組。
另外 renameTo 回傳布林值,失敗時不會丟例外,只回 false。跨磁碟區移動、目標已存在、權限不足、檔案被鎖住都會導致失敗,正式程式一定要檢查回傳值。
上述範例採用的 java.io.File 屬於舊 API,它最大的問題是「錯誤資訊貧乏」——大多數方法只回傳 false,不告訴你為什麼失敗。Java 7 引入的 java.nio.file.Files 與 Path 改善了這一切,失敗時會丟出明確的 IOException 子類,也提供 Files.list、Files.walk(串流式遞迴)、Files.copy、Files.move 等更完整的操作:
import java.nio.file.*;
import java.util.stream.Stream;
public class NioDemo {
public static void main(String[] args) throws Exception {
Path dir = Paths.get("e:", "音樂");
// 串流式遞迴走訪,只印出 .mp3
try (Stream<Path> paths = Files.walk(dir)) {
paths.filter(p -> p.toString().endsWith(".mp3"))
.forEach(System.out::println);
}
// 複製並保留原檔
Path src = Paths.get("d:", "a.java");
Path dst = Paths.get("c:", "jad", "a.jad");
Files.createDirectories(dst.getParent());
Files.copy(src, dst);
}
}
新專案請優先採用 nio;File 類別則可保留給需要與舊程式碼或特定框架互操作的情境。