Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 10141] ファイルの概要

このコミットは、Go言語の標準ライブラリであるcrypto/tlsパッケージ内のalert型にError()メソッドを追加するものです。これにより、alert型がGo言語の組み込みerrorインターフェースを満たすようになり、TLSアラートが値としてもエラーとしてもより自然に扱えるようになります。

コミット

commit 01e9a227cc8f8e0d0ffea239f6c601259a6db908
Author: Russ Cox <rsc@golang.org>
Date:   Thu Oct 27 19:42:32 2011 -0700

    crypto/tls: add Error method to alert
    
    alerts get used as both values and errors.
    Rather than introduce an alertError wrapper,
    this CL just adds an Error method, which will
    satisfy the error interface when the time comes.
    
    R=agl, bradfitz
    CC=golang-dev
    https://golang.org/cl/5294073
---
 src/pkg/crypto/tls/alert.go | 4 ++++\n 1 file changed, 4 insertions(+)\n

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/01e9a227cc8f8e0d0ffea239f6c601259a6db908

元コミット内容

crypto/tlsパッケージのalert型にErrorメソッドを追加します。 alertは値としてもエラーとしても使用されるため、alertErrorというラッパー型を導入する代わりに、Errorメソッドを追加することで、alert型が将来的にerrorインターフェースを満たすようにします。

変更の背景

Go言語では、エラーハンドリングは非常に重要な概念であり、errorという組み込みインターフェースを通じて行われます。このコミットの背景には、crypto/tlsパッケージ内で定義されているalert型が、その性質上「値」として扱われる場合と、「エラー」として扱われる場合の両方があるという状況がありました。

具体的には、TLSプロトコルにおいて、アラートメッセージは通信の正常な終了や、エラー状態の通知など、様々な目的で送信されます。このアラートメッセージをGoのコード内で表現するalert型は、単なるデータ構造（値）として扱われることもあれば、何らかの問題が発生したことを示すエラーとして伝播される必要もありました。

コミットメッセージにある「Rather than introduce an alertError wrapper」という記述は、この状況に対する設計上の選択を示しています。もしalert型を直接errorインターフェースとして扱えない場合、通常はalert型をラップする新しいエラー型（例えばalertErrorのようなもの）を定義し、そのラッパー型がerrorインターフェースを満たすように実装するというアプローチが考えられます。しかし、このコミットでは、そのようなラッパーを導入するのではなく、既存のalert型自体にError()メソッドを追加することで、alert型が直接errorインターフェースを満たすようにする、という方針が採られました。

この選択のメリットは、コードの複雑さを軽減し、alert型を扱う際に余分な型変換やラッパーのアンラップが不要になる点にあります。alert型が直接errorインターフェースを満たすことで、Goのエラーハンドリングの慣習に沿った形で、TLSアラートをエラーとして扱うことが可能になります。

前提知識の解説

Go言語におけるエラーハンドリング

Go言語のエラーハンドリングは、他の多くの言語とは異なり、例外機構（try-catchなど）を使用しません。代わりに、関数がエラーを返す場合は、戻り値の最後の要素としてerror型の値を返します。

errorインターフェースはGo言語の組み込みインターフェースであり、以下のように定義されています。

type error interface {
    Error() string
}

このインターフェースは、Error() stringという単一のメソッドを持ちます。任意の型がこのError() stringメソッドを実装していれば、その型はerrorインターフェースを満たしているとみなされます。

エラーが発生しなかった場合は、nil（Goにおけるnull値）が返されます。関数を呼び出した側は、返されたerror値がnilかどうかをチェックすることで、処理が成功したか失敗したかを判断します。

カスタムエラーの作成: Goでは、errors.New関数を使ってシンプルなエラーメッセージを作成したり、fmt.Errorf関数を使ってフォーマットされたエラーを作成したりできます。しかし、より詳細な情報を持つエラーや、特定のエラータイプを区別したい場合には、カスタムエラー型を定義するのが一般的です。カスタムエラー型は、構造体として定義し、その構造体にError() stringメソッドを実装することで作成します。

package main

import (
	"fmt"
)

// MyCustomError はカスタムエラー型を定義します
type MyCustomError struct {
	Code    int
	Message string
}

// Error は error インターフェースを実装します
func (e *MyCustomError) Error() string {
	return fmt.Sprintf("Error %d: %s", e.Code, e.Message)
}

func doSomething(value int) error {
	if value < 0 {
		return &MyCustomError{Code: 1001, Message: "Value cannot be negative"}
	}
	return nil
}

func main() {
	err := doSomething(-5)
	if err != nil {
		fmt.Println("Operation failed:", err)

		// 型アサーションを使って特定のエラーをチェック
		if customErr, ok := err.(*MyCustomError); ok {
			fmt.Println("Custom error code:", customErr.Code)
		}
	}
}

このコミットでは、まさにこのカスタムエラーの考え方を利用して、既存のalert型がerrorインターフェースを満たすように変更しています。

crypto/tlsパッケージ

crypto/tlsはGo言語の標準ライブラリの一部であり、TLS (Transport Layer Security) プロトコルを実装しています。TLSは、インターネット上で安全な通信を行うための暗号化プロトコルであり、ウェブブラウジング（HTTPS）、電子メール、その他のデータ通信など、幅広いアプリケーションで使用されています。

このパッケージは、TLSクライアントとサーバーの実装を提供し、証明書の検証、鍵交換、データの暗号化と復号化などの機能を提供します。

alert型

crypto/tlsパッケージにおけるalert型は、TLSプロトコルにおける「アラートメッセージ」を表す型です。TLSプロトコルでは、通信中にエラーや警告などの特定のイベントを相手に通知するためにアラートメッセージが使用されます。例えば、通信の終了（close_notify）、不正なレコードの受信（bad_record_mac）、証明書の問題（bad_certificate）など、様々な種類のアラートが存在します。

alert型は、これらのアラートの種類を識別するための数値（バイト値）を内部に持ち、そのアラートがどのような意味を持つかを表現します。このコミット以前は、alert型は主にその値を表現するための型として機能していましたが、このコミットによってエラーとしての側面も持つようになりました。

技術的詳細

このコミットの技術的な核心は、crypto/tlsパッケージ内のalert型が、Go言語のerrorインターフェースを実装するように変更された点にあります。

TLSプロトコルにおいて、アラートは単なる情報伝達の手段であるだけでなく、通信の異常終了やエラー状態を示す重要なシグナルでもあります。そのため、Goのコードベースでalert型を扱う際、時にはその値を直接参照する必要があり（例えば、特定のアラートの種類を識別するため）、またある時には、それがエラーとして処理されるべき状況を示す必要がありました。

コミットメッセージにある「alerts get used as both values and errors」という記述は、この二重の役割を明確に示しています。

この状況に対し、開発チームは2つの主要な選択肢を検討したと考えられます。

  1. alertErrorのようなラッパー型を導入する: alert型を直接errorインターフェースに変換するのではなく、alert型を内部に持つ新しい構造体alertErrorを定義し、このalertErrorがerrorインターフェースを満たすようにError()メソッドを実装する方法です。この場合、alertがエラーとして扱われる必要がある場面では、明示的にalertError型にラップして使用することになります。
  2. alert型自体にError()メソッドを追加する: 既存のalert型に直接Error() stringメソッドを追加し、alert型がGoのerrorインターフェースを直接満たすようにする方法です。

このコミットでは、後者のアプローチが採用されました。その理由は、コミットメッセージに「Rather than introduce an alertError wrapper, this CL just adds an Error method, which will satisfy the error interface when the time comes.」と明記されています。

この選択のメリットは以下の通りです。

  • 簡潔性: alert型自体がerrorインターフェースを満たすため、alertをエラーとして扱う際に余分なラッパー型を導入したり、そのラッパー型と元のalert型との間で変換を行ったりする必要がなくなります。これにより、コードがより簡潔になり、可読性が向上します。
  • 一貫性: alertが値としてもエラーとしても同じ型で表現されるため、コード全体でのalertの扱いが一貫します。
  • Goのイディオムへの適合: Go言語では、カスタムエラーを定義する際に、既存の型にError()メソッドを追加してerrorインターフェースを満たさせるのが一般的なイディオムです。この変更は、そのイディオムに沿ったものです。

結果として、alert型は、その値（例えばalertBadCertificate）として直接使用できるだけでなく、関数からerror型の戻り値として返されたり、if err != nilのようなエラーチェックの文脈で直接扱われたりすることが可能になりました。これにより、crypto/tlsパッケージのエラーハンドリングがより自然でGoらしいものになります。

コアとなるコードの変更箇所

変更はsrc/pkg/crypto/tls/alert.goファイルに対して行われました。

--- a/src/pkg/crypto/tls/alert.go
+++ b/src/pkg/crypto/tls/alert.go
@@ -71,3 +71,7 @@ func (e alert) String() string {
 	}\n 	return "alert(" + strconv.Itoa(int(e)) + ")"\n }\n+\n+func (e alert) Error() string {\n+\treturn e.String()\n+}\n

追加されたのは以下の4行です。

func (e alert) Error() string {
	return e.String()
}

コアとなるコードの解説

追加されたコードは、alert型にError()メソッドを実装しています。

func (e alert) Error() string {
	return e.String()
}
  • func (e alert) Error() string: これは、alert型に対するメソッド定義です。レシーバーeはalert型の値であり、このメソッドは文字列を返します。このシグネチャは、Go言語の組み込みerrorインターフェースの要件を正確に満たしています。
  • return e.String(): この行がError()メソッドの具体的な実装です。ここでは、alert型が既に持っていたString()メソッドを呼び出し、その戻り値をそのまま返しています。

alert型には、既にString()メソッドが定義されていました。このString()メソッドは、alertの数値表現を人間が読める形式の文字列（例: "alert(40)" for alertHandshakeFailure）に変換する役割を担っていました。

Error()メソッドの実装で既存のString()メソッドを再利用することで、以下のメリットがあります。

  • コードの重複排除: alertの文字列表現ロジックがString()メソッドに一元化されているため、Error()メソッドで同じロジックを再度記述する必要がありません。
  • 一貫性のあるエラーメッセージ: alertがエラーとして扱われる場合でも、その文字列表現はString()メソッドによって生成されるため、通常の文字列表現とエラーメッセージの間で一貫性が保たれます。これにより、デバッグやログの解析が容易になります。

このシンプルな追加により、alert型の値は、Goのエラーハンドリングメカニズムにシームレスに統合されるようになりました。例えば、crypto/tlsパッケージ内の関数がTLSアラートを検出した場合、そのalert型の値を直接error型の戻り値として返すことができるようになります。呼び出し側は、通常のif err != nilチェックでこのアラートを捕捉し、必要に応じてそのエラーメッセージ（err.Error()）を取得できるようになります。

関連リンク

参考にした情報源リンク