プレゼンテーション層⚓︎

プレゼンテーション層で実装するべき共通処理の詳細を示します。

入力チェック ( 単項目チェックと項目間チェック )⚓︎

全体処理方式の入力値検査方針で説明した通り、プレゼンテーション層では入力値に対する単項目チェックと項目間チェックを実装します。単項目チェックと項目間チェックを通じて、 Web API の入力値が正しい形式であるか確認します。

単項目チェック⚓︎

単項目チェックは Bean Validation を用いて実装します。 API モデルに対してアノテーションを付与し、チェックルールを定義します。実装方法についてはこちらを参照してください。

Hibernate Validator であらかじめ実装されているチェックルールはこちらを参照してください。単項目チェックの多くは、これらの実装済みチェックルールを利用するだけで検証を行えます。既存のチェックルールでは実現できない場合は、こちらを参照してカスタムルールを実装します。

単項目チェックは、コントローラーの引数である API モデルに対して一律実行されるように実装します。

項目間チェック⚓︎

Hibernate Validator で定義済みのチェックルールは、項目間のデータの整合性を確認する目的には利用できません。そのため、項目間チェック処理は独自の実装が必要です。

項目間チェックの実装は、以下の 2 通りの方法があります。

コントローラーの処理の中で実装する
Bean Validation のカスタムルールとして実装する

項目間チェックをコントローラー内に実装してしまうと、同じような項目間チェックがある場合に再利用ができません。汎用的なチェックルールは Bean Validation のカスタムルールとして実装することを推奨します。

汎用的でないチェックルールは、どちらの方法で実装してもかまいません。 Bean Validation のカスタムルールで実装すると処理方式の統一が図れる半面、カスタムルールの実装は若干煩雑です。

例外ハンドリング⚓︎

業務例外は、業務ロジックに従って適切な層でハンドリングします。どの層でハンドリングするかは業務ロジックに依存し、統一した取り扱いは行いません。

プレゼンテーション層まででハンドリングされなかった業務例外やシステム例外は、集約例外ハンドラーで処理します。

集約例外ハンドラーの実装⚓︎

集約例外ハンドラーは Spring Framework の @ControllerAdvice を利用して実装します。 @ControllerAdvice はコントローラーの共通処理を定義できるもので、例外ハンドリングの実装もサポートしています。集約例外ハンドラーで実装すべき内容は以下の通りです。

エラーログの出力

例外情報からメッセージを生成し、アプリケーションログを出力します。出力先や出力内容はログ出力方針に従います。

エラーレスポンスの生成

Web API のエラーレスポンスは、 RFC9457 に準拠した形式で返却します。

HTTP ステータスコードは発生したエラーの種類に応じて使い分けます。エラーレスポンスに使用する代表的な HTTP ステータスコードは以下の通りです。

エラーステータスコード	利用シーン
400 Bad Request	リクエストデータの構造エラー・入力値検証エラー・業務エラーが発生したとき。
404 Not Found	リクエストされたリソースが見つからないとき。
409 Conflict	リソースで競合が発生し、正常に処理できないとき。
500 Internal Server Error	予期しないエラー ( システムエラー ) が発生したとき。