Java7 新特性 —— java.nio.file 文件操作

本文部分摘自 On Java 8

自 Java7 開始，Java 終於簡化了文件讀寫的基本操作，新增了 java.nio.file 庫，通過與 Java8 新增的 stream 結合可以使得文件操作變得更加優雅

文件和目錄路徑

java.nio.file.Paths 類包含一個重載方法 static.get()，可以接受一系列 String 字符串或一個統一資源標識符 URI 作為參數，並且轉換返回一個 Paths 對象。使用 Paths 對象可以很輕松地生成路徑的某一部分：

Path path1 = Paths.get("C:", "path", "to", "nowhere", "NoFile.txt");
Path path2 = Paths.get("C:/path/to/nowhere/NoFile.txt");
URI uri = path2.toUri();
Path3 path3 = Paths.get(uri);

一個 Path 對象表示一個文件或者目錄的路徑，是一個跨操作系統和文件系統的抽象，目的是在構造路徑時可以不必關注底層操作系統。如果 Path 僅由一個空的名稱元素組成，則認為是空的路徑。使用空路徑訪問文件等同於訪問文件系統的默認目錄。Path 接口的實現是不可變且安全的，可供多個並行線程使用

使用 Path 對象可以非常容易地生成路徑的某一部分：

// 返回表示此路徑的絕對路徑的Path對象
Path p = Paths.get("PartsOfPaths.java").toAbsolutePath();
// 返回表示此路徑的真實路徑的Path對象，也即是帶上盤符（根路徑）
Path p2 = Paths.get("PartsOfPaths.java").toRealPath();
// getNameCount() 返回路徑中的名稱元素的數量
// 例如 p 的絕對路徑是 C:\User\Bruce\Documents\GitHub\PartsOfPaths.java
// 則此循環會依次輸出 User、Bruce、Documents、PartsOfPaths.java
for(int i = 0; i < p.getNameCount(); i++) {
    // 返回此路徑的名稱元素作為 Path對象
    System.out.println(p.getName(i));
}
// 測試路徑是否以給定的路徑結束，這里會輸出 end with '.java':false
System.out.println("ends with '.java': " + p.endsWith(".java"));
// Path 也實現了 iterable 接口，會對路徑中的名稱元素進行遍歷
for(Path pp : p) {
	...
}
// getRoot() 返回此路徑的根路徑作為Path對象，為null則該路徑不具有根
// startsWith() 效果和 endsWith() 相似
// 這里會輸出 Starts with C:\ true
System.out.println("Starts with " + p.getRoot() + " " + p.startsWith(p.getRoot()));

有時我們還需要通過對 Path 對象增加或修改一部分來構造一個新的 path 對象，可以使用 relativize() 移除 Path 的根路徑，或者使用 resolve() 添加 Path 的尾路徑，注意添加的路徑可以不是真實存在的

// 使用..可以跳轉到上一級路徑，但必須使用normalize()方法
// 假設當前路徑為C:\Users\Bruce\Documents\GitHub\PartsOfPaths.java，則輸出C:\Users 
Path base = Paths.get("..", "..", "..").toAbsolutePath().normalize();
// 返回表示此路徑的絕對路徑的Path對象
Path p = Paths.get("PartsOfPaths.java").toAbsolutePath();
// 構造此路徑和給定路徑之間的相對路徑
Path p2 = base.relativize(p);
// 使用resolve構造路徑
// 此時路徑為C:\Users\Bruce\Documents\GitHub\string
Path convoluted = p.getParent().resolve("string");

有關 Path 的更多用法，可以查閱 Java API 了解更多信息

Files

Files 工具類包含一系列完整的方法用於獲取 Path 的相關信息

Path p = Paths.get("PartsOfPaths.java").toAbsolutePath();
// 文件是否存在
Files.exists(p);
// 文件是否是目錄
Files.isDirectory(p);
// 文件是否可執行
Files.isExecutable(p);
// 文件是否可讀
Files.isReadable(p);
// 文件是否是具有不透明內容的常規文件
// 比如在linux下，設備也是一個文件，這個就不屬於Regular File
Files.isRegularFile(p);
// 文件是否可寫
Files.isWritable(p);
// 文件是否不存在
Files.notExists(p);
// 文件是否被隱藏 
Files.isHidden(p);
// 返回文件的大小（以字節為單位）
Files.size(p);
// 返回與文件存儲相關的信息
Files.getFileStore(p);
// 返回文件的上次修改時間
Files.getLastModifiedTime(p);
// 返回文件的所有者
Files.getOwner(p);
// 探測文件的內容類型
Files.probeContentType(p);
// 文件是否是符號鏈接
Files.isSymbolicLink(p);

雖然 Files 工具類包含大部分我們需要的目錄和文件操作方法，但並沒有包含刪除目錄樹的相關方法，因此我們必須自己實現

public class RmDir {
    
    public static void rmdir(Path dir) throws IOException {
        
        Files.walkFileTree(dir, new SimpleFileVisitor<Path>() {
            
            @Override
            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                Files.delete(file);
                return FileVisitResult.CONTINUE;
            }

            @Override
            public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
                Files.delete(dir);
                return FileVisitResult.CONTINUE;
            }
        });
    }
}

刪除目錄樹意味着要遍歷每個子目錄和文件，FileVisitor 提供了一種標准機制來訪問集合中的每個對象，然后你需要提供在每個對象上執行的方法，此操作的定義取決於實現 FileVisitor 的四個抽象方法

preVisitDirectory();	// 在訪問目錄中條目之前在目錄上運行
visitFile();	// 運行目錄中的每一個文件	
visitFileFailed()	// 調用無法訪問的文件  
postVisitDirectory();	// 在訪問目錄中條目之后在目錄上運行，包括所有的子目錄

java.nio.file.SimpleFileVisitor 提供了所有方法的默認實現，因此在匿名內部類中，我們只需要重寫 visitFile() 和 postVisitDirectory() 實現刪除文件和刪除目錄，兩者都應該返回標志位決定是否繼續訪問，我們可以根據需要有條件地進行刪除

文件系統

我們需要一種方法查找文件系統的相關信息，可以通過使用靜態的 FileSystems 工具類獲取默認的文件系統，也可以在 path 對象上調用 getFileSystem() 以獲取創建該 Path 的文件系統

// 返回默認的文件系統
FileSystem fsys = FileSystems.getDefault();
// 返回一個迭代器，遍歷底層文件存儲
for(FileStore fs : fsys.getFileStores()) {
    show("File Store", fs);
}
// 返回一個迭代器，來遍歷根目錄的路徑
for(Path rd : fsys.getRootDirectories()) {
    show("Root Directory", rd);
}
// 返回名稱分隔符
String sep = fsys.getSeparator();
// 返回此文件系統的可選操作
UserPrincipalLookupService lookupService = fsys.getUserPrincipalLookupService();
// 文件系統是否打開，默認始終打開
fsys.isOpen();
// 文件系統是否只允許只讀訪問其文件存儲
fsys.isReadOnly();
// 返回創建此文件系統的提供程序
FileSystemProvider provider = fsys.provider();
// 返回文件系統支持的文件屬性視圖名稱
Set<String> set = fsys.supportedFileAttributeViews();

路徑監聽

通過 WatchService 可以設置一個進程對目錄中的更改做出響應，一個 WatchService 對象可以通過 FileSystem 生成

在下面這個例子中，delTxtFiles() 作為一個單獨的任務執行，該任務將遍歷整個目錄並刪除以 .txt 結尾的所有文件，WatchService 會對文件的刪除做出反應：

Path test = Paths.get("test");
// 要監視的文件
Files.createFile(test.resolve("Hello.txt"));
// 生成WatchService對象
WatchService watcher = FileSystems.getDefault().newWatchService();
// 注冊到test路徑，並指定監聽的動作
test.register(watcher, ENTRY_DELETE);
// 使用線程池執行刪除.txt結尾的文件
// 可以簡單理解PathWatcher::delTxtFiles就是我們自定義的方法
// 作用就是遍歷test及其子目錄刪除所有.txt結尾的文件
Executors.newSingleThreadScheduledExecutor().schedule(PathWatcher::delTxtFiles,
        250, TimeUnit.MILLISECONDS);
// watcher.take()將等待並阻塞在這里，直到目標事件發生
WatchKey key = watcher.take();
// 展示能對WatchEvent執行的全部操作
for(WatchEvent evt : key.pollEvents()) {
    System.out.println("evt.context(): " + evt.context() +
                       "\nevt.count(): " + evt.count() +
                       "\nevt.kind(): " + evt.kind());
    System.exit(0);
}

需要注意的是，WatchService 只會監視給定的目錄，並不包含其下的所有子目錄，所有本例中如果 test 下的子目錄還有其他 .txt 結尾的文件，並不會觸發 WatchService。要想監視整個子目錄，必須在每個子目錄放置一個 WatchService

文件查找與讀寫

我們可以通過在 FileSystem 對象上調用 getPathMatcher() 獲得一個 PathMatcher，然后傳入你感興趣的模式。模式有兩個選項：glob 和 regex，glob 比較簡單，功能也很強大，這里主要介紹 glob

Path test = Paths.get("test");
// 查找當前目錄及其子目錄下所有以.tmp或.txt結尾的Path
// **/表示當前目錄及其所有子目錄
// * 表示任何字符，大括號表示一系列的可能性
PathMatcher matcher = FileSystems.getDefault().getPathMatcher("glob:**/*.{tmp,txt}");
Files.walk(test).filter(matcher::matches).forEach(System.out::println);

找到文件之后，我們就可以對路徑和目錄做任何事情。如果一個文件很小，那么 java.nio.file.Files 類中的方法可以幫助你輕松地讀寫文本和二進制文件

使用 Files.readAllLines() 方法可以一次讀取整個文件，產出一個 List<String>，在這里結合流的知識，對文件內容進行打印

Files.readAllLines(Paths.get("../streams/Cheese.dat")).stream()
    .filter(line -> !line.startWith("//"))
    .map(line -> line.substring(0, line.lengtg(/2)))
    .forEach(System.out::println);

如果一個文件太大，一次性讀完會耗盡內存，或者說你只需要在文件的讀取中途操作以獲得想要的結果，可以使用 Files.lines() 將文件轉換為行的 stream

// 跳過十三行，然后選擇下一行並將其打印出來
Files.lines(Paths.get("PathInfo.java")).skip(13).findFirst().ifPresent(System.out::println);

使用 Files.write() 寫入 byte 數組或任何 iterable 對象

// 寫入 byte 數組
byte[] bytes = new byte[SIZE];
new Random(47).nextBytes(bytes);
Files.write(Paths.get("bytes.dat"), bytes);
System.out.println("bytes.dat: " + Files.size(Paths.get("bytes.dat")));
// 寫入 iterable 對象
List<String> lines = Files.readAllLines(Paths.get("../streams/Cheese.dat"));
Files.write(Paths.get("Cheese.txt"), lines);
System.out.println("Cheese.txt: " + Files.size(Paths.get("Cheese.txt")));