Goメモ-358 (fmt.Stringerとfmt.GoStringer)(%v, %+v, %#v, %s)

関連記事

GitHub - devlights/blog-summary: ブログ「いろいろ備忘録日記」のまとめ

概要

以下、自分用のメモです。よく忘れるのでここにメモメモ。。。

Go言語 100Tips ありがちなミスを把握し、実装を最適化する (impress top gear)

上記の書籍に fmt.Stringer と fmt.GoStringer インターフェースを使って機密情報をロギングするのを防ぐというTipsが載っていました。

そういえば、fmt.GoStringerってインターフェースがあったなーって思い出したので、ついでに自分用のサンプルをここにメモメモ。。。

試してみた

package formatting

import (
    "encoding/json"
    "fmt"
    "strconv"
)

type _MyInt int

func (me _MyInt) String() string {
    return fmt.Sprintf("stringer: %d", me)
}

func (me _MyInt) GoString() string {
    return fmt.Sprintf("gostring: %d", me)
}

// StringerAndGoStringer は、fmt.Stringerとfmt.GoStringerについてのサンプルです.
//
// # REFERENCES
//   - https://pkg.go.dev/fmt@go1.21.4#Stringer
//   - https://pkg.go.dev/fmt@go1.21.4#GoStringer
func StringerAndGoStringer() error {
    //
    // fmt.Stringer と fmt.GoStringer の違い
    //
    // どちらも文字列表現のためのインターフェースであるが
    // fmt.GoStringerの方は GoString() を呼ばれた場合に発動する.
    // これは、fmt.Printf などで %#v を利用してフォーマットしようとする際に使われる
    //

    var (
        i    = _MyInt(100)
        s    = strconv.Itoa((int)(i))
        b, _ = json.Marshal(i)
    )

    fmt.Printf("v: %v\t+v: %+v\t#v: %#v\tjson: %s\ts: %s", i, i, i, b, s)

    return nil
}

実行すると以下のようになります。

$ task
task: [run] ./try-golang -onetime

ENTER EXAMPLE NAME: formatting_stringer_and_gostringer

[Name] "formatting_stringer_and_gostringer"
v: stringer: 100        +v: stringer: 100       #v: gostring: 100       json: 100       s: 100

[Elapsed] 54.79µs

%v, %+v のときは fmt.Stringer, %#v のときは fmt.GoStringer が反応していますね。

参考情報

• Documentation - The Go Programming Language
• GitHub - golang-standards/project-layout: Standard Go Project Layout

Goのおすすめ書籍

初めてのGo言語 ―他言語プログラマーのためのイディオマティックGo実践ガイド

実用 Go言語 ―システム開発の現場で知っておきたいアドバイス

エキスパートたちのGo言語　一流のコードから応用力を学ぶ Software Design plus

Go言語による並行処理

100 Go Mistakes and How to Avoid Them

上の書籍の日本語版が下です。

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ

Goならわかるシステムプログラミング 第2版

---

過去の記事については、以下のページからご参照下さい。

• ブログ 「いろいろ備忘録日記」の記事まとめ | ブログ「いろいろ備忘録日記」のまとめ

サンプルコードは、以下の場所で公開しています。

• GitHub - devlights/try-golang: This is my TUTORIAL project for golang.
• GitHub - devlights/try-python: This is my TUTORIAL project for Python.
• GitHub - devlights/try-csharp: This is my TUTORIAL project for C#.