go1.16新特性 内置内嵌资源文件的支持

go1.16已经入冻结阶段,这一次较重大的更新是对内嵌资源文件的支持。

内嵌资源文件

典型场景:当你需要在云应用程序中实现一个自动发送邮件的功能时,需要一个html文件作为邮件的模板,一般情况下可以将这个html文件放在指定目录,在go代码中指定路径来读取它。
有一种更加简便的办法,就是将这个html文件用一些手段生成成go文件中的一个变量,这样这个文件就作为代码的一部分,可以在代码中直接使用了。
目前比较常用的是go-bindata工具。

使用go-bindata

安装
go get -u github.com/jteeuwen/go-bindata/...

# test.tpl是模板文件
➜  ls
go.mod   go.sum   test.tpl main.go

使用go-bindata生成go文件 tpl.go
➜  go-bindata -o tpl.go test.tpl
➜  ls
go.mod   go.sum   main.go  test.tpl tpl.go

生成的go文件的内容

package main

import (
        "bytes"
        "compress/gzip"
        "fmt"
        "io"
        "strings"
)

func bindata_read(data []byte, name string) ([]byte, error) {
        gz, err := gzip.NewReader(bytes.NewBuffer(data))
        if err != nil {
                return nil, fmt.Errorf("Read %q: %v", name, err)
        }

        var buf bytes.Buffer
        _, err = io.Copy(&buf, gz)
        gz.Close()

        if err != nil {
                return nil, fmt.Errorf("Read %q: %v", name, err)
        }

        return buf.Bytes(), nil
}

var _test_tpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\xb2\x49\xca\x4f\xa9\xb4\xe3\xb2\x89\x01\xd3\x80\x00\x00\x00\xff\xff\x68\x04\xe9\x1d\x0e\x00\x00\x00")

func test_tpl() ([]byte, error) {
        return bindata_read(
                _test_tpl,
                "test.tpl",
        )
}

// Asset loads and returns the asset for the given name.
// It returns an error if the asset could not be found or
// could not be loaded.
func Asset(name string) ([]byte, error) {
        cannonicalName := strings.Replace(name, "\\", "/", -1)
        if f, ok := _bindata[cannonicalName]; ok {
                return f()
        }
        return nil, fmt.Errorf("Asset %s not found", name)
}

// AssetNames returns the names of the assets.
func AssetNames() []string {
        names := make([]string, 0, len(_bindata))
        for name := range _bindata {
                names = append(names, name)
        }
        return names
}

// _bindata is a table, holding each asset generator, mapped to its name.
var _bindata = map[string]func() ([]byte, error){
        "test.tpl": test_tpl,
}
// AssetDir returns the file names below a certain
// directory embedded in the file by go-bindata.
// For example if you run go-bindata on data/... and data contains the
// following hierarchy:
//     data/
//       foo.txt
//       img/
//         a.png
//         b.png
// then AssetDir("data") would return []string{"foo.txt", "img"}
// AssetDir("data/img") would return []string{"a.png", "b.png"}
// AssetDir("foo.txt") and AssetDir("notexist") would return an error
// AssetDir("") will return []string{"data"}.
func AssetDir(name string) ([]string, error) {
        node := _bintree
        if len(name) != 0 {
                cannonicalName := strings.Replace(name, "\\", "/", -1)
                pathList := strings.Split(cannonicalName, "/")
                for _, p := range pathList {
                        node = node.Children[p]
                        if node == nil {
                                return nil, fmt.Errorf("Asset %s not found", name)
                        }
                }
        }
        if node.Func != nil {
                return nil, fmt.Errorf("Asset %s not found", name)
        }
        rv := make([]string, 0, len(node.Children))
        for name := range node.Children {
                rv = append(rv, name)
        }
        return rv, nil
}

type _bintree_t struct {
        Func func() ([]byte, error)
        Children map[string]*_bintree_t
}
var _bintree = &_bintree_t{nil, map[string]*_bintree_t{
        "test.tpl": &_bintree_t{test_tpl, map[string]*_bintree_t{
        }},
}}

生成以上的go文件就可以通过AssetDir方法直接返回文件的内容了。

➜  ll
total 40
-rw-r--r--  1 wll  staff   120B 11 22 23:31 go.mod
-rw-r--r--  1 wll  staff   205B 11 22 23:31 go.sum
-rw-r--r--  1 wll  staff    13B 11 22 23:30 main.go
-rw-r--r--  1 wll  staff    14B 11 22 23:58 test.tpl
-rw-r--r--  1 wll  staff   2.6K 11 22 23:59 tpl.go # 文件比tpl大的多

这样做的缺点也很明显,生成的文件大,需要依赖第三方生成器。

go1.16的内嵌资源

package main

import (
    "fmt"
    _ "embed"
)

//go:embed test.tpl
var tpl []byte

func main() {
    fmt.Println(tpl)
}

以上是go1.16内嵌资源的方法。
通过引入embed包,定义一个[]byte类型的变量,通过//go:embed test.tpl这段段代码标记这个变量读取的静态文件,使用go build,即可生成对应的go文件。
比起上面那个go-bindate,可以说是十分简单优雅了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容