您现在的位置是:首页 >技术交流 >Golang笔记:使用embed包将静态资源嵌入到程序中网站首页技术交流

Golang笔记:使用embed包将静态资源嵌入到程序中

Naisu Xu 2024-06-17 10:32:11
简介Golang笔记:使用embed包将静态资源嵌入到程序中

目的

Golang编译程序默认是静态编译,会把相关的库都打包到一起,这在分发部署使用时非常方便。不过如果项目中用到的外部的静态资源文件,通常就需要将这些资源和程序一起拷贝分发了。现在可以使用标准库中 embedhttps://pkg.go.dev/embed 将静态资源文件打包到一起。

使用演示

embed 包支持将文件变成 string []byte 或者 FS 类型的变量引入程序中。下面是一些演示:

package main

import (
	_ "embed"
	"fmt"
)

// 下面一行像是注释的的内容是一条指令
// 它会将后面指定的文件的内容赋值给下面紧挨着声明的变量

//go:embed file1.txt
var s string

//go:embed subdir/file2.txt
var b []byte

func main() {
	fmt.Println(s)
	fmt.Println(string(b))
}

在这里插入图片描述

下面是 FS 类型演示:

package main

import (
	"embed"
	_ "embed"
	"fmt"
)

// 下面是embed最好用的功能,把文件放到FS中

//go:embed file1.txt
//go:embed subdir/file2.txt
var f embed.FS

func main() {
	data, _ := f.ReadFile("file1.txt")
	fmt.Println(string(data))
	data, _ = f.ReadFile("subdir/file2.txt")
	fmt.Println(string(data))
}

在这里插入图片描述

//go:embed 指令

//go:embed 指令有一些需要注意的点(以下内容根据版本不同可能会有较大变动):

  • 要嵌入的文件支持当前程序( *.go )所在目录及子目录;
  • 嵌入的文件系统是只读的,支持 Open ReadDir ReadFile 三个方法进行访问;
  • 一条 //go:embed 指令后面可以写用空格隔开的多个文件,也可以用多条 //go:embed 将文件内容放入一个变量中,比如下面两者是等价的:
    //go:embed file1.txt file2.txt
    var f embed.FS
    
    //go:embed file1.txt
    //go:embed file2.txt
    var f embed.FS
    
  • //go:embed 后也可以跟文件夹,默认情况下不会包含文件夹中 . _ 开头的文件;
  • 可以使用 * 来匹配文件下所有文件(包括 . _ 开头的文件),但 * 不会递归子目录中 . _ 开头的文件;
  • 可以在文件夹名称前加上 all: 来匹配所有文件,并且会递归子目录中 . _ 开头的文件;
  • 可以使用 //go:embed * 来表示当前目录;

在WebServer中应用

embed比较常用的一个应用是在WebServer项目中打包网页静态资源文件,比如下面例子:

目录结构和网页文件内容:
在这里插入图片描述

WebServer代码:

package main

import (
	"embed"
	_ "embed"
	"net/http"
)

//go:embed index.html assets
var content embed.FS

func main() {
	// 使用embed.FS作为WebServer静态文件服务目录
	fs := http.FileServer(http.FS(content))
	http.Handle("/", http.StripPrefix("/", fs))
	http.ListenAndServe(":80", nil)
}

在这里插入图片描述

总结

embed 是一个非常好的工具,可以大大提升编译出的程序的封装性,方便安装部署。

风语者!平时喜欢研究各种技术,目前在从事后端开发工作,热爱生活、热爱工作。