ユーザ入力のチェック

最初に、アノテーション @mandatory を使用します。@mandatory とマークされた要素が空でない入力がないかチェックされます。null および (トリムされた) 空の文字列は拒否されます。

この例では、Books エンティティの title エレメントにアノテーション @mandatory が付いています。タイトルなしでブックを作成しようとすると、対応する要求により HTTP ステータスコード 400 (Bad Request) の応答が返されます。応答には、以下のようなエラーメッセージが含まれます。

123456
"error": {
  "code": "400",
  "message": "Value is required",
  "target": "title",
  "@Common.numericSeverity": 4
}

@assert.target アノテーションは、CDS モデルエンティティの管理対象 1 対 1 アソシエーションに使用できます。このアノテーションは、CREATE および UPDATE 操作中に、アソシエーションが参照するターゲットエンティティが存在するかどうかをチェックするために使用されます。つまり、このアノテーションを使用して、テーブル内の非 Null 外部キーに、関連付けられた/参照されるターゲットテーブルに対応する 1 次キーがあることを確認します。

この例では、Books エンティティの管理対象 1 アソシエーション作成者は、@mandatory および @assert.target のアノテーションが付けられています。@mandatory アノテーションにより、ブック作成者が指定されます。@assert.target アノテーションでは、指定された作成者が存在するかどうかもチェックされます。

新しいブックを作成しようとして、要求で指定された作成者 ID がデータベースに存在しない場合、要求された CREATE 操作は実行されません。代わりに、HTTP 応答のステータスコードは 400 (Bad Request) です。これは、アノテーション @mandatory ですでに確認されているためです。応答本文には、以下のようなエラーメッセージが含まれます。無効な外部キーを指し示しています。

123456
"error": {
  "code": "400",
  "message": "Value doesn't exist",
  "target": "author_ID",
  "@Common.numericSeverity": 4
}

@assert.range アノテーションでは、序数タイプのモデルエンティティのエレメント (数値または日付/時刻タイプ) の値範囲を指定することができます。値範囲は、以下の構文の間隔として定義されます。

1
@assert.range: [min, max]

定義された範囲は閉じた間隔と見なされます。つまり、指定した値が最小以上かつ最大以下であるかどうかがチェックされます。

enum エレメントの場合、true を指定すると、定義された列挙値に入力可能な値を制限することができます。

この例では、Books エンティティのジャンルエレメントのデータ型は Genre であり、これは列挙値を含むカスタム型です。genle エレメントに @assert.range: true というアノテーションを付けると、このエレメントに対して列挙からの値 (1 または 2) のみを指定できるようになります。

たとえば、書籍の登録時にジャンルエレメントに値 3 が指定されている場合、要求された CREATE 操作は実行されません。代わりに、HTTP 応答のステータスコードは 400 (Bad Request) であり、応答本文には以下のようなエラーメッセージが含まれます。

123456
"error": {
  "code": "400",
  "message": "Value 3 is invalid according to enum declaration {1, 2}",
  "target": "genre",
  "@Common.numericSeverity": 4
}

入力チェックの実装方法については、ビデオを視聴してください。