概要
Go 1.16 から追加となった embed
パッケージについてのメモ2個目。
前回は以下。
embed
パッケージのドキュメントは以下。
今回は、単独のファイルを埋め込んで、その内容を []byte
で取得するサンプルです。
前回とほぼ同じで、埋め込みデータを格納する変数の型が []byte
になるだけですね。
Goでは []byte
の取り回しがすごく楽なので、個人的にはこっちをよく利用します。
サンプル
以下のサンプルでは、同一ディレクトリに配置されている helloworld.txt
を埋め込んで利用しています。
helloworld.txt というファイルは以下の内容です。
hello world
んで、利用する側は以下のような感じ。
package embeds import ( _ "embed" "encoding/hex" "os" ) //go:embed helloworld.txt var b []byte // EmbedBytes は、embed パッケージの機能を確認するサンプルです (バイト列として値を取得) func EmbedBytes() error { dumper := hex.Dumper(os.Stdout) defer dumper.Close() if _, err := dumper.Write(b); err != nil { return err } return nil }
単独ファイルを string
もしくは []byte
で利用する場合、embedパッケージはコメント部分でしか利用されないので import の部分を
import _ "embed"
という形で指定します。
実行すると以下のようになります。
gitpod /workspace/try-golang $ make run go get -d ./... go run -race github.com/devlights/try-golang/cmd/trygolang -onetime -example "" ENTER EXAMPLE NAME: embed_bytes [Name] "embed_bytes" 00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 |hello.world| [Elapsed] 109.911µs
埋め込みを指示している //go:embed helloworld.txt
の部分がちゃんと動作していますね。実行時には当然 helloworld.txt は必要ありません。
注意点として、バイナリにはそのまま埋め込まれていますので、バイナリエディタとかで除くと当然丸見えです。センシティブなデータは埋め込まないようにしましょう。(しないと思いますが)
参考資料
過去の記事については、以下のページからご参照下さい。
- いろいろ備忘録日記まとめ
サンプルコードは、以下の場所で公開しています。
- いろいろ備忘録日記サンプルソース置き場