登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go embed.FS.ReadDir 怎样列出嵌入目录中的文件和子目录

来源:17golang原创

时间:2026-11-18 22:01:13 148浏览 收藏

对嵌入文件系统调用 resources.ReadDir("assets"),就能取得 assets 目录直接包含的文件与子目录条目。返回值是目录条目切片和错误;遍历条目时用 Name 取末级名称,用 IsDir 区分目录。一次调用只列一层,不会自动展开子目录。

这适合为内置模板、帮助材料或资源选择器准备列表数据。列表中的目录要单独标出,让调用方明确知道它可以继续进入,而不是把所有条目当作文件。

先确定嵌入目录与读取路径

下面示例约定源文件同级有 assets 目录,其中放置 readme.txt,以及 icons 子目录中的 mark.txt。两个文本文件可填任意简短内容。目录嵌入指令会将符合规则的目录树在编译时纳入程序;读取时仍保留 assets 这层路径。

传入路径含义
assets读取资源目录的直接条目
assets/icons读取图标子目录的直接条目
.读取这个嵌入文件系统的根
/assets、assets/不符合此类文件系统路径形式,应去掉多余斜线

这些路径属于程序内的文件系统,不依赖启动时的工作目录。统一使用正斜线分隔路径;不要把电脑上的绝对目录或反斜线目录字符串直接搬进来。嵌入指令的匹配规则和运行时根目录的点号表示法也要分开理解。

嵌入资源目录与直接条目之间的静态层级结构图
原创结构图:assets目录包含readme.txt和icons子目录,mark.txt属于更深一层;单层列举不会自动展开后者。

把目录条目整理成可展示的数据

下面是本次原创的完整示例。先准备上面约定的两个资源文件,再放置Go源文件;示例只生成名称、路径和种类数据,不读取资源内容。这里按代码语义解释,未作为本机运行记录。

package main

import (
    "embed"
    "fmt"
    "os"
    "path"
)

// 构建前准备assets/readme.txt与assets/icons/mark.txt,内容任意且非空。
//go:embed assets
var resources embed.FS

type Entry struct {
    Name  string
    Path  string
    IsDir bool
}

func listEntries(dir string) ([]Entry, error) {
    entries, err := resources.ReadDir(dir)
    if err != nil {
        return nil, fmt.Errorf("列出嵌入目录 %q: %w", dir, err)
    }
    rows := make([]Entry, 0, len(entries))
    for _, entry := range entries {
        // Name只有末级名称,完整资源路径使用path.Join拼接。
        rows = append(rows, Entry{
            Name: entry.Name(), Path: path.Join(dir, entry.Name()),
            IsDir: entry.IsDir(),
        })
    }
    return rows, nil
}

func main() {
    rows, err := listEntries("assets")
    if err != nil {
        fmt.Fprintln(os.Stderr, err)
        os.Exit(1)
    }
    for _, row := range rows {
        // 显式输出种类,调用方无需靠文件扩展名判断目录。
        kind := "文件"
        if row.IsDir { kind = "目录" }
        fmt.Printf("%s %s\n", kind, row.Path)
    }
}

按给定资源布局,assets这一层包含icons与readme.txt;mark.txt需要另外读取assets/icons才会出现。ReadDir返回按名称排序的条目,业务若需要“目录在前”之类显示顺序,应在独立的展示数据上安排规则,而不要假定默认就按种类分组。

Name与IsDir分别回答什么

返回的每个元素实现 fs.DirEntry。Name只给路径最后一段;如图标子目录的名称是icons,而不是assets/icons。示例通过path.Join把当前目录与末级名称连接,保留下一次定位目录所需的完整资源路径。

IsDir直接判断条目是否为目录;Type给出类型位,不能当作完整权限信息。只有需要更完整元数据时再调用Info,并按它的接口约定处理返回错误。仅展示名称和目录标记的列表不必为每项再取完整信息。

DirEntry成员与列表展示字段之间的静态对应结构图
原创结构图:条目名称、种类和拼接后的资源路径分别服务于列表展示与后续定位,不是文件内容读取流程。

目录不存在时保留错误信息

先判断ReadDir的错误,再使用结果构建列表。示例把请求目录写入错误上下文,并用百分号w保留原始错误链;调用方可以据此继续判断错误类型,界面层则显示简洁的失败提示。

找不到预期子目录时,应区分传入路径不对、资源没有被编译进来、以及请求对象其实是文件。资源目录嵌入通常跳过名称以点或下划线开头的文件,空目录也不会作为可用资源单独保存。运行时修改磁盘上的源资源不会改变已经编译好的嵌入数据,需要重新构建程序才能纳入变更。

常见问题

为什么读根目录只看到assets?

因为目录前缀仍在资源路径中。根目录的一层条目是assets,读取它才得到里面的直接条目。

列完目录要关闭句柄吗?

本例直接使用ReadDir取得条目切片,没有向调用方交付需要关闭的文件句柄。不要给这个切片套用文件关闭逻辑。

程序部署后能把新文件补进列表吗?

不能靠往运行目录复制文件改变embed.FS。需要动态资源时,应另外设计运行时数据来源,不能把嵌入目录当作可写目录。

接口说明参见 Go embed.FS.ReadDir 文档;条目名称、类型与元数据语义参见 io/fs.DirEntry 文档。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>