代码改变世界

脑洞golang embed 的使用场景

2024-04-12 10:06  轩脉刃  阅读(354)  评论(1编辑  收藏  举报

golang 的 embed 的功能真是一个很神奇的功能,它能把静态资源,直接在编译的时候,打包到最终的二进制程序中。

为什么会设计这么一个功能呢?我想和 golang 的崇尚简单的原则有关系吧。它希望的是一个二进制文件能走天下,那么如果你作为一个 web 服务器,还需要依赖一大堆的静态文件,终究不算是一人一天下,所以就提供了这么一种处理静态资源的办法。

golang 一旦提供了这种方式,可能会有哪些应用呢?我这里脑洞一下:

web 服务内嵌单页应用

目前的 web 应用很流行单页应用,基本上就一个 html+一个编译后的 js 就能搞定,那么我提供 web 服务器就直接通过 golang 编写,embed 方式将 html 和编译后的 js 内嵌到服务器中,那么就能很方便进行部署了。

app服务内嵌单页应用

同 web 服务一样,如果我使用 golang 写的是一个带有浏览器外框的 app 程序,内部使用 html+js进行渲染,那么岂不是这个服务就可以在手机/桌面端进行运行了?

可执行文件的版本管理

这下我们可以再仓库的根目录创建一个 version.txt, 里面填写上你的仓库的版本号,在项目中使用 embed 引入这个文件。如果你的项目是一个可执行文件,就能在执行的时候,直接显示出版本信息了。

可执行文件的git的commit显示

我们其实很希望知道我的这个可执行文件是对应 git 的哪个 commit,如果能将 .git 下的文件中的 commit 号直接 embed 到程序中就好了。

当然.git下的文件是不能直接 embed 的,但是这里提供了一种 generate+embed 的方式来实现:

Embedding Git Commit Information in Go Binaries

可执行文件的 readme

以前一个可执行文件在输入 help 的时候,需要显示一个信息内容,在 git 项目外也要有个 readme,其实两者都是对这个项目的帮助。那么现在,就能使用 embed 将两个合而为一了。

licence注入

我不确定golang 的二进制程序是否很容易被反编译,但是相较于简单的 licence 发放,将 licence 编译进入二进制程序已经是安全不少了。

我们要控制某个程序的发行,那么就在给用户编译二进制程序的时候,将对应的 licence 以 embed 的形式编译进入,然后在程序运行的时候,去远程或者本地使用非对称解密等方式来验证这个 licence 的合法性。

提高性能

我们可以将一些中间结果,比如 xxx 预计算模型啥的,以 embed 的形式内嵌进入程序。

程序运行的时候,就能将这些中间结构和预计算模型反序列化出来。

template文件进行embed

之前使用 golang 的 template 的时候,往往要创建一个很大的 template 的变量,而这个变量往往就是 html 或者 txt。现在就能独立将这个 html 或者 txt 放在 git 仓库中,在编译的时候 embed 进入。部署的时候直接使用了。

这样看代码的时候逻辑很清晰,运行的时候也很便捷。

参考

//go:embed 入门

Go 语言 | 1.16 新增的embed在各流行Web框架中的应用

道理我都懂,但 go embed 究竟该怎么用?

Go embed 简明教程

How can I embed hidden file in Go?

Embedding Git Commit Information in Go Binaries