エラータイプ

Goaのエラータイプシステムを探索します。デフォルトのErrorResultタイプと、より複雑なエラーシナリオのためのカスタムエラータイプの作成方法を含みます。

Goaでは、デフォルトのErrorResultタイプまたはカスタムのユーザー定義タイプを使用してエラーを定義できます。適切なエラータイプの選択は、表現する必要のあるエラーの複雑さと特異性に依存します。

デフォルトのエラータイプ（`ErrorResult`）

デフォルトでは、エラーはErrorResultタイプを使用し、Name、ID、 Message、Temporary、Timeout、Faultなどの標準フィールドが含まれます。これにより、サービス全体で一貫したエラー構造が提供されます。

構造とフィールド

Name: DSLで定義されたエラーの名前。
ID: エラーの特定のインスタンスの一意の識別子。ログとトレースの相関に有用。
Message: 説明的なエラーメッセージ。
Temporary: エラーが一時的で、再試行により解決される可能性があるかを示す。
Timeout: エラーがタイムアウトによって引き起こされたかを示す。
Fault: エラーがサーバー側の障害によるものかを示す。

使用例

デフォルトのErrorResultを使用してサービスレベルのエラーを定義：


var _ = Service("divider", func() {
    Error("DivByZero", ErrorResult, "ゼロによる除算")
    Error("ServiceUnavailable", ErrorResult, "サービスは一時的に利用できません。", func() {
        Temporary()
    })
    // ...
})

この例では、dividerサービス内の任意のメソッドから返すことができる2つのサービスレベルのエラーを定義しています。DivByZeroエラーはゼロによる除算操作を表し、ServiceUnavailableエラーは一時的なサービス停止を示します。両方のエラーはデフォルトのErrorResultタイプを使用しますが、 ServiceUnavailableエラーはTemporary()関数を使用して一時的なものとしてマークされ、クライアントが操作を再試行できることを示します。

ランタイム表現

生成されたコードは、DivByZeroおよびServiceUnavailableエラーのための ServiceError オブジェクトをインスタンス化する関数を定義します。これらの関数は、エラーの適切なフィールドの設定を処理します：


// MakeDivByZeroは、エラーからgoa.ServiceErrorを構築します。
func MakeDivByZero(err error) *goa.ServiceError {
    return goa.NewServiceError(err, "DivByZero", false, false, false)
}

// MakeServiceUnavailableは、エラーからgoa.ServiceErrorを構築します。
func MakeServiceUnavailable(err error) *goa.ServiceError {
    return goa.NewServiceError(err, "ServiceUnavailable", true, false, false)
}

クライアントは、サービスから返されたエラーをServiceErrorタイプにキャストし、 Temporary、Timeout、Faultフィールドを使用してエラーの詳細を確認できます。

カスタムエラータイプ

より詳細なエラー情報のために、カスタムエラータイプを定義できます。これにより、アプリケーションのニーズに特化した追加フィールドを含めることができます。

カスタムエラータイプの作成

Type関数を使用してカスタムエラータイプを定義：


var DivByZero = Type("DivByZero", func() {
    Description("DivByZeroは、除数として0を使用した場合に返されるエラーです。")
    Field(1, "message", String, "ゼロによる除算のエラーメッセージ。")
    Field(2, "divisor", Int, "エラーの原因となった除数。")
    Required("message", "divisor")
})

サービスでのカスタムエラータイプの使用

カスタムエラータイプをサービスメソッド内に統合：


var _ = Service("divider", func() {
    Method("divide", func() {
        Payload(func() {
            Field(1, "dividend", Int)
            Field(2, "divisor", Int)
            Required("dividend", "divisor")
        })
        Result(func() {
            Field(1, "quotient", Int)
            Field(2, "remainder", Int)
            Required("quotient", "remainder")
        })
        Error("DivByZero", DivByZero, "ゼロによる除算")
        // 追加のメソッド定義...
    })
})

この例では、カスタムDivByZeroタイプを使用するDivByZeroというメソッドレベルのエラーを定義しています。これにより、ゼロによる除算シナリオに特化した詳細なエラー情報を提供でき、エラーメッセージとエラーの原因となった実際の除数値の両方を含めることができます。

カスタムエラータイプ使用時の注意点

エラーメタデータ: 同じメソッド内で複数のエラーにカスタムタイプを使用する場合、struct:error:nameメタデータを使用してエラー名を含む属性を指定する必要があります。これは、Goaがエラーを正しくその定義にマッピングするために不可欠です。


var CustomError = Type("CustomError", func() {
    Field(1, "detail", String)
    Field(2, "name", String, func() {
        Meta("struct:error:name")
    })
    Required("detail", "name")
})

予約された属性: カスタムエラータイプは、Goaがエラーの識別とシリアライゼーションのために内部的に使用するため、error_nameという名前の属性を持つことはできません。