nasa9084
· 1 min read

jessevdk/go-assetsでファイルを埋め込む

jessevdk/go-assetsでファイルを埋め込む

Go言語の素敵なところの一つとして、最終的な成果物を1バイナリに収めることができる、という点にあると思う。結果として、非常に簡単にコマンドラインツールなどを配布することができる。
しかし、例えばコード生成を行うようなツールでテンプレートファイルを別途持っているような場合や、アプリケーション中で使う画像などを含む場合など、Goのソースコード以外のファイルを必要とする場合、全てを1ファイルで、とはいかない。

そのような場合に便利なのがjessevdk/go-assetsである。以前は多くの人がgo-bindataを使用していたと思われるが、作者がやめてしまったため、使えなくなってしまった。代替としてこれが便利。
jessevdk/go-assetsを使用するには、まずjessevdk/go-assets-builderを使用する。これは、指定したファイルをGoのソースコードに埋め込んで、それらを扱うためのAssetsというオブジェクトを作成してくれるツールである。

インストールは簡単で、go getするだけ。

$ go get github.com/jessevdk/go-assets-builder

インストールできたら、次のように使う。

$ ls assets/
foo.html.tmpl bar.png
$ go-assets-builder assets -o assets.go

すると、assetsディレクトリの内容が埋め込まれたassets.goが生成される。今回は特にパッケージ名を指定していないのて、package mainとして作成された。必要なら-pオプションでパッケージ名を指定することもできる。
生成されたあとは、実際に使いたいソースコード内で次のように使う。

f, _ := Assets.Open("/assets/foo.html.tmpl")
// in production, need to handle error
defer f.Close()
// Do something with f

ここで作成されたfos.Fileと同じインターフェースを備えている。要するに、os.Openを使用したときと同じように操作することができる。

また、Assetsという変数を別に使いたいときは、go-assets-builderでパッキングするときに-vオプションで変数名を指定することもできる。ディレクトリ全体ではなく、個別のファイルを指定することもできる。