Lister les fichiers dans un dossier avec Go

Dans cet article, j'explique comment obtenir une liste de fichiers dans un dossier du système de fichiers, une tâche également appeléearbre traversant, avec Go.

Il existe deux fonctions stdlib pratiques que vous pouvez utiliser en fonction de votre objectif.

Je liste 3 façons: en utilisantfilepath.Walk,ioutil.ReadDirouos.File.Readdir.

Utilisant`filepath.Walk`

Lepath/filepathLe paquet stdlib fournit la fonction pratique Walk. Cependant, il scanne automatiquement les sous-répertoires, alors assurez-vous que c'est ce que vous voulez réellement.

L'utilisation est très simple:

package main
import (
“fmt”
“os”
“path/filepath”
)
func main() {
var files []string
<span style="color:#a6e22e">root</span> <span style="color:#f92672">:=</span> <span style="color:#e6db74">"/some/folder/to/scan"</span>
<span style="color:#a6e22e">err</span> <span style="color:#f92672">:=</span> <span style="color:#a6e22e">filepath</span>.<span style="color:#a6e22e">Walk</span>(<span style="color:#a6e22e">root</span>, <span style="color:#66d9ef">func</span>(<span style="color:#a6e22e">path</span> <span style="color:#66d9ef">string</span>, <span style="color:#a6e22e">info</span> <span style="color:#a6e22e">os</span>.<span style="color:#a6e22e">FileInfo</span>, <span style="color:#a6e22e">err</span> <span style="color:#66d9ef">error</span>) <span style="color:#66d9ef">error</span> {
    <span style="color:#a6e22e">files</span> = append(<span style="color:#a6e22e">files</span>, <span style="color:#a6e22e">path</span>)
    <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">nil</span>
})
<span style="color:#66d9ef">if</span> <span style="color:#a6e22e">err</span> <span style="color:#f92672">!=</span> <span style="color:#66d9ef">nil</span> {
    panic(<span style="color:#a6e22e">err</span>)
}
<span style="color:#66d9ef">for</span> <span style="color:#a6e22e">_</span>, <span style="color:#a6e22e">file</span> <span style="color:#f92672">:=</span> <span style="color:#66d9ef">range</span> <span style="color:#a6e22e">files</span> {
    <span style="color:#a6e22e">fmt</span>.<span style="color:#a6e22e">Println</span>(<span style="color:#a6e22e">file</span>)
}
}

filepath.Walkaccepte une chaîne pointant vers le dossier racine, et unWalkFunc, un type de fonction avec signature

type WalkFunc func(path string, info os.FileInfo, err error) error

Cette fonction est appelée à chaque itération de l'analyse des dossiers.

Leinfovariable de typeos.FileInfoest important car nous pouvons obtenir de nombreuses informations sur le fichier courant: le nom, la taille, le mode, l'heure de modification, s'il s'agit d'un dossier ou d'un fichier, et la source de données sous-jacente.

Par exemple, nous pourrions éviter de traiter des dossiers en ajoutant

if info.IsDir() {
    return nil
}

Vous pouvez exclure (ou inclure) des fichiers dans la tranche en fonction de leur extension, en utilisantfilepath.Extet en passant le chemin du fichier:

if filepath.Ext(path) == ".dat" {
    return nil
}

Nous pourrions stocker le nom du fichier au lieu du chemin du fichier en utilisant

files = append(files, info.Name())

Et nous pourrions également définir leWalkFuncdans un autrefermeture. Nous avons juste besoin de passer un pointeur versfilesdansvisit:

package main
import (
“fmt”
“log”
“os”
“path/filepath”
)
func visit(files []string) filepath.WalkFunc {
return func(path string, info os.FileInfo, err error) error {
if err != nil {
log.Fatal(err)
}
files = append(*files, path)
return nil
}
}
func main() {
var files []string
<span style="color:#a6e22e">root</span> <span style="color:#f92672">:=</span> <span style="color:#e6db74">"/some/folder/to/scan"</span>
<span style="color:#a6e22e">err</span> <span style="color:#f92672">:=</span> <span style="color:#a6e22e">filepath</span>.<span style="color:#a6e22e">Walk</span>(<span style="color:#a6e22e">root</span>, <span style="color:#a6e22e">visit</span>(<span style="color:#f92672">&amp;</span><span style="color:#a6e22e">files</span>))
<span style="color:#66d9ef">if</span> <span style="color:#a6e22e">err</span> <span style="color:#f92672">!=</span> <span style="color:#66d9ef">nil</span> {
    panic(<span style="color:#a6e22e">err</span>)
}
<span style="color:#66d9ef">for</span> <span style="color:#a6e22e">_</span>, <span style="color:#a6e22e">file</span> <span style="color:#f92672">:=</span> <span style="color:#66d9ef">range</span> <span style="color:#a6e22e">files</span> {
    <span style="color:#a6e22e">fmt</span>.<span style="color:#a6e22e">Println</span>(<span style="color:#a6e22e">file</span>)
}
}

Utilisant`ioutil.ReadDir`

filepath.Walkest pratique mais analyse également les sous-dossiers, par défaut, ce qui n'est peut-être pas ce que vous souhaitez.

Le Go stdlib fournit égalementioutil.ReadDir

func ReadDir(dirname string) ([]os.FileInfo, error)

ReadDir lit le répertoire nommé par dirname et renvoie une liste d'entrées de répertoire triées par nom de fichier.

et voici un exemple tiré de la documentation.ioutil.ReadDirprend un chemin de dossier sous forme de chaîne et renvoie une tranche deos.FileInfo, que nous avons décrit ci-dessus.

package main
import (
“fmt”
“io/ioutil”
“log”
)
func main() {
files, err := ioutil.ReadDir(".")
if err != nil {
log.Fatal(err)
}
<span style="color:#66d9ef">for</span> <span style="color:#a6e22e">_</span>, <span style="color:#a6e22e">file</span> <span style="color:#f92672">:=</span> <span style="color:#66d9ef">range</span> <span style="color:#a6e22e">files</span> {
    <span style="color:#a6e22e">fmt</span>.<span style="color:#a6e22e">Println</span>(<span style="color:#a6e22e">file</span>.<span style="color:#a6e22e">Name</span>())
}
}

Utilisant`os.File.Readdir`

Intérieurement,ioutil.ReadDirest implémenté comme

// ReadDir reads the directory named by dirname and returns
// a list of directory entries sorted by filename.
func ReadDir(dirname string) ([]os.FileInfo, error) {
    f, err := os.Open(dirname)
    if err != nil {
        return nil, err
    }
    list, err := f.Readdir(-1)
    f.Close()
    if err != nil {
        return nil, err
    }
    sort.Slice(list, func(i, j int) bool { return list[i].Name() < list[j].Name() })
    return list, nil
}

comme vous pouvez le voir scannedirnameet trie les fichiers par nom. Si vous n'avez pas besoin de trier, vous pouvez également utiliser

package main
import (
“fmt”
“log”
“os”
)
func main() {
dirname := “.”
<span style="color:#a6e22e">f</span>, <span style="color:#a6e22e">err</span> <span style="color:#f92672">:=</span> <span style="color:#a6e22e">os</span>.<span style="color:#a6e22e">Open</span>(<span style="color:#a6e22e">dirname</span>)
<span style="color:#66d9ef">if</span> <span style="color:#a6e22e">err</span> <span style="color:#f92672">!=</span> <span style="color:#66d9ef">nil</span> {
    <span style="color:#a6e22e">log</span>.<span style="color:#a6e22e">Fatal</span>(<span style="color:#a6e22e">err</span>)
}
<span style="color:#a6e22e">files</span>, <span style="color:#a6e22e">err</span> <span style="color:#f92672">:=</span> <span style="color:#a6e22e">f</span>.<span style="color:#a6e22e">Readdir</span>(<span style="color:#f92672">-</span><span style="color:#ae81ff">1</span>)
<span style="color:#a6e22e">f</span>.<span style="color:#a6e22e">Close</span>()
<span style="color:#66d9ef">if</span> <span style="color:#a6e22e">err</span> <span style="color:#f92672">!=</span> <span style="color:#66d9ef">nil</span> {
    <span style="color:#a6e22e">log</span>.<span style="color:#a6e22e">Fatal</span>(<span style="color:#a6e22e">err</span>)
}

<span style="color:#66d9ef">for</span> <span style="color:#a6e22e">_</span>, <span style="color:#a6e22e">file</span> <span style="color:#f92672">:=</span> <span style="color:#66d9ef">range</span> <span style="color:#a6e22e">files</span> {
    <span style="color:#a6e22e">fmt</span>.<span style="color:#a6e22e">Println</span>(<span style="color:#a6e22e">file</span>.<span style="color:#a6e22e">Name</span>())
}
}

Lister les fichiers dans un dossier avec Go

Utilisantfilepath.Walk

Utilisantioutil.ReadDir

Utilisantos.File.Readdir

Plus de tutoriels go:

Utilisant`filepath.Walk`

Utilisant`ioutil.ReadDir`

Utilisant`os.File.Readdir`