Java java.nio.file.Files list() Methode

Java File Java java.nio.file.Files


java.nio.file.Files.list()ist eine Hilfsmethode, die im Java NIO (New I/O)-Paket bereitgestellt wird, um den Inhalt eines Verzeichnisses aufzulisten. Diese Methode gibt einStream<Path>Objekt, das alle Einträge (Dateien und Unterverzeichnisse) im angegebenen Verzeichnis enthält.

Methodendefinition

public static Stream<Path> list(Path dir) throws IOException

Methodenparameter

dir-Parameter

  • Type:java.nio.file.Path
  • Beschreibung: Der Verzeichnispfad, dessen Inhalte aufgelistet werden sollen
  • Hinweise:
    • Wenn der Parameter kein Verzeichnis ist, wird eine Ausnahme geworfenNotDirectoryException
    • Der Pfad muss existieren, andernfalls wird eine Ausnahme ausgelöstNoSuchFileException
    • Wenn das Programm keine Leseberechtigung für das Verzeichnis hat, wird eine Ausnahme ausgelöstAccessDeniedException

Rückgabewert

Stream

  • Beschreibung: Ein Stream, der alle Einträge (Dateien und Unterverzeichnisse) im Verzeichnis enthält
  • Funktionen:
    • Die Elemente im Stream sindPathObjekte.
    • Der Stream ist nach der natürlichen Reihenfolge der Einträge im Verzeichnis geordnet (normalerweise nach Name sortiert)
    • Der Stream wird verzögert geladen; er liest den Verzeichnisinhalt tatsächlich erst, wenn er durchlaufen wird
    • Der Stream muss ordnungsgemäß geschlossen werden, um Systemressourcen freizugeben

Methodenmerkmale

1. Nicht rekursiv

list()Die Methode listet nur Einträge direkt im angegebenen Verzeichnis auf; sie listet den Inhalt von Unterverzeichnissen nicht rekursiv auf.

2. Schließt spezielle Einträge aus

Der zurückgegebene Stream enthält nicht die Einträge für das Verzeichnis selbst (".") und das übergeordnete Verzeichnis ("..").

3. Ressourcenverwaltung

Da ein Stream zurückgegeben wird, empfiehlt es sich, eine try-with-resources-Anweisung zu verwenden, um sicherzustellen, dass der Stream ordnungsgemäß geschlossen wird:

Beispiel

try (Stream<Path> stream = Files.list(Paths.get("/path/to/dir"))) {
    stream.forEach(System.out::println);
}

Anwendungsbeispiele

Grundlegende Verwendung: Verzeichnisinhalte auflisten

Beispiel

import java.io.IOException;
import java.nio.file.Files;
import java.nio.Path;
import java.nio.file.Paths;
import java.util.stream.Stream;

public class ListDirectoryExample {
    public static void main(String[] args) {
        Path dir = Paths.get("C:/example");
       
        try (Stream<Path> stream = Files.list(dir)) {
            stream.forEach(System.out::println);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Erweiterte Verwendung: Filtern bestimmter Dateien

Beispiel

try (Stream<Path> stream = Files.list(Paths.get("/projects"))) {
    stream.filter(path -> path.toString().endsWith(".java"))
          .forEach(System.out::println);
} catch (IOException e) {
    e.printStackTrace();
}

Konvertierung in andere Collections

Beispiel

try (Stream<Path> stream = Files.list(Paths.get("/images"))) {
    List<Path> imageFiles = stream.collect(Collectors.toList());
    // Verarbeite die gesammelte Dateiliste
} catch (IOException e) {
    e.printStackTrace();
}

Ausnahmebehandlung

Files.list()Die Methode kann die folgenden Ausnahmen auslösen:

  1. NotDirectoryException- Wenn der Pfad kein Verzeichnis ist
  2. NoSuchFileException- Wenn das Verzeichnis nicht existiert
  3. SecurityException- Wenn keine Berechtigung zum Lesen des Verzeichnisses besteht
  4. IOException- Wenn andere I/O-Fehler auftreten

Leistungsüberlegungen

  1. Verzögertes Laden: Der Stream wird verzögert geladen; das Verzeichnis wird erst dann tatsächlich gelesen, wenn eine Terminaloperation (wie forEach) ausgeführt wird
  2. Ressourcenverbrauch: Bei Verzeichnissen mit einer großen Anzahl von Dateien kann die Verwendung eines Streams vermeiden, dass alle Einträge auf einmal in den Speicher geladen werden
  3. Parallele Verarbeitung: Sie können dieparallel()Methode aufrufen, um parallele Verarbeitung zu implementieren, aber beachten Sie Thread-Sicherheitsprobleme

Vergleich mit ähnlichen Methoden

Methode Rückgabetyp Rekursivität Enthält spezielle Einträge Hinweise
Files.list() Stream<Path> nein nein Empfohlen, ressourcenschonend
File.listFiles() File[] nein nein Traditionelle IO-Methode
Files.walk() Stream<Path> Ja Ja Listet alle Inhalte rekursiv auf
Files.newDirectoryStream() DirectoryStream<Path> nein nein Muss manuell geschlossen werden

Best Practices

  1. Verwende immer try-with-resources: Stelle sicher, dass der Stream ordnungsgemäß geschlossen wird
  2. Behandle Ausnahmen: Behandle mögliche IOException ordnungsgemäß
  3. Erwäge die Verwendung von Filtern: Filtere unerwünschte Einträge so früh wie möglich in den Stream-Operationen heraus
  4. Vermeide das Ändern des Verzeichnisses: Ändere seine Inhalte nicht, während du das Verzeichnis durchläufst
  5. Achte auf symbolische Links: Standardmäßig werden symbolische Links verfolgt, was zu Zirkelverweisen führen kann

Zusammenfassung

Files.list()Die Methode ist eine moderne Möglichkeit, Verzeichnisinhalte in Java NIO zu verarbeiten, und bietet alle Vorteile der Stream-API, einschließlich verzögerter Ausführung, verketteter Operationen und paralleler Verarbeitungsmöglichkeiten. Für einfache Anforderungen an die Verzeichnisauflistung ist sie flexibler und effizienter als traditionelleFile.listFiles()Methoden.

Java File Java java.nio.file.Files

Andere Erweiterungen