使用Files.walkFileTree遍歷目錄檔案

2022-10-28 14:01:10

1.Files.walkFileTree的原理介紹

static Path walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor) throws IOException;
static Path walkFileTree(Path start, FileVisitor<? super Path> visitor) throws IOException;

參數列：

java.nio.file.Path start 遍歷的起始路徑
Set<java.nio.file.FileVisitOption> options 遍歷選項
int maxDepth 遍歷深度
java.nio.file.FileVisitor<? super Path> visitor 遍歷過程中的行為控制器

2.遍歷行為控制器FileVisitor

介面java.nio.file.FileVisitor包含四個方法，涉及到遍歷過程中的幾個重要的步驟節點。

一般實際中使用SimpleFileVisitor簡化操作。

public interface FileVisitor<T> {

    FileVisitResult preVisitDirectory(T dir, BasicFileAttributes attrs)
        throws IOException;

    FileVisitResult visitFile(T file, BasicFileAttributes attrs)
        throws IOException;

    FileVisitResult visitFileFailed(T file, IOException exc)
        throws IOException;

    FileVisitResult postVisitDirectory(T dir, IOException exc)
        throws IOException;
}

preVisitDirectory 存取一個目錄，在進入之前呼叫。
postVisitDirectory一個目錄的所有節點都被存取後呼叫。遍歷時跳過同級目錄或有錯誤發生，Exception會傳遞給這個方法
visitFile 檔案被存取時被呼叫。該檔案的檔案屬性被傳遞給這個方法
visitFileFailed 當檔案不能被存取時，此方法被呼叫。Exception被傳遞給這個方法。

3.遍歷行為結果 FileVisitResult

public enum FileVisitResult {
    CONTINUE,
    TERMINATE,
    SKIP_SUBTREE,
    SKIP_SIBLINGS;
}

CONTINUE 繼續遍歷
SKIP_SIBLINGS 繼續遍歷，但忽略當前節點的所有兄弟節點直接返回上一層繼續遍歷
SKIP_SUBTREE 繼續遍歷，但是忽略子目錄，但是子檔案還是會存取
TERMINATE 終止遍歷

4.查詢指定檔案

使用java.nio.file.Path提供的startsWith、endsWith等方法，需要特別注意的是：匹配的是路徑節點的完整內容，而不是字串。

例如： /usr/web/bbf.jar

Path path = Paths.get("/usr/web/bbf.jar");
path.endsWith("bbf.jar");  // true
path.endsWith(".jar");     // false

5.使用PathMatcher

@Test
public void visitFile2() throws IOException {
  // 查詢java和txt檔案
  String glob = "glob:**/*.{java,txt}";
  String path = "D:\work_java\bbf\CORE";

  final PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher(glob);

  Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
        throws IOException {
      if (pathMatcher.matches(file)) {
        System.out.println(file);
      }
      return FileVisitResult.CONTINUE;
    }
  });
}

getPathMatcher方法的引數語法：規則:模式，其中規則支援兩種模式glob和regex。

5.1全域性規則glob

使用類似於正規表示式但語法更簡單的模式，匹配路徑的字串。

glob:*.java 匹配以java結尾的檔案
glob:. 匹配包含’.'的檔案
glob:*.{java,class} 匹配以java或class結尾的檔案
glob:foo.? 匹配以foo開頭且一個字元擴充套件名的檔案
glob:/home// 在unix平臺上匹配，例如/home/gus/data等
glob:/home/** 在unix平臺上匹配，例如/home/gus，/home/gus/data
glob:c:\* 在windows平臺上匹配，例如c:foo，c:bar，注意字串跳脫

5.1.1規則說明

* 匹配零個或多個字元與名稱元件，不跨越目錄
** 匹配零個或多個字元與名稱元件，跨越目錄（含子目錄）
? 匹配一個字元的字元與名稱元件
跳脫字元，例如{表示匹配左花括號
[] 匹配方括號表示式中的範圍，連字元(-)可指定範圍。例如[ABC]匹配"A"、“B"和"C”；[a-z]匹配從"a"到"z"；[abce-g]匹配"a"、“b”、“c”、“e”、“f”、“g”；
[!..]匹配範圍之外的字元與名稱元件，例如[!a-c]匹配除"a"、“b”、"c"之外的任意字元
{}匹配組中的任意子模式，多個子模式用","分隔，不能巢狀。

5.2正則規則regex

使用java.util.regex.Pattern支援的正規表示式。

5.2.1範例

獲取指定擴充套件名的檔案

以下測試用例，目的都是獲取指定目錄下的.properties和.html檔案。

/**
 * 遞迴遍歷，字串判斷
 *
 * @throws IOException IO異常
 */
@Test
public void visitFile1() throws IOException {
  String path = "D:\work_java\hty\HTY_CORE";

  Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
        throws IOException {
      String pathStr = file.toString();
      if (pathStr.endsWith("properties") || pathStr.endsWith("html")) {
        System.out.println(file);
      }
      return FileVisitResult.CONTINUE;
    }
  });
}

/**
 * 遞迴遍歷，glob模式
 *
 * @throws IOException IO異常
 */
@Test
public void visitFile2() throws IOException {
  String glob = "glob:**/*.{properties,html}";
  String path = "D:\work_java\hty\HTY_CORE";

  final PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher(glob);

  Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
        throws IOException {
      if (pathMatcher.matches(file)) {
        System.out.println(file);
      }
      return FileVisitResult.CONTINUE;
    }
  });
}

/**
 * 遞迴遍歷，正則模式
 *
 * @throws IOException IO異常
 */
@Test
public void visitFile3() throws IOException {
  // (?i)忽略大小寫，(?:)標記該匹配組不應被捕獲
  String reg = "regex:.*\.(?i)(?:properties|html)";
  String path = "D:\work_java\hty\HTY_CORE";

  final PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher(reg);

  Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
        throws IOException {
      if (pathMatcher.matches(file)) {
        System.out.println(file);
      }
      return FileVisitResult.CONTINUE;
    }
  });
}

6.查詢指定檔案

/**
 * 查詢指定檔案
 *
 * @throws IOException IO異常
 */
@Test
public void visitFile() throws IOException {
  String path = "D:\work_java\hty\HTY_CORE\src";

  Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
        throws IOException {
      // 使用endsWith，必須是路徑中的一段，而不是幾個字元
      if (file.endsWith("log.java")) {
        System.out.println(file);
        // 找到檔案，終止操作
        return FileVisitResult.TERMINATE;
      }
      return FileVisitResult.CONTINUE;
    }
  });
}

7.遍歷單層目錄

使用DirectoryStream會獲取指定目錄下的目錄和檔案。可以使用newDirectoryStream的第二個引數進行篩選，glob語法。

/**
 * 遍歷單層目錄
 *
 * @throws IOException IO異常
 */
@Test
public void dir() throws IOException {
  Path source = Paths.get("D:\work_java\hty\HTY_CORE\src\main\resources");
  try (DirectoryStream<Path> stream = Files.newDirectoryStream(source, "*.xml")) {
    Iterator<Path> ite = stream.iterator();
    while (ite.hasNext()) {
      Path pp = ite.next();
      System.out.println(pp.getFileName());
    }
  }
}

8.複製檔案到新目錄

/**
 * 遞迴複製
 *
 * @throws IOException IO異常
 */
@Test
public void copyAll() throws IOException {
  Path source = Paths.get("D:\work_java\hty\HTY_CORE\src");
  Path target = Paths.get("D:\temp\core");
  // 原始檔夾非目錄
  if (!Files.isDirectory(source)) {
    throw new IllegalArgumentException("原始檔夾錯誤");
  }
  // 源路徑的層級數
  int sourcePart = source.getNameCount();
  Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
    @Override
    public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)
        throws IOException {
      // 在目標資料夾中建立dir對應的子資料夾
      Path subDir;
      if (dir.compareTo(source) == 0) {
        subDir = target;
      } else {
        // 獲取相對原路徑的路徑名，然後組合到target上
        subDir = target.resolve(dir.subpath(sourcePart, dir.getNameCount()));
      }
      Files.createDirectories(subDir);
      return FileVisitResult.CONTINUE;
    }

    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
      Files.copy(file, target.resolve(file.subpath(sourcePart, file.getNameCount())),
          StandardCopyOption.REPLACE_EXISTING);
      return FileVisitResult.CONTINUE;
    }
  });
  System.out.println("複製完畢");
}

9.檔案和流的複製

/**
 * 流複製到檔案
 *
 * @throws IOException IO異常
 */
@Test
public void copy1() throws IOException {
  Path source = Paths.get("D:\work_java\hty\HTY_CORE\src\main\resources\ehcache.xml");
  Path target = Paths.get("D:\temp\");
  if (!Files.exists(target)) {
    Files.createDirectories(target);
  }
  Path targetFile = target.resolve(source.getFileName());
  try (InputStream fs = FileUtils.openInputStream(source.toFile())) {
    Files.copy(fs, targetFile, StandardCopyOption.REPLACE_EXISTING);
  }
}

/**
 * 檔案複製到流
 *
 * @throws IOException IO異常
 */
@Test
public void copy2() throws IOException {
  Path source = Paths.get("D:\work_java\hty\HTY_CORE\src\main\resources\ehcache.xml");
  Path target = Paths.get("D:\temp\core");
  Path targetFile = target.resolve(source.getFileName());
  if (!Files.exists(target)) {
    Files.createDirectories(target);
  }
  try (OutputStream fs = FileUtils.openOutputStream(targetFile.toFile());
      OutputStream out = new BufferedOutputStream(fs)) {
    Files.copy(source, out);
  }
}

10.Path與File的轉換

/**
 * Path與File的轉換
 */
@Test
public void testPath() {
	File file = new File("D:\work_java\hty\HTY_CORE");
	System.out.println(file.toURI());//file:/D:/work_java/hty/HTY_CORE
	System.out.println(file.getAbsolutePath());//D:work_javahtyHTY_CORE
	System.out.println(file.getName());//HTY_CORE
	
	System.out.println("-------");
	//File轉換為Path
	Path path = Paths.get(file.toURI());
	System.out.println(path.toUri());//file:///D:/work_java/hty/HTY_CORE
	System.out.println(path.toAbsolutePath());//D:work_javahtyHTY_CORE
	System.out.println(path.getFileName());//HTY_CORE
	
	System.out.println("-------");
	//Path轉換為File
	File f = path.toFile();
	System.out.println(f.getAbsolutePath());//D:work_javahtyHTY_CORE
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。