ハンドラーメタデータ (HandlerMeta)

core.HandlerMetaは、リクエストに対応するコントローラーメソッドを実行するために必要な情報です。コントローラーの型、メソッド、パスパラメーターの順序、ルートインターセプターを保持します。アプリではapp.Routeでハンドラーを登録し、インターセプターでHandlerMetaを読み取って実行対象を確認できます。

このページの機能別 src/user の例は、プロジェクト構造で --layout legacy を指定して作成した my-app を使用します。CLI v0.4.0 の標準レイアウトは役割別の layered-v1 です。どちらも Spine v0.6.0 と Echo プラットフォーム v0.1.0 を使用します。

このページでは、Spine v0.6.0の公開型とHTTPの実行フローを基準に説明します。アプリでメタデータ生成関数やルーターの内部実装を直接作成する必要はありません。

CLIプロジェクトでの配置

CLIプロジェクト構造で作成したexample.com/my-appを基準に、ユーザールートはsrc/user/user_route.goのRegister(app)に宣言します。生成されるハンドラーは(*UserController).Getで、パスはGET /user/:idです。internal/application/application.goのBuildApplicationはuser.Register(app)のエラーを確認して返し、生成されたmain.goで検証と実行を進めます。

// src/user/user_route.go의 Register 내부 발췌
app.Route(
    "GET",
    "/user/:id",
    (*UserController).Get,  // 메서드 표현식
)

以下のGetUser、管理者ハンドラー、認証インターセプターは、概念を説明するためのアプリ拡張例です。CLIが生成するGetとは別のメソッドなので、そのまま追加するには対応する型とメソッドも実装する必要があります。インターセプターの完全な実装と登録方法は、インターセプターチュートリアルを参照してください。

HandlerMetaのフィールド

core.HandlerMetaのフィールドは次のとおりです。reflectの型を使ってコントローラーとメソッドの情報を表します。

// core/handler_meta.go
type HandlerMeta struct {
    // 컨트롤러 타입 (Container Resolve 대상)
    ControllerType reflect.Type

    // 호출할 메서드
    Method reflect.Method

    // 라우트에 선언된 경로 매개변수 키의 순서
    PathKeys []string

    // 핸들러에 적용된 인터셉터
    Interceptors []Interceptor
}

フィールド	型	役割
ControllerType	reflect.Type	依存性コンテナーから取得するコントローラーのポインター型
Method	reflect.Method	呼び出すメソッドの名前、シグネチャ、関数情報
PathKeys	[]string	ルートに宣言されたパスパラメーター名の順序
Interceptors	[]core.Interceptor	そのルートに適用するインターセプターの一覧

ControllerTypeが*UserControllerで、Method.NameがGetUserの場合、パイプラインはコンテナーから*UserControllerのインスタンスを取得してからGetUserを呼び出します。

meta.ControllerType  // reflect.Type of *UserController

meta.Method.Name           // "GetUser"
meta.Method.Type           // func(*UserController, path.Int) (httpx.Response[User], error)
meta.Method.Func           // 호출 가능한 reflect.Value

PathKeysは実際のリクエスト値ではなく、パスパラメーターの名前です。たとえば/users/:userId/orders/:orderIdではuserId、orderIdの順序を保持し、この順序に従ってハンドラーのpath型引数を対応付けます。リクエストごとに変わるパスパラメーターの値は、リクエストコンテキストから読み取ります。

Interceptorsにはルートインターセプターだけが入ります。app.Interceptorで登録したグローバルインターセプターは、パイプラインが別に管理します。

meta.Interceptors  // []core.Interceptor (라우트 레벨)

メソッド式でハンドラーを登録する

ルートには、(*UserController).GetUserのようなメソッド式を渡します。この式は特定のコントローラーインスタンスに結び付いていない関数で、最初の引数としてコントローラーのポインターを受け取ります。

// 메서드 표현식의 실제 타입
func(*UserController, path.Int) (httpx.Response[User], error)
//   ↑ receiver가 첫 번째 인자로 변환됨

Spineはこの情報から、コントローラーの型と呼び出すメソッドを確認します。コントローラーのインスタンスは、アプリのコンストラクタ登録に従って依存性コンテナーから取得します。

次の登録形式を区別してください。

登録形式	使用可否	説明
(*UserController).GetUser	使用する	最初の引数が*UserControllerであるメソッド式
UserController.GetUser	使用しない	値型を最初の引数に取るため、ポインター型という条件を満たさない
ctrl.GetUser	使用しない	特定のインスタンスに結び付いたメソッド値なので、コントローラー引数を別に受け取らない
通常の関数またはクロージャー	使用しない	コントローラーの型とメソッドを確認する登録形式に合わない

この条件は、ルートに渡す式の形式に関するものです。アプリのコントローラーはチュートリアルのようにポインターレシーバーで作成し、(*Controller).Methodの形式で登録してください。

ルートインターセプターを指定する

route.WithInterceptorsは、そのルートに適用するインターセプターを受け取ります。github.com/NARUBROWN/spine/pkg/routeをインポートして使用します。

app.Route(
    "GET",
    "/users/:id",
    (*UserController).GetUser,
    route.WithInterceptors(&AuthInterceptor{}),
)

インターセプターを渡す方法は2つあります。

渡す値	生成方法
&AuthInterceptor{}	アプリが作成したインスタンスをそのまま使用
(*AuthInterceptor)(nil)	ブートストラップ中にコンテナーでそのポインター型のインスタンスを生成

依存性の注入が必要なインターセプターには、型付きのnilポインターを使用できます。この場合、インターセプターのコンストラクタと必要な依存性を登録する必要があります。型情報のないnilを渡すと、ルートインターセプターの登録に失敗します。

// src/user/user_route.go의 Register 내부 발췌
app.Route("GET", "/users/:id", (*UserController).GetUser)

// 라우트 인터셉터와 함께
app.Route("GET", "/admin/users/:id", (*AdminController).GetUser,
    route.WithInterceptors((*AuthInterceptor)(nil)),  // nil 포인터 → Container에서 Resolve
)

グローバルインターセプターとルートインターセプターを併用することもできます。グローバルインターセプターはすべてのリクエストに適用され、ルートインターセプターはそのルートだけに適用されます。

// 글로벌: 모든 요청에 적용 (라우팅 전 실행)
app.Interceptor(&CORSInterceptor{})

// 라우트: 특정 핸들러에만 적용 (라우팅 후, Controller 호출 전 실행)
app.Route("GET", "/admin/:id", (*AdminController).Get,
    route.WithInterceptors(&AuthInterceptor{}),
)

インターセプターで実行対象を確認する

インターセプターのPreHandle、PostHandle、BeforeResponse、AfterCompletionはHandlerMetaを受け取ります。ログの記録やハンドラーごとのポリシー適用に、この情報を利用できます。

グローバルのPreHandleはルーティング前に実行されるため、空のHandlerMetaを受け取ります。このときControllerTypeはnilで、Method.Nameも空です。ルートが決まった後は実際のハンドラーメタデータが渡されますが、ルーティング自体に失敗したリクエストでは実行対象が存在しない場合があります。フィールドにアクセスする前に確認してください。

次のコードは、PreHandleだけを抜粋した例です。coreとlogをインポートして使用します。登録可能なインターセプターには、残りの3つのメソッドも実装する必要があります。

// src/interceptor/logging_interceptor.go
func (i *LoggingInterceptor) PreHandle(ctx core.ExecutionContext, meta core.HandlerMeta) error {
    controllerName := "<unresolved>"
    if meta.ControllerType != nil {
        controllerName = meta.ControllerType.String()
    }
    log.Printf(
        "[REQ] %s %s -> %s.%s",
        ctx.Method(),
        ctx.Path(),
        controllerName,
        meta.Method.Name,            // "GetUser"
    )
    return nil
}

このように、core.ExecutionContextはインターセプターからリクエスト情報にアクセスするために使用します。HTTPコントローラーが同じ型を引数に取る必要はありません。コントローラーでは、型に基づく引数の注入に対応するリクエスト型を宣言してください。

登録時とリクエスト実行時

ブートストラップでは、ルート宣言から実行情報を準備します。

1. app.Routeに宣言したハンドラーから、コントローラーの型とメソッドを確認します。
2. ルートインターセプターを準備し、HandlerMetaに関連付けます。
3. 完全なパスとパスパラメーターの順序をルーターに登録します。
4. 登録されたコントローラーと依存性を事前に生成します。

ハンドラーの形式が誤っている場合や、コントローラー、インターセプターの依存性を生成できない場合は、サーバーの起動処理で失敗します。生成されたプロジェクトのエラーを返す経路を維持し、この失敗を呼び出し元に伝えてください。

リクエストを受け取ると、準備したメタデータを次の順序で使用します。

1. グローバルインターセプターのPreHandleを実行します。
2. リクエストに対応するルートを探し、HandlerMetaを取得します。
3. メソッドのパラメーター型とPathKeysに従って引数を準備します。
4. ルートインターセプターのPreHandleを実行します。
5. コントローラーのインスタンスを取得し、メソッドを呼び出します。
6. 戻り値の処理とレスポンス前の処理を行い、レスポンスを送信します。

正常に実行された場合のフローは次のとおりです。エラーやインターセプターからの中断要求が発生すると、後続の段階が省略される場合があります。

成功したリクエストのPostHandleは、ルートインターセプター、グローバルインターセプターの順に実行し、それぞれの一覧内では登録の逆順で呼び出します。BeforeResponseとAfterCompletionのエラー処理と実行条件は、インターセプターチュートリアルで確認してください。

エラーの確認箇所

状況	確認する内容
ハンドラーの登録に失敗	(*Controller).Methodの形式か、対象のメソッドが見つかるかを確認
コントローラーの生成に失敗	コントローラーのコンストラクタと、そのコンストラクタが受け取る依存性を登録したか確認
ルートインターセプターの生成に失敗	型付きのnilポインターを使用したか、必要なコンストラクタを登録したか確認
リクエスト引数の準備に失敗	ハンドラーの引数型がサポートされているか、パスパラメーターの宣言順序が正しいか確認
一致するルートがない	HTTPメソッド、パス、グローバルパスプレフィックスを確認。標準のHTTP処理では404エラーレスポンスを返す

HandlerMetaはハンドラーの実行対象を表します。リクエストデータの変換は引数リゾルバーが、実際の戻り値からHTTPレスポンスへの変換は戻り値ハンドラーが担当します。それぞれの役割を直接置き換えようとする前に、ルート宣言とコントローラーのシグネチャを確認してください。