Java java.nio.file.Files newDirectoryStream() メソッド

Java java.nio.file.Files


java.nio.file.Files.newDirectoryStream()Java NIO (New I/O) パッケージ内の非常に実用的なメソッドであり、ディレクトリ内のファイルとサブディレクトリを走査するために使用されます。従来のjava.io.Fileものと比較して、より効率的で柔軟なディレクトリ走査方法を提供します。

メソッド定義

public static DirectoryStream<Path> newDirectoryStream(Path dir) throws IOException

public static DirectoryStream<Path> newDirectoryStream(Path dir, String glob) throws IOException

public static DirectoryStream<Path> newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) throws IOException

パラメータ説明

1. 基本パラメータ

  • dir(Path 型):開くディレクトリのパス
  • 戻り値:DirectoryStream<Path>ディレクトリ内のすべてのエントリを表す反復ストリーム

2. フィルター付きパラメータ

  • glob(String 型):ファイル名のマッチングに使用される glob パターン
  • filter(DirectoryStream.Filter<? super Path> 型):カスタムフィルターインターフェース

使用例

1. 基本的な使い方:ディレクトリの走査

サンプル

import java.io.IOException;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;

public class DirectoryStreamExample {
    public static void main(String[] args) {
        Path dir = Paths.get("C:/example");
       
        try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir)) {
            for (Path file : stream) {
                System.out.println(file.getFileName());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

2. Glob パターンを使用したフィルタリング

サンプル

// .txt ファイルのみを一覧表示する
try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir, "*.txt")) {
    for (Path file : stream) {
        System.out.println(file.getFileName());
    }
}

3. カスタムフィルターの使用

サンプル

// ディレクトリのみを一覧表示する
DirectoryStream.Filter<Path> filter = new DirectoryStream.Filter<Path>() {
    @Override
    public boolean accept(Path entry) throws IOException {
        return Files.isDirectory(entry);
    }
};

try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir, filter)) {
    for (Path file : stream) {
        System.out.println(file.getFileName());
    }
}

メソッドの特徴

1. 効率性

  • NIO のチャネル特性を使用し、従来のFile.listFiles()ものよりも効率的です
  • 多数のファイルを含むディレクトリの処理に特に適しています

2. リソース管理

  • 返されたDirectoryStream実装しておりAutoCloseableインターフェース
  • try-with-resources 文を使用してリソースが確実に解放されるようにすることを推奨します

3. スレッド安全性

  • スレッドセーフではないため、複数のスレッド間で共有できません
  • 並行処理が必要な場合は、スレッドごとに独立したストリームを作成する必要があります

注意事項

  1. IO 例外処理:処理するか、宣言してスローする必要がありますIOException
  2. リソース解放:リソースリークを防ぐためにストリームを閉じる必要があります
  3. パフォーマンスの考慮:非常に大きなディレクトリの場合、バッチ処理を検討する必要があるかもしれません
  4. シンボリックリンク:特別に設定しない限り、デフォルトでシンボリックリンクを辿ります

代替手段の比較

メソッド 利点 欠点
Files.newDirectoryStream() 効率的で、フィルタリングをサポート スレッドセーフではない
Files.list() (Java 8+) Stream を返し、並列処理をサポート Java 8+ が必要
File.listFiles() シンプルで使いやすい パフォーマンスが低い

ベストプラクティス

  1. 常に try-with-resources 文を使用する
  2. 複雑なフィルタリングロジックには、カスタムフィルターを使用する
  3. 大きなディレクトリを処理する場合はバッチ処理を検討する
  4. Java 8+ 環境では、Files.list()より良い選択かもしれません

よくある質問と回答

Q1: 隠しファイルはどう扱いますか?

カスタムフィルターを使用できます:

サンプル

DirectoryStream.Filter<Path> filter = entry -> !entry.getFileName().toString().startsWith(".");

Q2: サブディレクトリを再帰的に走査するには?

newDirectoryStream()自体は再帰的ではなく、Files.walkFileTree()を組み合わせて再帰的走査を実現できます。

Q3: パフォーマンス最適化のアドバイスは?

  • フィルター内でコストのかかる操作を避ける
  • 読み取り専用の操作には、Files.list()と並列ストリームの使用を検討してください。

この記事の詳しい解説を通じて、あなたはすでにFiles.newDirectoryStream()メソッドの中心的な使い方とベストプラクティスを習得できたはずです。このメソッドは Java のファイル操作において非常に実用的なツールであり、適切に使用することでディレクトリ走査の効率を大幅に向上させることができます。

Java java.nio.file.Files

その他の関連