fs.FS を使ってディレクトリ・ファイルを参照する
仕事で簡単なファイル操作のコードを書いたのだが io/fs パッケージの使い方をド忘れして往生したので，忘れないうちにメモっておく。
まずは基本形
まず，以下のディレクトリ・ファイルがあるとする。
$ tree testdata
testdata
├── hello1.txt
├── hello2.txt
└── hello3.txt
この testdata/*.txt ファイルの内容を標準出力に片っ端から出力するという簡単なお仕事。
なお，表示順は考慮しないものとする。
やりかたは色々あると思うが，今回は io/fs パッケージを使ったやり方でやってみる。
package main
import (
"fmt"
"io"
"io/fs"
"os"
)
func output(fileSystem fs.FS) error {
paths, err := fs.Glob(fileSystem, "*.txt")
if err != nil {
return err
}
for _, path := range paths {
if _, err := func(path string) (int64, error) {
f, err := fileSystem.Open(path)
if err != nil {
return 0, err
}
defer f.Close()
return io.Copy(os.Stdout, f)
}(path); err != nil {
return err
}
}
return nil
}
func main() {
if err := output(os.DirFS("testdata")); err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
}
手順としては
os.DirFS()関数でtestdataディレクトリのfs.FS型インスタンスを取得してoutput()関数に渡すoutput()関数ではfs.Glob()関数で"*.txt"にマッチするファイルの一覧を取得し，順にファイル内容を標準出力にコピーする
という感じ。
各ファイルのオープンからクローズまでの処理を無名関数1 として囲っているのは defer f.Close() を使いたかったから。
深い意味はない。
さて，この output() 関数を変えることなく通常のファイル以外のファイルシステムで応用してみる。
埋め込みファイルシステム
次は embed パッケージでディレクトリ・ファイルを埋め込んだ場合。
main 関数のみ書いておく。
パッケージのインポートは適当に補完してね（標準パッケージしか使ってないので無問題）。
//go:embed testdata/*.txt
var assets embed.FS
func main() {
fileSystem, err := fs.Sub(assets, "testdata")
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
if err := output(fileSystem); err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
}
上のコードでは assets ファイルシステムのルートが testdata の親ディレクトリになるので fs.Sub() 関数で testdata ディレクトリに下りてから output() 関数に渡している。
Zip ファイルシステム
今度は testdata ディレクトリを zip 圧縮した testdata.zip を読み込む場合。
これも main 関数のみ書いておく。
func main() {
rc, err := zip.OpenReader("./testdata.zip")
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
defer rc.Close()
fileSystem, err := fs.Sub(rc, "testdata")
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
if err := output(fileSystem); err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
}
zip.OpenReader() 関数は *zip.ReadCloser 型のインスタンスを返すのだが，これが fs.FS interface 型と互換があるため，そのまま io/fs パッケージの関数・メソッドに適用することができる。
最初の頃はこれに気付かなくて，しばらくソースコードとにらめっこしてしまった（笑）
ブックマーク
参考図書
- プログラミング言語Go
- アラン・ドノバン (著), ブライアン・カーニハン (著), 柴田芳樹 (著)
- 丸善出版 2016-06-20 (Release 2021-07-13)
- Kindle版
- B099928SJD (ASIN)
- 評価
Kindle 版出た！ 一部内容が古びてしまったが，この本は Go 言語の教科書と言ってもいいだろう。感想はこちら。
