【Go言語】ベンチマークテストの解説＆練習問題｜Go言語で関数の効率を測るベンチマーク｜【完全無料】初心者のためのプログラミングテキスト＆問題集

Go言語の初心者向け問題4-12：ベンチマークテストを理解しよう

この問題を解くために必要な知識：
レベル１～３の知識、メモリ管理の基本、エラーハンドリングとカスタムエラー、チャネルの選択、タイムアウト処理、パッケージ、init関数、ファイル操作、エンコーディングとデコーディング、テストの書き方、ベンチマークテスト、ドキュメントの生成

<<前の問題

問題集Top

次の問題>>

Go言語の文法「ベンチマークテスト」とは

ここではベンチマークテストの意味や使い方を復習します。必要ない方はここをクリックして練習問題へ飛びましょう。

ベンチマークテストは、コードのパフォーマンスを評価するための重要なツールであり、特にコードがどれくらい効率的に動作するかを知るために役立ちます。

ベンチマークテストとは？

ベンチマークテストは、関数や処理の実行速度を測定するためのテストです。

Go言語では、このテストを簡単に作成することができ、どの部分がボトルネックになっているのかを特定するのに有効です。

ベンチマークテストの書き方

ベンチマークテストは、通常のGoのテストファイル（*_test.go）に記述します。

テスト関数と同様に、ベンチマーク関数も特定のフォーマットに従って書く必要があります。

以下に基本的なベンチマークテストの例を示します。

package main

import (
    "testing"
)

// テスト対象の関数
func add(a, b int) int {
    return a + b
}

// ベンチマークテスト関数
func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        add(1, 2)
    }
}

このコードは、add関数の実行速度を測定するためのベンチマークテストです。b.Nは、ベンチマーク実行時に自動的に設定され、関数が指定回数実行されます。

ベンチマークテストの実行方法

ベンチマークテストを実行するには、以下のコマンドをターミナルで入力します。

go test -bench=.

このコマンドでベンチマークテストが実行され、結果が表示されます。結果には、関数の実行にかかった平均時間などが含まれ、パフォーマンスの評価ができます。

まとめ

ベンチマークテストは、Goプログラムのパフォーマンスを分析するための強力な手段です。

これを使えば、最適化が必要な箇所を特定し、効率的なコードを書くための改善が行えます。

Go練習問題4-12：JSONデコードとベンチマークテストを学ぼう

ベンチマークテストを学ぶために、JSONデコード処理とベンチマークテストを組み合わせたプログラムを作成しましょう。

このプログラムでは、JSONデータをデコードし、ベンチマークテストを使ってadd関数の性能を測定します。

プログラムの各部分を理解しながら、ベンチマークテストの使い方を身に付けましょう。

この問題の要件

以下の要件に従ってコードを完成させてください。

以下のインポート文を使用して、必要なパッケージをインポートすること:
- import "encoding/json"
- import "fmt"
- import "testing"
Personという構造体を定義し、Name（文字列型）とAge（整数型）のフィールドを持たせること。
JSONデータをデコードする関数decodePersonを作成し、json.Unmarshalを使用してJSONデータをPerson構造体にデコードすること。
2つの整数を足し合わせるadd関数を作成し、2つの整数の和を返すこと。
add関数の性能をベンチマークテストで測定するため、BenchmarkAdd関数を作成すること。
メイン関数で、JSON文字列をPerson構造体にデコードし、その結果を画面に表示すること。
ベンチマークテストを実行して、add関数の性能を測定すること。

ただし、以下のような実行結果となるコードを書くこと。

*****↓↓正解コードの実行結果の例↓↓*****

$ go run main.go
名前: 太郎, 年齢: 30

この問題を解くヒント

１からコードを組み立てることが難しい場合は、以下のヒントを開いて参考にしましょう。

ヒント１【コードの構成を見る】

正解のコードは上から順に以下のような構成となっています。

１．import文
　1-1. encoding/jsonパッケージのインポート
　1-2. fmtパッケージのインポート
　1-3. testingパッケージのインポート

２．Person構造体の定義
　2-1. Nameフィールド（文字列型）
　2-2. Ageフィールド（整数型）

３．decodePerson関数の定義
　3-1. 引数としてJSONデータ（バイト配列）を受け取る
　3-2. json.Unmarshalを使用して、JSONデータをPerson構造体にデコード
　3-3. デコード結果またはエラーを返す

４．add関数の定義
　4-1. 2つの整数を引数として受け取る
　4-2. 2つの整数の和を計算して返す

５．BenchmarkAdd関数の定義
　5-1. testing.B型の引数を受け取る
　5-2. ベンチマークループでadd関数を複数回実行し、性能を測定

６．main関数
　6-1. JSON形式の文字列を定義
　6-2. JSON文字列をバイト配列に変換
　6-3. decodePerson関数を使ってバイト配列をデコード
　6-4. デコード結果を画面に表示
　6-5. デコードに失敗した場合、エラーメッセージを表示

ヒント２【穴埋め問題にする】

以下のコードをコピーし、コメントに従ってコードを完成させて下さい。

package main

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

// データ構造体の定義
type Person struct {
    Name string
    Age  int
}

// JSONデータをデコードする関数
func decodePerson(data []byte) (Person, error) {
    /* 【穴埋め問題１】
    ここにjson.Unmarshalを使ってJSONデータをPerson構造体にデコードするコードを書いてください。
    */
}

// シンプルな関数：2つの整数を足し合わせる
func add(a, b int) int {
    /* 【穴埋め問題２】
    ここに2つの整数の和を計算して返すコードを書いてください。
    */
}

// ベンチマークテスト：add関数の性能をテスト
func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        /* 【穴埋め問題３】
        ここにadd関数を呼び出すコードを書いてください。
        */
    }
}

func main() {
    // デコードするJSON文字列
    jsonString := `{"Name": "太郎", "Age": 30}`

    // JSON文字列をバイト配列に変換
    jsonData := []byte(jsonString)

    // JSONデコードの実行
    person, err := decodePerson(jsonData)
    if err != nil {
        fmt.Println("デコードエラー:", err)
    } else {
        fmt.Printf("名前: %s, 年齢: %d\n", person.Name, person.Age)
    }
}

このヒントを見てもまだ回答を導き出すのが難しいと感じる場合は、先に正解のコードと解説を見て内容を理解するようにしましょう。

解答例と解説

この問題の一つの正解例とそのコードの解説を以下に示します。

正解コードの例

例えば以下のようなプログラムが考えられます。

package main

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

// データ構造体の定義
type Person struct {
    Name string
    Age  int
}

// JSONデータをデコードする関数
func decodePerson(data []byte) (Person, error) {
    var p Person
    err := json.Unmarshal(data, &p)
    return p, err
}

// シンプルな関数：2つの整数を足し合わせる
func add(a, b int) int {
    return a + b
}

// ベンチマークテスト：add関数の性能をテスト
func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        add(1, 2)
    }
}

func main() {
    // デコードするJSON文字列
    jsonString := `{"Name": "太郎", "Age": 30}`

    // JSON文字列をバイト配列に変換
    jsonData := []byte(jsonString)

    // JSONデコードの実行
    person, err := decodePerson(jsonData)
    if err != nil {
        fmt.Println("デコードエラー:", err)
    } else {
        fmt.Printf("名前: %s, 年齢: %d\n", person.Name, person.Age)
    }
}

正解コードの解説

インポート文

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

この部分では、Go言語でJSONデータのエンコード/デコード、文字列やデータのフォーマット、そしてベンチマークテストを行うためのパッケージをインポートしています。

encoding/json: JSONデータのエンコードやデコードに使用します。
fmt: フォーマットされたI/Oを行うための標準パッケージです。fmt.Printlnやfmt.Printfを使って出力します。
testing: Goでのテストやベンチマークを行うためのパッケージです。

`Person`構造体の定義

type Person struct {
    Name string
    Age  int
}

この部分では、Personという名前の構造体を定義しています。Person構造体は、Name（文字列型）とAge（整数型）という2つのフィールドを持っています。

構造体は複数の異なる型のデータを一つにまとめることができるデータ型です。

JSONデコード関数 `decodePerson`

decodePerson関数は、JSON形式のバイトデータをPerson構造体にデコードします。

json.Unmarshalを使って、JSONデータをPerson型の変数に変換し、結果を返します。この関数はデコードに失敗した場合にエラーを返します。

2つの整数を足し合わせる関数 `add`

func add(a, b int) int {
    return a + b
}

add関数は、2つの整数を受け取り、それらを足し合わせた結果を返します。

この関数はとてもシンプルで、基本的な算術演算を行うだけですが、プログラム内で繰り返し利用できるという利点があります。

ベンチマークテスト `BenchmarkAdd`

func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        add(1, 2)
    }
}

BenchmarkAdd関数は、add関数の性能を測定するためのベンチマークテストを実行します。testing.B型の引数を受け取り、b.N回のループでadd関数を実行します。

ベンチマークテストはコードの効率性を確認するために重要で、特に高頻度で呼び出される関数の最適化を考える際に役立ちます。

メイン関数 `main`

func main() {
    jsonString := `{"Name": "太郎", "Age": 30}`
    jsonData := []byte(jsonString)
    person, err := decodePerson(jsonData)
    if err != nil {
        fmt.Println("デコードエラー:", err)
    } else {
        fmt.Printf("名前: %s, 年齢: %d\n", person.Name, person.Age)
    }
}

main関数は、プログラムのエントリーポイントです。ここでは、まずJSON形式の文字列を定義し、それをバイト配列に変換してdecodePerson関数に渡します。

デコードが成功した場合、Person構造体のフィールドを出力し、エラーが発生した場合はエラーメッセージを表示します。

<<前の問題

問題集Top

次の問題>>