【Golang】Golang使用embed加载、打包静态资源文件

2024-02-25 20:20
文章标签 加载 golang 使用 资源 打包 静态 embed

本文主要是介绍【Golang】Golang使用embed加载、打包静态资源文件，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

【Golang】Golang使用embed加载、打包静态资源文件

大家好 我是寸铁👊
总结了一篇Golang使用embed加载静态资源文件的文章✨
喜欢的小伙伴可以点点关注 💝

前言

事情是这样的：前不久，有同学问我,golang怎么把静态资源文件打包成一个可执行文件呢？便于后序服务器资源的部署！

在这里插入图片描述

经本人同意授权，图像码掉。

这不今天这个问题的答案就来啦！

背景

Go编译的程序非常适合部署，如果没有通过CGO引用其它的库的话，我们一般编译出来的可执行二进制文件都是单个的文件，非常适合复制和部署。在实际使用中，除了二进制文件，可能还需要一些配置文件，或者静态文件，比如html模板、静态的图片、CSS、javascript等文件，如何这些文件也能嵌入到二进制文件中，那就太美妙，我们只需复制、执行单个的可执行文件即可。

一些开源的项目很久以前就开始做这方面的工作，比如gobuffalo/packr、markbates/pkger、rakyll/statik、knadh/stuffbin等等，但是不管怎么说这些都是第三方提供的功能，如果Go官方能内建支持就好了。2019末一个提案被提出issue#35950,期望Go官方编译器支持嵌入静态文件。后来Russ Cox专门写了一个设计文档Go command support for embedded static assets, 并最终实现了它。

应用场景

为什么需要embed包?

  • 部署过程更简单。传统部署要么需要将静态资源与已编译程序打包在一起上传，或者使用docker和dockerfile自动化前者，这在精神上是很麻烦的。
  • 确保程序的完整性。在运行过程中损坏或丢失静态资源通常会影响程序的正常运行。
  • 独立控制程序所需的静态资源。

最常见的方法（例如静态网站的后端程序）要求将程序连同其所依赖的html模板，css，js和图片以及静态资源的路径一起上传到生产服务器。必须正确配置Web服务器，以便用户访问它。

现在，我们将所有这些资源都嵌入到程序中。我们只需要部署一个二进制文件并为程序本身配置它们即可。部署过程已大大简化!

常用场景

以下列举一些静态资源文件需要被嵌入到程序中的常用场景：

  • Go模板：模板文件必须可用于二进制文件（模板文件需要对二进制文件可用）。 对于Web服务器二进制文件或那些通过提供init命令的CLI应用程序，这是一个相当常见的用例。 在没有嵌入的情况下，模板通常内联在代码中。例如示例qbec init的init命令。
  • 静态web服务：有时，静态文件（如index.html或其他HTML，JavaScript和CSS文件之类的静态文件）需要使用golang服务器二进制文件进行传输，以便用户可以运行服务器并访问这些文件。例如示例web server中嵌入静态资源文件
  • 数据库迁移：另一个使用场景是通过嵌入文件被用于数据库迁移脚本。参考示例数据库迁移文件

定义

embed是在Go 1.16中新加包。它通过//go:embed指令，可以在编译阶段将静态资源文件打包进编译好的程序(exe)中，并提供访问这些文件的能力。

嵌入

  • 对于单个的文件，支持嵌入类型为string和 byte slice
  • 对于多个文件和文件夹，支持嵌入为新的文件系统FS
  • 比如导入 "embed"包，即使无显式的使用
  • go:embed指令用来嵌入，必须紧跟着嵌入后的变量名
  • 只支持嵌入为string, byte slice和embed.FS三种类型，这三种类型的别名(alias)和命名类型(如type S string)都不可以!

同学们，暂时看不懂别着急,后面会逐个对上面的特性进行使用！

语法说明

  • go:embed指令用来嵌入，必须紧跟着嵌入后的变量名
//go:embed 要嵌入的文件

如下图片说明：

  • 把hello.txt文件嵌入到data这个字符串变量

在这里插入图片描述

  • 导入 "embed"包，即使无显式的使用
    在这里插入图片描述

基本使用

嵌入字符串

对于单个的文件，支持嵌入类型为string和 byte slice

  • 先编写hello.txt文件，文件内容可以自定义，用于后面的各种操作。

在这里插入图片描述

demo
  • 编写demo用于测试能否嵌入字符串，demo如下：
package mainimport (_ "embed" //导入` "embed"`包，即使`无显式的使用`"fmt"
)//go:embed hello.txt
var data stringfunc main() {fmt.Println(data)
}
  • 运行demo
    在这里插入图片描述

如上图，可以打印出嵌入文件的字符串变量的内容！

这样就实现把一个txt文件嵌入到字符串变量啦！

是不是很简单，后面还有更强大的功能，继续往下走！

  • 接着，我们使用go build一键生成可执行文件(exe)

在这里插入图片描述

  • 生成后,会在文件夹中出现如下exe文件：

在这里插入图片描述

这时，我们可以不妨大胆把原来要嵌入的文件hello.txt给重命名或者直接删掉，看看能不能通过执行exe文件输出原来嵌入的文件的内容？

  • 使用重命名：

在这里插入图片描述

  • 使用删除：
    在这里插入图片描述

控制台输入如下命令:

.\embed.exe

运行结果如下：
在这里插入图片描述

可以发现删除或者重命名文件后，仍然可以通过去执行生成的二进制文件去输出原来嵌入文件的内容！ 这就是嵌入功能的强大之处！

嵌入byte slice

对于单个的文件，支持嵌入类型为string和 byte slice

将上面data的数据类型改为[]byte即可

demo
package mainimport (_ "embed""fmt"
)//go:embed hello.txt
var data []bytefunc main() {//将字节数组string化,输出字节数组的内容。fmt.Println(string(data))
}

测试一下，能否输出文件的内容！

执行结果如下：

在这里插入图片描述

再测试一下运行生成的可执行文件，结果如下：

在这里插入图片描述

可以发现照常可以输出原来嵌入文件的内容！

嵌入文件系统FS

对于多个文件和文件夹，支持嵌入为新的文件系统FS

使用embed.FS嵌入的文件变量,具有3种功能，如下所示：

在这里插入图片描述

嵌入一个文件
package mainimport ("embed"_ "embed""fmt"
)//go:embed hello.txt
var data embed.FS //嵌入文件系统func main() {//data嵌入了一个文件系统,文件系统中有一个文件叫hello.txt//使用ReadFile读取这个文件的内容read, err := data.ReadFile("hello.txt")//输出内容fmt.Println(string(read), err)
}

运行结果如下:

在这里插入图片描述

再测试一下运行生成的可执行文件，结果如下：

在这里插入图片描述

可以发现照常可以输出原来嵌入文件的内容！

嵌入多个文件
  • 编写另一个文件的内容如下：

在这里插入图片描述

  • 嵌入多个文件很简单，只需要在后面添加文件即可。
//go:embed hello.txt hello1.txt
var data embed.FS
  • demo
package mainimport ("embed"_ "embed""fmt"
)//go:embed hello.txt hello1.txt
var data embed.FSfunc main() {read, err := data.ReadFile("hello.txt")fmt.Println(string(read), err)read1, err := data.ReadFile("hello1.txt")fmt.Println(string(read1), err)
}

执行结果如下：

在这里插入图片描述

再测试一下运行生成的可执行文件，结果如下：

在这里插入图片描述

嵌入一个文件夹

  • 创建一个文件夹dir 再把之前的文件给转移到上面去。
    在这里插入图片描述

  • demo

打印文件的名字

Info()的结构体信息如下：

// FileInfo 接口描述了一个文件，由 Stat 方法返回。
type FileInfo interface {Name() string       // 文件的基本名称Size() int64        // 对于普通文件，以字节为单位的长度；对于其他文件类型，取决于系统Mode() FileMode     // 文件的模式位ModTime() time.Time // 修改时间IsDir() bool        // 是否为目录的简写，等同于 Mode().IsDir()Sys() any           // 底层数据源（可能返回 nil）
}

打印一下文件的名字

package mainimport ("embed"_ "embed""fmt"
)//go:embed dir
var data embed.FSfunc main() {//读取文件夹dirdir, _ := data.ReadDir("dir")//entry为遍历dir文件夹中的每个文件for _, entry := range dir {info, _ := entry.Info()  // 获取文件的信息fmt.Println(info.Name()) // 获取文件中的名字}
}

运行结果如下：

在这里插入图片描述

获取文件的内容
package mainimport ("embed"_ "embed""fmt""path"
)//go:embed dir
var data embed.FSfunc main() {//读取文件夹dirdir, _ := data.ReadDir("dir")//entry为遍历dir文件夹中的每个文件for _, entry := range dir {info, _ := entry.Info() // 获取文件的信息//使用data的ReadFile方法打开文件//使用path.Join拼接文件的路径file, err := data.ReadFile(path.Join("dir", info.Name()))//输出内容fmt.Println(string(file), err)}
}

运行结果如下：

在这里插入图片描述

注意事项

  • go embed的使用只能用于包级别声明的变量(全局变量)

不能放在方法中！

在这里插入图片描述

结语

Go语言中的embed包是在Go 1.16版本中引入的，用于将文件内容嵌入到Go程序中。
尽管embed提供了一种方便的方式来嵌入文件，但它也有一些缺点：

  1. 编译时间较长： 当项目中嵌入的文件数量较多或文件较大时，embed可能导致编译时间变长。每次修改嵌入的文件，都需要重新构建整个程序。

  2. 不支持动态更新： 由于嵌入的文件在编译时就被固定在可执行文件中，因此无法在运行时动态更新嵌入的文件内容。如果需要在运行时更新文件，可能需要使用其他方法，如将文件存储在磁盘上并在需要时读取。

  3. 可执行文件大小增加： 将文件嵌入到可执行文件中会增加可执行文件的大小。对于一些嵌入了大量或大型文件的应用程序，这可能会导致可执行文件较大，影响部署和传输时间。

  4. 不适用于所有场景： embed适用于将静态文件嵌入到程序中，但不适用于所有场景。例如，如果需要对配置文件进行频繁的写入和修改，可能会选择将文件保存在独立的目录中。

总体而言，embed是一个强大的工具，特别适用于需要将资源文件打包到可执行文件中的情况。但在选择使用时，需要权衡它的优点和缺点，并根据项目的需求和约束进行选择！

看到这里的小伙伴，恭喜你又掌握了一个技能👊
希望大家能取得胜利，坚持就是胜利💪
我是寸铁！我们下期再见💕

往期好文💕

保姆级教程

【保姆级教程】Windows11下go-zero的etcd安装与初步使用

【保姆级教程】Windows11安装go-zero代码生成工具goctl、protoc、go-zero

【Go-Zero】手把手带你在goland中创建api文件并设置高亮

报错解决

【Go-Zero】Error: user.api 27:9 syntax error: expected ‘:‘ | ‘IDENT‘ | ‘INT‘, got ‘(‘ 报错解决方案及api路由注意事项

【Go-Zero】Error: only one service expected goctl一键转换生成rpc服务错误解决方案

【Go-Zero】【error】 failed to initialize database, got error Error 1045 (28000):报错解决方案

【Go-Zero】Error 1045 (28000): Access denied for user ‘root‘@‘localhost‘ (using password: YES)报错解决方案

【Go-Zero】type mismatch for field “Auth.AccessSecret“, expect “string“, actual “number“报错解决方案

【Go-Zero】Error: user.api 30:2 syntax error: expected ‘)‘ | ‘KEY‘, got ‘IDENT‘报错解决方案

【Go-Zero】Windows启动rpc服务报错panic:context deadline exceeded解决方案

Go面试向

【Go面试向】defer与time.sleep初探

【Go面试向】defer与return的执行顺序初探

【Go面试向】Go程序的执行顺序

【Go面试向】rune和byte类型的认识与使用

【Go面试向】实现map稳定的有序遍历的方式

这篇关于【Golang】Golang使用embed加载、打包静态资源文件的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/746603。

相关文章

中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
使用SecondaryNameNode恢复NameNode的数据

使用SecondaryNameNode恢复NameNode的数据

1）需求： NameNode进程挂了并且存储的数据也丢失了，如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2）故障模拟 （1）kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 （2）删除NameNode存储的数据（/opt/module/hadoop-3.1.4/data/tmp/dfs/na
阅读更多...
Hadoop数据压缩使用介绍

Hadoop数据压缩使用介绍

一、压缩原则 （1）运算密集型的Job，少用压缩 （2）IO密集型的Job，多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1）为了支持多种压缩/解压缩算法，Hadoop引入了编码/解码器 2）要在Hadoop中启用压缩，可以配置如下参数
阅读更多...
Makefile简明使用教程

Makefile简明使用教程

文章目录 规则makefile文件的基本语法：加在命令前的特殊符号：.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具，常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件
阅读更多...
使用opencv优化图片（画面变清晰）

使用opencv优化图片（画面变清晰）

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化，使其看起来更清晰，同时保持尺寸不变，通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多，主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器：相机传
阅读更多...
springboot3打包成war包，用tomcat8启动

springboot3打包成war包，用tomcat8启动

1、在pom中，将打包类型改为war <packaging>war</packaging> 2、pom中排除SpringBoot内置的Tomcat容器并添加Tomcat依赖，用于编译和测试,         *依赖时一定设置 scope 为 provided （相当于 tomcat 依赖只在本地运行和测试的时候有效，         打包的时候会排除这个依赖）<scope>provided
阅读更多...
pdfmake生成pdf的使用

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据，将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma
阅读更多...
零基础学习Redis(10) -- zset类型命令使用

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合，内部除了存储元素外，还会存储一个score，存储在zset中的元素会按照score的大小升序排列，不同元素的score可以重复，score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]
阅读更多...
git使用的说明总结

git使用的说明总结

Git使用说明 下载安装(下载地址) macOS: Git - Downloading macOS Windows: Git - Downloading Windows Linux/Unix: Git (git-scm.com) 创建新仓库 本地创建新仓库：创建新文件夹，进入文件夹目录，执行指令 git init ，用以创建新的git 克隆仓库 执行指令用以创建一个本地仓库的
阅读更多...
【北交大信息所AI-Max2】使用方法

【北交大信息所AI-Max2】使用方法

BJTU信息所集群AI_MAX2使用方法 使用的前提是预约到相应的算力卡，拥有登录权限的账号密码，一般为导师组共用一个。 有浏览器、ssh工具就可以。 1.新建集群Terminal 浏览器登陆10.126.62.75 （如果是1集群把75改成66） 交互式开发 执行器选Terminal 密码随便设一个（需记住） 工作空间：私有数据、全部文件 加速器选GeForce_RTX_2080_Ti
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2