Go言語入門：エラー処理

今日は、Golangでのエラーハンドリングについてご紹介します。

前提条件

前回の記事では、greetingsモジュール内のHello関数を呼び出すコードを記述した。

今回は、greetingsモジュールにエラーを返す処理を追加します。

そのため、下記の記事が実行できる環境にあることを前提にしています。

利用方法

作業ディレクトリを作成して、移動する。

mkdir 07_learn-golang-handle-errors
cd 07_learn-golang-handle-errors

asdfコマンドで使用するGolangのバージョンを指定します。

すでにGolangが実行できる状態にある方は、このコマンドをスキップしても問題ありません。

asdf local golang 1.20.5

前回の記事のソースコードを作業ディレクトリにコピーします。

cp -r ../06_learn-golang-use-my-module/greetings .
cp -r ../06_learn-golang-use-my-module/hello .    

以下のコードをgreetings.goファイルに貼り付け、ファイルを保存してください。

package greetings

import (
    "errors"
    "fmt"
)

// Hello returns a greeting for the named person.
func Hello(name string) (string, error) {
    // If no name was given, return an error with a message.
    if name == "" {
        return "", errors.New("empty name")
    }

    // If a name was received, return a value that embeds the name
    // in a greeting message.
    message := fmt.Sprintf("Hi, %v. Welcome!", name)
    return message, nil
}

以下のコードをhello.goファイルに貼り付け、ファイルを保存してください。

package main

import (
    "fmt"
    "log"

    "example.com/greetings"
)

func main() {
    // Set properties of the predefined Logger, including
    // the log entry prefix and a flag to disable printing
    // the time, source file, and line number.
    log.SetPrefix("greetings: ")
    log.SetFlags(0)

    // Request a greeting message.
    message, err := greetings.Hello("")
    // If an error was returned, print it to the console and
    // exit the program.
    if err != nil {
        log.Fatal(err)
    }

    // If no error was returned, print the returned message
    // to the console.
    fmt.Println(message)
}

helloディレクトリに移動して、hello.goを実行し、コードが動作することを確認します。

cd hello 
go run .

現状では、空の名前を渡しているので、エラーが出ます。下記のような結果になっていれば成功です。

% go run .
greetings: empty name
exit status 1

エラーを値として返すことで、呼び出し元がエラーをチェックできるようにするのが、Goの一般的なエラー処理になります。

次回は、ランダムで値を渡す例をご紹介したいと思います。

解説

hello.go

package main

import (
    "fmt"
    "log"

    "example.com/greetings"
)

func main() {
    // Set properties of the predefined Logger, including
    // the log entry prefix and a flag to disable printing
    // the time, source file, and line number.
    log.SetPrefix("greetings: ")
    log.SetFlags(0)

    // Request a greeting message.
    message, err := greetings.Hello("")
    // If an error was returned, print it to the console and
    // exit the program.
    if err != nil {
        log.Fatal(err)
    }

    // If no error was returned, print the returned message
    // to the console.
    fmt.Println(message)
}

以下に各行の解説を示します。

import (
    "fmt"
    "log"

    "example.com/greetings"
)

この部分では、必要なパッケージをインポートしています。fmt パッケージは、標準入出力などの基本的な操作を提供します。log パッケージは、ログメッセージの出力やエラーハンドリングに使用されます。そして、example.com/greetings パッケージは、あいさつメッセージを生成する関数 Hello を提供します。

func main() {
    log.SetPrefix("greetings: ")
    log.SetFlags(0)

main 関数は、プログラムのエントリーポイントです。最初の2行では、ログのプレフィックスとフラグを設定しています。プレフィックスは、ログメッセージの接頭辞です。ここでは “greetings: ” と設定されています。フラグは、ログメッセージに付加される情報の種類を制御します。0 に設定されているため、時間、ソースファイル、行番号は表示されません。

    message, err := greetings.Hello("")
    if err != nil {
        log.Fatal(err)
    }

次の行では、greetings.Hello 関数を呼び出して、あいさつメッセージをリクエストしています。引数として空の文字列 "" を渡しています。この関数は、message と err という2つの変数を返します。エラーが発生した場合は、err が nil ではなくなります。

エラーチェックのために、err 変数が nil ではないかを確認しています。もしエラーが発生していた場合、log.Fatal 関数を使ってエラーメッセージをログに出力し、プログラムを終了します。

    fmt.Println(message)
}

最後に、エラーが発生しなかった場合に、message 変数の値を標準出力に表示します。

以上が、このプログラムの構成と動作の概要です。基本的には、greetings パッケージからあいさつメッセージを取得し、エラーチェックを行って結果を表示するという流れです。

greetings.go

package greetings

import (
    "errors"
    "fmt"
)

// Hello returns a greeting for the named person.
func Hello(name string) (string, error) {
    // If no name was given, return an error with a message.
    if name == "" {
        return "", errors.New("empty name")
    }

    // If a name was received, return a value that embeds the name
    // in a greeting message.
    message := fmt.Sprintf("Hi, %v. Welcome!", name)
    return message, nil
}

以下に各行の解説を示します。

import (
    "errors"
    "fmt"
)

この部分では、必要なパッケージをインポートしています。errors パッケージは、エラーの生成や処理に使用されます。fmt パッケージは、文字列のフォーマットに使用されます。

func Hello(name string) (string, error) {
    if name == "" {
        return "", errors.New("empty name")
    }
    message := fmt.Sprintf("Hi, %v. Welcome!", name)
    return message, nil
}

Hello 関数は、引数として名前 name を受け取り、あいさつメッセージを返す関数です。

まず、引数の name が空の場合、"" となっているかどうかをチェックしています。もし空の場合は、errors.New 関数を使用してエラーを生成し、それを返します。エラーメッセージとしては “empty name” という文字列が使用されています。

もし name に値がある場合、fmt.Sprintf 関数を使ってメッセージを生成します。このメッセージは、name を埋め込んだあいさつメッセージです。例えば、name が “Alice” の場合、メッセージは “Hi, Alice. Welcome!” となります。

そして、生成されたメッセージと nil を返します。nil はエラーがないことを示します。

この関数は、引数として与えられた名前に基づいて、あいさつメッセージを生成します。もし空の名前が与えられた場合は、エラーが返されます。それ以外の場合は、あいさつメッセージと nil のエラーが返されます。

おわりに

今日は、Golangでエラーハンドリングする方法についてご紹介しました。

本記事で使用したコードは下記のリポジトリにあります。