Перечислить файлы в папке с помощью Go

В этой статье я объясню, как получить список файлов внутри папки в файловой системе. Эта задача также называетсяобход дерева, с Go.

Есть две удобные функции stdlib, которые вы можете использовать в зависимости от вашей цели.

Я перечисляю 3 способа: использованиеfilepath.Walk,ioutil.ReadDirили жеos.File.Readdir.

С помощьюfilepath.Walk

Вpath/filepathПакет stdlib предоставляет удобную функцию Walk. Однако он автоматически сканирует подкаталоги, поэтому убедитесь, что это именно то, что вам нужно.

Использование очень простое:

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.Walkпринимает строку, указывающую на корневую папку, иWalkFunc, тип функции с сигнатурой

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

Эта функция вызывается для каждой итерации сканирования папки.

Вinfoпеременная типаos.FileInfoважно, потому что мы можем получить много информации о текущем файле: имя, размер, режим, время модификации, если это папка или файл, и базовый источник данных.

Например, мы могли бы избежать обработки папок, добавив

if info.IsDir() {
    return nil
}

Вы можете исключить (или включить) файлы в фрагмент на основе их расширения, используяfilepath.Extи передав путь к файлу:

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

Мы могли бы сохранить имя файла вместо пути к файлу, используя

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

И мы могли бы также определитьWalkFuncв отдельномзакрытие. Нам просто нужно передать указатель наfilesвvisit:

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>)
}

}

С помощьюioutil.ReadDir

filepath.Walkэто удобно, но по умолчанию сканирует и вложенные папки, что может быть не тем, что вам нужно.

Go stdlib также предоставляетioutil.ReadDir

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

ReadDir читает каталог с именем dirname и возвращает список записей каталога, отсортированных по имени файла.

а вот пример из документации.ioutil.ReadDirпринимает путь к папке в виде строки и возвращает фрагментos.FileInfo, который мы описали выше.

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>())
}

}

С помощьюos.File.Readdir

Внутриioutil.ReadDirреализован как

// 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
}

как вы можете видеть это сканированиеdirnameи сортирует файлы по имени. Если вам не нужна сортировка, вы также можете использовать

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>())
}

}


Больше руководств по go:


Tech Wiki Online!