fmt パッケージ

プログラムが外部と情報をやり取りするための仕組みが入出力です。Goでは、標準ライブラリの fmt パッケージで画面表示や文字列組み立てを行います。「Go基本文法」の「まずは動かしてみよう」でも fmt.Println を使っており、実は本講座で最初から使い続けている定番パッケージです。

1. 標準出力(fmt.Println)

標準出力(standard output)は、プログラムが処理結果を書き出す既定の出力先です。プログラム側からは常に「標準出力に書き込む」という同じ操作ですが、実際の出力先は実行環境によって決まります。ターミナルから実行した場合はターミナル画面に表示され、サーバ上でサービスとして動かす場合はログファイルやログ収集システムに転送されます。プログラム側が出力先を意識せずに済むのが利点です。

fmt.Println は、渡した値をこの標準出力に書き出し、末尾に改行を自動で付ける関数です。

1.1 1つの値の出力

ここではまず、fmt.Printlnに値を1つだけ渡す形式を扱います。書き方は以下のとおりです。

fmt.Println(値)   // 値を表示し、末尾で改行する

次のコードは、文字列・整数・真偽値をそれぞれ1つずつ渡して表示する例です。main.go を以下の内容に書き換えて保存し、go run main.go で実行します。

package main

import "fmt"

func main() {
    fmt.Println("Hello, Go!")
    fmt.Println(42)
    fmt.Println(true)
}

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

Hello, Go!
42
true

fmt.Println は文字列だけでなく、整数や真偽値もそのまま渡せることが確認できます。

1.2 複数の値の連結出力

fmt.Println は複数の値を受け取ることもでき、その場合はカンマで区切って渡します。書き方は以下のとおりです。

fmt.Println(値1, 値2, ...)   // 半角スペースで区切って表示し、末尾で改行する

次のコードは、文字列と整数、真偽値を組み合わせて1行で表示する例です。

fmt.Println("count =", 10, "enabled =", true)

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

count = 10 enabled = true

4つの値がスペースで区切られて1行にまとまって表示されました。

コードを解説します。

fmt.Println("count =", 10, "enabled =", true)

fmt.Println は複数の値を受け取ると、それぞれを半角スペースで区切って連結し、1行にまとめて出力します。

2. 書式付き出力(fmt.Printf)

fmt.Printf は、書式指定子(%s %d %f など)を使って値を埋め込みながら出力できる関数です。書き方は以下のとおりです。

fmt.Printf("書式文字列", 引数1, 引数2, ...)   // 書式文字列の %s/%d などの位置に引数を埋め込んで出力する

次のコードは、名前と年齢を文字列に埋め込んで表示する例です。

package main

import "fmt"

func main() {
    name := "Taro"
    age := 30

    fmt.Printf("名前は %s、年齢は %d です\n", name, age)
}

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

名前は Taro、年齢は 30 です

%s の位置に name、%d の位置に age の値が埋め込まれて表示されました。

コードを解説します。

fmt.Printf("名前は %s、年齢は %d です\n", name, age)

第1引数の書式文字列にある %s は文字列、%d は整数の埋め込み位置を示します。第2引数以降に渡した name、age が順に埋め込まれます。\n は改行を表します。fmt.Println と違い、fmt.Printf は自動で改行を付けないため、必要に応じて明示します。

書式指定子 動作
%s 文字列を埋め込む
%d 整数を10進数で埋め込む
%f 浮動小数点数を埋め込む
%t 真偽値を埋め込む
%v 値の既定表現で埋め込む(型を問わず使える)
%T 値の型そのものを埋め込む

3. 文字列の組み立て(fmt.Sprintf)

fmt.Sprintf は、フォーマット付き文字列を「出力せずに文字列として返す」関数です。ログメッセージやエラーメッセージを組み立てるときによく使います。書き方は以下のとおりです。

文字列 := fmt.Sprintf("書式文字列", 引数1, 引数2, ...)

次のコードは、書式文字列に値を埋め込んで得た文字列を、あとから fmt.Println で表示する例です。

package main

import "fmt"

func main() {
    user := "Taro"
    resource := "reservations"
    msg := fmt.Sprintf("user=%s resource=%s created", user, resource)
    fmt.Println(msg)
}

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

user=Taro resource=reservations created

Sprintf で組み立てた文字列 user=Taro resource=reservations created が msg に入り、それを fmt.Println で表示した結果です。

コードを解説します。

msg := fmt.Sprintf("user=%s resource=%s created", user, resource)

fmt.Sprintf の書式指定子は fmt.Printf と同じで、出力先だけが「画面」ではなく「戻り値の文字列」になります。実際にはこの msg をログライブラリに渡す、あるいはエラーメッセージとして errors.New に渡す、といった使い方をします。

4. 独自の表示形式の定義(fmt.Stringer)

自分で定義した型を fmt.Println で表示したとき、既定では {field1 field2 ...} のような素っ気ない形式になります。表示形式を自作したい場合は、その型に String() string メソッドを実装します。fmt パッケージは表示時にこのメソッド(Goインタフェース で扱った interface の一種で fmt.Stringer と呼ばれる)を自動で呼び出します。書き方は以下のとおりです。

type 型名 struct { ... }

func (レシーバ 型名) String() string {
    return 表示したい文字列
}

次のコードは、User 型に String() を持たせて、fmt.Println の出力を自作する例です。

package main

import "fmt"

type User struct {
    Name string
    Age  int
}

func (u User) String() string {
    return fmt.Sprintf("<User %s(%d歳)>", u.Name, u.Age)
}

func main() {
    u := User{Name: "Taro", Age: 30}
    fmt.Println(u)
}

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

<User Taro(30歳)>

String() を持たせるだけで、fmt.Println の出力形式を <User Taro(30歳)> に切り替えられました。既定なら {Taro 30} と表示されるところが、任意の書式で表示できます。

コードを解説します。

func (u User) String() string {
    return fmt.Sprintf("<User %s(%d歳)>", u.Name, u.Age)
}

User 型に String() string メソッドを実装しています。この形(引数なし、戻り値 string)で String メソッドを持つ型は、fmt パッケージが表示時に自動でこのメソッドを呼び出してくれます。ログやデバッグ表示を分かりやすくするときの定番パターンです。