どうも、チームCPR所属のミケです。
今回は、SpringBootでの、エラーメッセージ用プロパティファイルで使用可能なバリデーションのルールを一覧にまとめてみました。
SpringBootでは、プロパティファイルに設定をしておくことで、画面からの入力に対してバリデーションエラーを簡単に実装することが出来ます。使えるバリデーションチェックの数が多いため、備忘録も兼ねて一覧にまとめてみました。
※プロパティファイルの作成と共に、アノテーションクラスとバリデータクラスの実装も必要となるがそれはまた別でまとめます。今回は、プロパティファイルに限定していることの留意。
ルールまとめ
・ファイル名や設置場所は以下となる。
| ファイル名 | ValidationMessages.properties |
|---|---|
| ファイル設置場所 | src>main>resources |
・プロパティファイルへの記入の仕方は、以下となる。
使うバリデーションの指定 = エラーメッセージ
例1：org.hibernate.validator.constraints.NotBlank.message = 当項目の入力が必須です。
例2：javax.validation.constraints.Min.message = 当項目は{value}よりも大きい数値を入力してください。
・補足
{value}という書き方は、可変的な値に対して便利な書き方となります。言ってしまえば変数。
アノテーションの引数で渡してあげた値が、文字列として画面に表示されます。
バリデーションの種類一覧
- org.hibernate.validator.constraints.CreditCardNumber.message
- org.hibernate.validator.constraints.EAN.message
- org.hibernate.validator.constraints.Email.message
- org.hibernate.validator.constraints.Length.message
- org.hibernate.validator.constraints.LuhnCheck.message
- org.hibernate.validator.constraints.Mod10Check.message
- org.hibernate.validator.constraints.Mod11Check.message
- org.hibernate.validator.constraints.ModCheck.message
- org.hibernate.validator.constraints.NotBlank.message
- org.hibernate.validator.constraints.NotEmpty.message
- org.hibernate.validator.constraints.ParametersScriptAssert.message
- org.hibernate.validator.constraints.Range.message
- org.hibernate.validator.constraints.SafeHtml.message
- org.hibernate.validator.constraints.ScriptAssert.message
- org.hibernate.validator.constraints.URL.message
- org.hibernate.validator.constraints.br.CNPJ.message
- org.hibernate.validator.constraints.br.CPF.message
- org.hibernate.validator.constraints.br.TituloEleitoral.message
- javax.validation.constraints.AssertFalse.message
- javax.validation.constraints.AssertTrue.message
- javax.validation.constraints.DecimalMax.message
- javax.validation.constraints.DecimalMin.message
- javax.validation.constraints.Digits.message
- javax.validation.constraints.Future.message
- javax.validation.constraints.Max.message
- javax.validation.constraints.Min.message
- javax.validation.constraints.NotNull.message
- javax.validation.constraints.Null.message
- javax.validation.constraints.Past.message
- javax.validation.constraints.Pattern.message
- javax.validation.constraints.Size.message
※messageの前のワードをアノテーションとして記述する。
まとめ
バリデーションチェックは数も多くなりやすいため、エラーメッセージ用プロパティファイルを活用することで大幅な工数削減に繋がりますし、何より管理やメンテナンスが楽になります。
良かったら試してみてください。
引用・参考書籍
掌田津耶乃著、２０１８年出版、「SpringBoot2プログラミング入門」 、秀和システム