Go fs.FormatDirEntry 怎样把目录项格式化为可读文本-Golang学习网

在 Go 的文件系统抽象里，fs.DirEntry 是“目录里读到的一项”，而 fs.FormatDirEntry 负责把这一项转成适合人阅读的短文本。它适合目录清单、调试日志和命令行预览：目录通常带有 d 前缀和结尾斜杠，普通文件以 - 开头，名称仍然保留。

官方地址：https://pkg.go.dev/io/fs#FormatDirEntry

最实用的判断是：已经拿到 fs.DirEntry，想快速显示“类型 + 名称”，就调用 fs.FormatDirEntry(entry)；如果还需要权限、大小、修改时间等完整元数据，则应调用 entry.Info()，再考虑 fs.FormatFileInfo。

先确认 fs.FormatDirEntry 的职责

fs.FormatDirEntry 的参数不是路径，也不是 fs.FileInfo，而是一个目录项接口。目录项本身提供 Name、IsDir、Type 和 Info 等能力。格式化函数只做面向人的短格式化，不负责打开文件、遍历目录或读取文件内容。

fs.ReadDir 和 fs.WalkDir 产生 fs.DirEntry 后交给 fs.FormatDirEntry 的输入关系说明图 — 图1：DirEntry 输入关系说明图，展示格式化函数读取的对象边界，不是运行截图。

这个职责划分很重要。fs.ReadDir 可以直接返回一组目录项，fs.WalkDir 则在遍历回调中逐项交给你。两种入口最终都能复用同一个格式化动作，展示层不必重复判断目录或文件。

从内存文件系统读取目录项

下面用 testing/fstest.MapFS 构造一个不依赖本机目录的示例。它只演示 API 的数据关系：先读取目录项，再将每一项交给格式化函数。

package main

import (
    "fmt"
    "io/fs"
    "log"
    "testing/fstest"
)

func main() {
    fileSystem := fstest.MapFS{
        "config/app.yaml": {Data: []byte("port: 8080\n")},
        "main.go":         {Data: []byte("package main\n")},
    }

    entries, err := fs.ReadDir(fileSystem, ".")
    if err != nil {
        // 读取目录失败时立即返回，避免把空结果误认为目录为空。
        log.Fatal(err)
    }

    for _, entry := range entries {
        // 这里先保留 DirEntry，格式化动作放到展示边界。
        fmt.Println(fs.FormatDirEntry(entry))
    }
}

示例的关键点不是 MapFS，而是 entries 的元素类型。fs.ReadDir 返回的是 []fs.DirEntry，因此可以把格式化函数作为统一的展示策略。实际项目换成 os.DirFS、嵌入文件系统或自定义 fs.FS 时，调用方式不变。

调用 fs.FormatDirEntry 得到短文本

官方文档给出的典型结果是目录 d subdir/ 和普通文件 - hello.go。这里的前缀与目录名、文件名组合成了一个方便扫读的结果，但它不是完整的 Unix ls -l 输出。

func printEntry(entry fs.DirEntry) {
    // FormatDirEntry 适合人读的短文本，不等于完整文件元数据。
    text := fs.FormatDirEntry(entry)
    fmt.Printf("entry: %s\n", text)
}

如果目录项名称是 config，结果通常会表现为目录标记和名称的组合；普通文件则使用普通文件标记。格式化结果应当用于日志或清单展示，不要再把它解析回结构化字段。需要机器处理时，继续使用 entry.Name()、entry.IsDir() 和 entry.Type()。

fs.FormatDirEntry 将目录和普通文件转换为 d config/ 与 - main.go 等短文本的输出关系说明图 — 图2：FormatDirEntry 输出关系说明图，展示短文本中的类型前缀与名称，不是运行截图。

在 WalkDir 回调中统一输出

目录清单更常见的场景是递归遍历。fs.WalkDir 的回调同时拿到路径、目录项和错误，可以把错误处理与展示动作分开：错误先判断，正常项再格式化。

func walkAndPrint(fileSystem fs.FS) error {
    return fs.WalkDir(fileSystem, ".", func(path string, entry fs.DirEntry, walkErr error) error {
        if walkErr != nil {
            // 当前路径不可读时返回错误，让调用方决定是否终止遍历。
            return walkErr
        }
        // path 是遍历路径，FormatDirEntry 是当前项的短展示文本。
        fmt.Printf("%s: %s\n", path, fs.FormatDirEntry(entry))
        return nil
    })
}

这里不要把 path 和格式化结果混为一谈：path 说明项在文件系统中的位置，FormatDirEntry 说明项本身是目录还是文件以及它的名称。两者合起来才是一条适合日志阅读的记录。

FormatDirEntry 和 FormatFileInfo 怎么选

二者都返回字符串，但输入对象和信息密度不同。可以用下面的表格快速选择：

需求	使用方式	结果特点
展示目录项类型和名称	`fs.FormatDirEntry(entry)`	短、直观，适合清单和日志
展示权限、大小、时间和名称	`entry.Info()` 后调用 `fs.FormatFileInfo(info)`	信息更完整，可能触发额外信息读取
执行业务判断	`Name`、`IsDir`、`Type` 等接口方法	保留结构化数据，不依赖字符串格式