在Go中列出目录

我一直在尝试如何在Go中简单地列出单个目录中的文件和文件夹。

我找到文件路径了。Walk，但它会自动进入子目录，这是我不想要的。我其他的搜索都没有更好的结果。

我相信这个功能是存在的，但它真的很难找到。如果有人知道我该去哪里找，请告诉我。谢谢。

当前回答

我们可以使用各种golang标准库函数获得文件系统上某个文件夹中的文件列表。

filepath。走 ioutil。ReadDir os.File.Readdir


package main

import (
    "fmt"
    "io/ioutil"
    "log"
    "os"
    "path/filepath"
)

func main() {
    var (
        root  string
        files []string
        err   error
    )

    root := "/home/manigandan/golang/samples"
    // filepath.Walk
    files, err = FilePathWalkDir(root)
    if err != nil {
        panic(err)
    }
    // ioutil.ReadDir
    files, err = IOReadDir(root)
    if err != nil {
        panic(err)
    }
    //os.File.Readdir
    files, err = OSReadDir(root)
    if err != nil {
        panic(err)
    }

    for _, file := range files {
        fmt.Println(file)
    }
}

使用filepath。走

path/filepath包提供了一种方便的方式来扫描所有文件在一个目录中，它会自动扫描每个子目录中的目录中。

func FilePathWalkDir(root string) ([]string, error) {
    var files []string
    err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
        if !info.IsDir() {
            files = append(files, path)
        }
        return nil
    })
    return files, err
}

使用ioutil。ReadDir

ioutil。ReadDir读取以dirname命名的目录，并返回按文件名排序的目录条目列表。

func IOReadDir(root string) ([]string, error) {
    var files []string
    fileInfo, err := ioutil.ReadDir(root)
    if err != nil {
        return files, err
    }

    for _, file := range fileInfo {
        files = append(files, file.Name())
    }
    return files, nil
}

使用os.File.Readdir

Readdir读取与文件和关联的目录的内容返回最多n个FileInfo值的切片，就像返回 Lstat，按目录顺序。对同一文件的后续调用将会 yield进一步的fileinfo。

func OSReadDir(root string) ([]string, error) {
    var files []string
    f, err := os.Open(root)
    if err != nil {
        return files, err
    }
    fileInfo, err := f.Readdir(-1)
    f.Close()
    if err != nil {
        return files, err
    }

    for _, file := range fileInfo {
        files = append(files, file.Name())
    }
    return files, nil
}

基准测试结果。

在这篇博客文章中获得更多细节

2018-03-09 15:07:26

其他回答

ioutil。ReadDir是一个很好的发现，但是如果你点击并查看源代码，你会看到它调用os.File的ReadDir方法。如果您对目录顺序没有问题，并且不需要对列表排序，那么这个Readdir方法就是您所需要的全部。

2013-02-03 11:58:22

更简单的是，使用path/filepath:

package main    

import (
    "fmt"
    "log"
    "path/filepath"
)

func main() {
    files, err := filepath.Glob("*")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(files) // contains a list of all files in the current directory
}

2013-08-20 07:04:23

从Go 1.16开始，你可以使用操作系统。ReadDir函数。

func ReadDir(名称字符串)([]退行，错误)

它读取一个给定的目录并返回一个包含按文件名排序的目录条目的DirEntry片。

它是一个乐观函数，因此，当读取目录条目时发生错误时，它会尝试返回一个切片，其中包含错误发生前的文件名。

package main

import (
    "fmt"
    "log"
    "os"
)

func main() {
    files, err := os.ReadDir(".")
    if err != nil {
        log.Fatal(err)
    }

    for _, file := range files {
        fmt.Println(file.Name())
    }
}

有趣的是:Go 1.17(2021年Q3)包括fs.FileInfoToDirEntry():

func FileInfoToDirEntry(info FileInfo) DirEntry FileInfoToDirEntry返回一个从info返回信息的DirEntry。如果info为nil, FileInfoToDirEntry返回nil。

背景

Go 1.16 (Q1 2021)将提出基于FS接口的ReadDir函数，使用CL 243908和CL 243914:

// An FS provides access to a hierarchical file system.
//
// The FS interface is the minimum implementation required of the file system.
// A file system may implement additional interfaces,
// such as fsutil.ReadFileFS, to provide additional or optimized functionality.
// See io/fsutil for details.
type FS interface {
    // Open opens the named file.
    //
    // When Open returns an error, it should be of type *PathError
    // with the Op field set to "open", the Path field set to name,
    // and the Err field describing the problem.
    //
    // Open should reject attempts to open names that do not satisfy
    // ValidPath(name), returning a *PathError with Err set to
    // ErrInvalid or ErrNotExist.
    Open(name string) (File, error)
}

允许“os: add ReadDir方法用于轻量级目录读取”: 参见commit a4ede9f:

// ReadDir reads the contents of the directory associated with the file f
// and returns a slice of DirEntry values in directory order.
// Subsequent calls on the same file will yield later DirEntry records in the directory.
//
// If n > 0, ReadDir returns at most n DirEntry records.
// In this case, if ReadDir returns an empty slice, it will return an error explaining why.
// At the end of a directory, the error is io.EOF.
//
// If n <= 0, ReadDir returns all the DirEntry records remaining in the directory.
// When it succeeds, it returns a nil error (not io.EOF).
func (f *File) ReadDir(n int) ([]DirEntry, error) 

// A DirEntry is an entry read from a directory (using the ReadDir method).
type DirEntry interface {
    // Name returns the name of the file (or subdirectory) described by the entry.
    // This name is only the final element of the path, not the entire path.
    // For example, Name would return "hello.go" not "/home/gopher/hello.go".
    Name() string
    
    // IsDir reports whether the entry describes a subdirectory.
    IsDir() bool
    
    // Type returns the type bits for the entry.
    // The type bits are a subset of the usual FileMode bits, those returned by the FileMode.Type method.
    Type() os.FileMode
    
    // Info returns the FileInfo for the file or subdirectory described by the entry.
    // The returned FileInfo may be from the time of the original directory read
    // or from the time of the call to Info. If the file has been removed or renamed
    // since the directory read, Info may return an error satisfying errors.Is(err, ErrNotExist).
    // If the entry denotes a symbolic link, Info reports the information about the link itself,
    // not the link's target.
    Info() (FileInfo, error)
}

src/os/os_test.go#testReadDir()说明了它的用法:

    file, err := Open(dir)
    if err != nil {
        t.Fatalf("open %q failed: %v", dir, err)
    }
    defer file.Close()
    s, err2 := file.ReadDir(-1)
    if err2 != nil {
        t.Fatalf("ReadDir %q failed: %v", dir, err2)
    }

Ben Hoyt在评论中指出Go 1.16 os。ReadDir:

操作系统。ReadDir(路径字符串)([]os. conf)DirEntry, error)，您可以直接调用它，而不需要Open舞蹈。所以你可以把这个缩短为os。ReadDir，因为这是大多数人会调用的具体函数。

参见commit 3d913a9 (december 2020):

os:添加ReadFile, WriteFile, CreateTemp(是TempFile)， MkdirTemp(是TempDir)从io/ioutil Io /ioutil是一个定义不佳的帮助程序集合。提案#40025将通用I/O帮助器移到io。提案#42026的CL将特定于os的helper移动到os，弃用整个io/ioutil包。

操作系统。ReadDir返回[]DirEntry，与ioutil相反。ReadDir () FileInfo。 (提供一个返回[]DirEntry的helper是这个更改的主要动机之一。)

2020-10-20 11:07:03

您可以尝试使用操作系统包中的ReadDir功能。根据文档:

ReadDir读取已命名的目录，返回按文件名排序的所有目录条目。

生成的切片包含os。DirEntry类型，它们提供了这里列出的方法。下面是一个基本的例子，列出了当前目录中所有东西的名称(包含文件夹，但没有特别标记-你可以使用IsDir()方法检查一个项目是否为文件夹):

package main

import (
    "fmt"
    "os"
     "log"
)

func main() {
    entries, err := os.ReadDir("./")
    if err != nil {
        log.Fatal(err)
    }
 
    for _, e := range entries {
            fmt.Println(e.Name())
    }
}

2013-02-03 02:29:44