Go1.16新特性embed打包静态资源文件实现

 更新时间:2022年07月22日 15:09:20   作者:八两  
这篇文章主要为大家介绍了Go 1.16新特性embed打包静态资源文件的实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

背景

相信有一部分人喜爱 GO 的初衷大概是:跨平台静态编译,如果在没用通过 CGO 引用其他库的话,一般编译出来的可执行二进制文件部署起来非常方便,但人们在实际中发现,使用 Go 语言开发的后端 WEB 程序存在 HTML 模版、图片、JS、CSS、JSON 等静态资源,部署时需要把这些静态资源与二进制程序一起上传到服务器部署,在现今遍地花容器的今天,为了简化部署流程,能不能更进一步的把这些静态文件与二进制程序一起打包起来部署,那样岂不是更方便?对运维来说打包一体化带来的好处就是运维复杂度的降低,对技术团队来说打包一体化还可以保证程序完整性可控性。

因此,GO 社区发起了一个期望 Go 编译器支持嵌入静态文件的提案issue#35950。现在,这个功能将随着 1.16 版本一起发布,目前最新的版本是 Go 1.16 RC1 预览版。

好了,接下来我们详细介绍 go embed 的各个功能。

embed 嵌入

└── cmd 测试目录
    ├── assets 静态资源目录
    │   ├── .idea.txt
    │   ├── golang.txt
    │   └── hello.txt
    └── main.go  测试go源文件

字符串、字节切片、文件嵌入

package main
import (
	"embed"
	_ "embed"
	"fmt"
)
//go:embed指令用来嵌入,必须紧跟着嵌入后的变量名
//只支持嵌入为string, byte slice和embed.FS三种类型,这三种类型的别名(alias)和命名类型(如type S string)都不可以
//以字符串形式嵌入 assets/hello.txt
//go:embed assets/hello.txt
var s string
//文件的内容嵌入为slice of byte,也就是一个字节数组
//go:embed assets/hello.txt
var b []byte
//嵌入为一个文件系统 新的文件系统FS
//go:embed assets/hello.txt
//go:embed assets/golang.txt
var f embed.FS
func main() {
	fmt.Println("embed string.", s)
	fmt.Println("embed byte.", string(b))
	data, _ := f.ReadFile("assets/hello.txt")
	fmt.Println("embed fs.", string(data))
	data, _ = f.ReadFile("assets/golang.txt")
	fmt.Println("embed fs.", string(data))
}

编译运行后输出:

embed string. hello golang!
embed byte. hello golang!
embed fs. hello golang!
embed fs. hello!

从上面的代码可以看出,embed 支持嵌入为 string,byte slice 和 embed.FS 这三种类型,另外也不允许从这些类型中派生哦。

嵌入文件

对于 FS 类型的嵌入,也可以支持一个变量嵌入多个文件。

//go:embed assets/hello.txt
//go:embed assets/golang.txt
var f embed.FS

当然也支持,两个变量嵌入一个文件。虽然两个变量嵌入了同一个文件,但它们在编译的时候会独立分配,彼此之间并不会互相影响。

嵌入文件夹

FS 类型的嵌入支持文件夹.分隔符采用正斜杠/,即使是 windows 系统也采用这个模式。

//go:embed assets
var f embed.FS
func main() {
	data, _ := f.ReadFile("assets/hello.txt")
	fmt.Println(string(data))
}

嵌入匹配

go:embed 指令中可以只写文件夹名,此文件夹中除了.和_开头的文件和文件夹都会被嵌入,并且子文件夹也会被递归的嵌入,形成一个此文件夹的文件系统。

如果想嵌入.和_开头的文件和文件夹, 比如.hello.txt 文件,那么就需要使用*,比如 go:embed assets/*。

不具有递归性,所以子文件夹下的.和_不会被嵌入,除非你在专门使用子文件夹的进行嵌入:

├── assets
│   ├── .idea.txt
│   ├── golang.txt
│   └── hello.txt
└── main.go
package main
import (
	"embed"
	_ "embed"
	"fmt"
)
//go:embed assets/*
var f embed.FS
func main() {
	data, _ := f.ReadFile("assets/.idea.txt")
	fmt.Println(string(data))
}

FS 文件系统

embed.FS 实现了 io/fs.FS 接口,它可以打开一个文件,返回 fs.File:

package main
import (
	"embed"
	_ "embed"
	"fmt"
)
//go:embed assets
var f embed.FS
func main() {
	helloFile, _ := f.Open("assets/hello.txt")
	stat, _ := helloFile.Stat()
	fmt.Println(stat.Name(), stat.Size())
}

它还提供了 ReadFileh 和 ReadDir 功能,遍历一个文件下的文件和文件夹信息:

package main
import (
	"embed"
	_ "embed"
	"fmt"
)
//go:embed assets
var f embed.FS
func main() {
	dirEntries, _ := f.ReadDir("assets")
	for _, de := range dirEntries {
		fmt.Println(de.Name(), de.IsDir())
	}
}

因为它实现了 io/fs.FS 接口,所以可以返回它的子文件夹作为新的文件系统:

package main
import (
	"embed"
	_ "embed"
	"fmt"
	"io/fs"
	"io/ioutil"
)
//go:embed assets
var f embed.FS
func main() {
	as, _ := fs.Sub(f, "assets")
	hi, _ := as.Open("hello.txt")
	data, _ := ioutil.ReadAll(hi)
	fmt.Println(string(data))
}

总结:

  • 对于单个的文件,支持嵌入为字符串和 byte slice
  • 对于多个文件和文件夹,支持嵌入为新的文件系统 FS
  • go:embed 指令用来嵌入,必须紧跟着嵌入后的变量名
  • 只支持嵌入为 string, byte slice 和 embed.FS 三种类型,类型派生也不可以。

以上就是Go 1.16新特性embed打包静态资源文件实现的详细内容,更多关于Go embed打包静态资源的资料请关注脚本之家其它相关文章!

相关文章

  • Go timer如何调度

    Go timer如何调度

    本篇文章剖析下 Go 定时器的相关内容。定时器不管是业务开发,还是基础架构开发,都是绕不过去的存在,由此可见定时器的重要程度,感兴趣的可以了解一下
    2021-06-06
  • 使用Golang生成压缩文件的详细教程

    使用Golang生成压缩文件的详细教程

    与其他语言一样,内置标准库默认支持文件压缩功能,本文介绍Golang如何创建压缩文件,增加一个或多个文件生成压缩文件,也可以在压缩文件中创建文件夹,用于对文件进行分类管理,Golang标准库 archive/zip提供了创建和读取压缩文件功能,需要的朋友可以参考下
    2024-01-01
  • Go语言的文件操作代码汇总

    Go语言的文件操作代码汇总

    本文给大家汇总介绍了go语言中的文件操作的代码,包括文件的读写,文件的新建打开和删除等,希望对大家学习go语言能够有所帮助
    2018-10-10
  • golang创建文件目录os.Mkdir,os.MkdirAll的区别说明

    golang创建文件目录os.Mkdir,os.MkdirAll的区别说明

    本文主要讲述os.Mkdir、os.MkdirAll区别以及在创建文件目录过程中的一些其他技巧,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-03-03
  • golang用melody搭建轻量的websocket服务的示例代码

    golang用melody搭建轻量的websocket服务的示例代码

    在Go中,可以使用gin和melody库来搭建一个轻量级的WebSocket服务,gin是一个流行的Web框架,而melody是一个用于处理WebSocket的库,本文给大家演示如何使用gin和melody搭建WebSocket服务,感兴趣的朋友一起看看吧
    2023-10-10
  • golang 对私有函数进行单元测试的实例

    golang 对私有函数进行单元测试的实例

    这篇文章主要介绍了golang 对私有函数进行单元测试的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go语言实现遍历文件夹

    Go语言实现遍历文件夹

    这篇文章主要为大家详细介绍了Go语言实现遍历文件夹的相关方法,文中的示例代码讲解详细,具有一定的参考价值,感兴趣的小伙伴可以了解一下
    2023-05-05
  • 关于golang中map使用的几点注意事项总结(强烈推荐!)

    关于golang中map使用的几点注意事项总结(强烈推荐!)

    map是一种无序的基于key-value的数据结构,Go语言中的map是引用类型,必须初始化才能使用,下面这篇文章主要给大家介绍了关于golang中map使用的几点注意事项,需要的朋友可以参考下
    2023-01-01
  • Golang接入钉钉通知的示例代码

    Golang接入钉钉通知的示例代码

    本文主要介绍了Golang接入钉钉通知的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Windows下升级go版本过程详解

    Windows下升级go版本过程详解

    这篇文章主要为大家介绍了Windows下升级go版本过程详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03

最新评论