io パッケージ

io パッケージは、「読み込み」「書き込み」といった入出力の抽象化を提供する interface が中心のパッケージです。実際の読み書き機能は os(ファイル)や bytes(メモリバッファ)などのパッケージが提供しますが、それらは全て io.Reader / io.Writer という共通の interface(Goインタフェース 参照)を満たしています。

代表的な io.Writer の定義は以下のとおりです。

type Writer interface {
    Write(p []byte) (n int, err error)
}

「Write([]byte) を持ち、書き込んだバイト数と error を返す型」を表します。os.File(ファイル)、bytes.Buffer(メモリバッファ)、http.ResponseWriter(HTTPレスポンス)などが全て io.Writer を満たしています。書き込む側は「相手が io.Writer である」ことだけを知っていれば、実際の書き込み先がファイルでもメモリでもHTTPレスポンスでも同じコードで動きます。

次のコードは、os.Stdout(標準出力)と bytes.Buffer(メモリ)に同じ関数で書き込みを行う例です。

package main

import (
    "bytes"
    "fmt"
    "io"
    "os"
)

func writeGreeting(w io.Writer, name string) {
    fmt.Fprintf(w, "Hello, %s\n", name)
}

func main() {
    // 標準出力に書き込む
    writeGreeting(os.Stdout, "Taro")

    // メモリバッファに書き込む
    var buf bytes.Buffer
    writeGreeting(&buf, "Jiro")
    fmt.Println("buffer content:", buf.String())
}

以下のような実行結果が表示されます。

Hello, Taro
buffer content: Hello, Jiro

writeGreeting は io.Writer を受け取るだけで、書き込み先を意識しません。os.Stdout と &bytes.Buffer{} のどちらを渡しても、同じ関数で書き込みができました。

コードを解説します。

func writeGreeting(w io.Writer, name string) {
    fmt.Fprintf(w, "Hello, %s\n", name)
}

引数の型を io.Writer にすることで、実際の書き込み先を関数側で意識せずに済みます。fmt.Fprintf は「渡された io.Writer に対して書式付き出力する」関数で、fmt.Printf(標準出力に固定)と違って書き込み先を選べます。

writeGreeting(os.Stdout, "Taro")

os.Stdout は「標準出力」を表す *os.File で、io.Writer を満たしています。そのため writeGreeting の引数にそのまま渡せます。

var buf bytes.Buffer
writeGreeting(&buf, "Jiro")

bytes.Buffer はメモリ上のバッファで、こちらも io.Writer を満たしています。&buf として渡した後、buf.String() で溜まった内容を取り出せます。

「書き込み先を切り替える」ときに interface による抽象化が実感できる場面で、Goが公式で用意している代表的な interface として押さえておく価値があります。