当前位置:首页 > 文章列表 > Golang > Go教程 > Go embed.FS 如何读取嵌入文件的相对路径

Go embed.FS 如何读取嵌入文件的相对路径

来源:17golang原创 2026-09-12 10:23:10 0浏览 收藏

embed.FS 读取文件时,最容易写错的不是 API,而是文件名。//go:embed 的模式以当前 Go 源文件所在的包目录为基准;嵌入后的文件系统名称使用正斜杠,并且保留匹配到的目录层级。比如嵌入 web/templates/index.html,读取时就写 "web/templates/index.html"。如果希望从 web 下面开始读,再用 fs.Sub 把这个公共前缀变成新的根。

要点速览
  • embed.FS 的路径是相对包目录的 slash-separated 名字,不是操作系统绝对路径。
  • ReadFile 直接读取完整嵌入名;fs.Sub 成功后,子 FS 内部不再重复公共目录。
  • Windows 也使用 /,不要用 filepath.Join 生成传给 fs.FS 的名字。
我们在Go开发里经常用到embed把静态文件打包进二进制,部署的时候不用额外带一堆资源文件,非常方便。很多新手刚接触`embed.FS`的时候,都会碰到路径写法不对、找不到嵌入文件的问题,其实只要遵循几个简单的规则,就能很顺利的用相对路径读取到所有嵌入的资源。
使用`embed`嵌入目录资源时,绑定的`embed.FS`对象根目录就是你写`//go:embed`指令时指定的文件夹路径,后续所有调用`fs.ReadFile`、`http.FileServer`这类API的地方,直接传入相对于这个根目录的相对路径字符串就可以正常读取,不需要额外拼接项目根路径或者操作系统绝对路径。

先把 embed.FS 里的名字算对

假设目录如下,Go 文件与 web 同属一个包目录:

assets.go
web/
  templates/index.html
  static/app.css

下面的模式会把匹配到的文件放进一个只读文件系统。读取名仍然从 web 开始,而不是从磁盘根目录开始:

package main

import (
    "embed"
    "fmt"
)

// 该模式相对当前包目录匹配,FS 中会保留 web/templates 前缀。
//go:embed web/templates/index.html web/static/app.css
var content embed.FS

func readTemplate() ([]byte, error) {
    // 读取名使用正斜杠,并完整写出嵌入后的相对路径。
    data, err := content.ReadFile("web/templates/index.html")
    if err != nil {
        return nil, fmt.Errorf("读取嵌入模板失败: %w", err)
    }
    return data, nil
}

这里的关键是“模式”和“读取名”属于同一套相对命名空间。ReadFile("index.html") 不会自动搜索子目录;即使目录里只有一个同名文件,也不能省略 web/templates

Go embed.FS 嵌入模式、包目录和完整读取路径之间的静态关系框图
图1:嵌入模式以包目录为边界,完整 FS 名称保留 web/templates 前缀,读取函数按同一名称定位文件。

需要短路径时用 fs.Sub 重设根

服务只负责提供 web 目录时,可以先构造子文件系统。这样做不是复制文件,也不是修改原始 FS,而是返回一个以指定目录为根的视图:

package main

import (
    "embed"
    "fmt"
    "io/fs"
)

// 资源仍按包目录相对路径嵌入,原始 FS 的根保持不变。
//go:embed web/templates/* web/static/*
var content embed.FS

func readFromWeb() ([]byte, error) {
    // 把 web 设为子 FS 的根,后续名称从 web 下面计算。
    webFS, err := fs.Sub(content, "web")
    if err != nil {
        return nil, fmt.Errorf("创建 web 子文件系统失败: %w", err)
    }

    // 子 FS 中的相对路径不再重复 web 前缀。
    data, err := fs.ReadFile(webFS, "templates/index.html")
    if err != nil {
        return nil, fmt.Errorf("读取子 FS 文件失败: %w", err)
    }
    return data, nil
}

可把两种写法放在一张速查表里:直接读原始 FS 就写完整名字;先 fs.Sub(content, "web") 后,所有名称都相对新的根。fs.Sub 的第二个参数自身也必须是规范的相对 FS 路径。

场景文件实际位置读取参数
直接读取原始 FSweb/templates/index.htmlweb/templates/index.html
创建 web 子 FS 后原始 FS 仍在同处templates/index.html
读取目录web/templates/web/templates 或子 FS 中的 templates
Go fs.Sub 将 web 目录设为新根后与 templates 文件的静态依赖关系框图
图2:fs.Sub 只改变观察根,web 子 FS 与 templates/index.html 的关系仍对应原始嵌入树。

路径为什么在 Windows 上也要写斜杠

io/fs 使用的是文件系统接口定义的路径名,不等同于本机磁盘路径。官方 embed 文档明确要求 //go:embed 模式使用正斜杠;路径不能以斜杠开头或结尾,也不能包含 ... 或空路径元素。因此下面几类写法都应排除:

  • web\\templates\\index.html:把 Windows 分隔符带进 FS 名称,跨平台代码会出现不一致。
  • /web/templates/index.html:这是绝对路径形式,不是嵌入树里的相对名字。
  • web/../templates/index.html:不能依靠路径清理越过 FS 根目录。

如果业务输入来自 URL 或配置,建议先在业务层定义允许的资源名,再交给 fs.ReadFile;不要为了“修正”输入而直接套 filepath.Clean。需要处理用户提供的文件名时,还要明确拒绝空字符串、绝对路径和含 .. 的片段。

常见问题

为什么 ReadFile("index.html") 会报不存在?

因为文件在 FS 中的完整名字是 web/templates/index.html。只有创建了以 web/templates 为根的子 FS,才可以使用更短的相对名称。

embed.FS.ReadFilefs.ReadFile 选哪个?

只有明确持有 embed.FS 时,直接调用方法最直观;如果函数参数是通用的 fs.FS,使用 fs.ReadFile 更容易替换为本地目录或测试用的文件系统。

可以用 filepath.Join 拼接嵌入路径吗?

不建议。它面向操作系统路径,可能生成反斜杠;嵌入文件和 io/fs 名称应使用正斜杠。固定资源名可直接写字符串,动态片段则应在业务层做严格约束。

fs.Sub 会把嵌入文件复制一份吗?

不会。它提供的是以子目录为根的 FS 视图,读取的数据仍来自原始只读文件系统。

参考:https://pkg.go.dev/embedhttps://go.dev/src/embed/embed.go

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
Redis ZRANGEBYLEX 如何按字典序取一段成员Redis ZRANGEBYLEX 如何按字典序取一段成员
上一篇
Redis ZRANGEBYLEX 如何按字典序取一段成员
VS Code 多根工作区如何分别设置语言服务
下一篇
VS Code 多根工作区如何分别设置语言服务
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    98次使用
  • OpenCompass大模型评测体系详解:功能、使用指南与应用场景
    OpenCompass
    OpenCompass是上海AI实验室推出的开源大模型评测平台,提供CompassKit、CompassHub和CompassRank三大核心组件,支持LLM及多模态模型的一站式标准化评估与排行榜查询。
    28次使用
  • SuperCLUE中文大模型评测基准:功能、能力维度与应用指南
    SuperCLUE
    SuperCLUE是权威的中文大语言模型综合评测基准,涵盖语言理解、知识应用、AI Agent智能体及安全性等12项核心能力。通过多轮对话与客观测试,定期发布榜单与技术报告,为模型研发、优化及行业选型提供科学依据。
    252次使用
  • C-Eval中文评测基准:大语言模型多学科能力评估指南
    C-Eval
    深入了解C-Eval中文评估套件,涵盖52个学科与4级难度。本文详解其功能特点、Zero-shot/Few-shot使用方法及代码示例,助您全面评测LLM中文理解与泛化能力。
    180次使用
  • AI Prompt Library:免费AI提示词库,助力ChatGPT高效创作与营销
    AI Prompt Library
    探索AI Prompt Library免费资源库,涵盖营销、写作及多场景AI提示词。兼容ChatGPT、Claude等工具,一键复制优化输出,提升工作效率。
    113次使用