On this page
バリデーション
はじめに
dframeworkはパイプ区切りのルールセットに対して受信データを評価するグローバルに利用可能なvalidate()ヘルパーを提供します。バリデーターは標準のデータオブジェクトと受信マルチパートファイルアップロードの両方を処理します。
基本的な使用法
第1引数に検証したいデータを渡し第2引数にルールを含むオブジェクトを渡します。ファイルを検証する場合はreq.bodyだけでなくreqオブジェクト全体を渡す必要があります。
いずれかのルールに違反した場合fails()メソッドはtrueを返します。
1export default class AuthController {2 async register(req) {3 const validation = validate(req.body, {4 username: 'required|string|min:3|max:20',5 email: 'required|email',6 password: 'required|string|min:8'7 });8 9 if (validation.fails()) {10 return status(422).json({ success: false, errors: validation.errors() });11 }12 13 // proceed with registration14 }15}
エラーの操作
バリデーション結果オブジェクトはエラーメッセージを操作するための複数のメソッドを提供します。
fails(): バリデーションが失敗した場合にtrueを返しますpasses(): バリデーションが成功した場合にtrueを返しますerrors(): フィールド名をエラーメッセージの配列にマッピングしたオブジェクトを返しますfirst(field): 特定のフィールドの最初のエラーメッセージを返しますall(): フィールド名をエラーメッセージの配列にマッピングしたオブジェクトを返します(errors()と同じです)
jsonではなくhtmlレスポンスを返す場合は通常.withErrors()および.withInput()ヘルパーを使用します。
1export default class SettingsController {2 async update(req) {3 const validation = validate(req.body, {4 display_name: 'nullable|string|max:50'5 });6 7 if (validation.fails()) {8 return back().withErrors(validation.errors()).withInput(req.body);9 }10 }11}
カスタムメッセージ
カスタムエラーメッセージを定義するには第3引数としてオブジェクトを渡します。キーにはfield.ruleのドット表記を使用する必要があります。
1const messages = {2 'email.required': 'we really need your email address',3 'email.email': 'that does not look like a valid email',4 'password.min': 'your password must be at least 8 characters long'5};6 7const validation = validate(req.body, rules, messages);
利用可能なルール
組み込みルールは最も一般的なバリデーションシナリオを網羅しています。
| ルール | 説明 |
|---|---|
required |
フィールドが存在し空でない必要があります |
nullable |
フィールドは任意です(空の場合ルールの位置に関係なくそのフィールドのバリデーションルールはスキップされます) |
string |
フィールドは文字列である必要があります |
number |
フィールドは有効な数値(整数または浮動小数点数)である必要があります |
integer |
フィールドは有効な整数である必要があります |
boolean |
フィールドはブール値(true、false、1、0、yes、no)である必要があります |
array |
フィールドは配列である必要があります |
email |
フィールドは有効なメール形式である必要があります |
min:value |
文字列または配列の場合: 最小長。数値の場合: 最小値 |
max:value |
文字列または配列の場合: 最大長。数値の場合: 最大値 |
in:foo,bar |
フィールドは指定された値のいずれかである必要があります |
not_in:foo,bar |
フィールドは指定された値のいずれでもない必要があります |
ファイルバリデーション
IMPORTANT
アップロードされたファイルを検証する際はバリデーターが`req.files`を検査できるように`req.body`ではなく完全な`req`オブジェクトを`validate(req, rules)`に渡してください。
ファイルサイズはバイト単位または省略記法サフィックス(kb、mb、gb)で指定できます。
1export default class UserProfileController {2 async updateProfileImage(req) {3 const validation = validate(req, {4 profileImage: 'file_required|file_size:8mb|file_max_count:1|file_mimes:jpg,png,jpeg'5 });6 7 if (validation.fails()) {8 return status(422).json({ success: false, errors: validation.errors() });9 }10 }11}利用可能なファイルバリデーションルールは以下のとおりです。
| ルール | 説明 |
|---|---|
file |
フィールドはファイルの配列である必要があります(必須) |
file_required |
フィールドは少なくとも1つのアップロードファイルを含む必要があります |
file_size:size |
個々のファイルが指定されたサイズ(例: 8mb、500kb)を超えることはできません |
file_min_size:size |
個々のファイルが指定されたサイズ未満になることはできません |
file_mimes:types |
すべてのファイルがいずれかの拡張子またはmimeタイプ(例: jpg,png,pdf)に一致する必要があります |
file_max_count:n |
ファイル数がnを超えることはできません |
file_min_count:n |
ファイル数が少なくともnである必要があります |

