Spring のBean Validaiton 〜びーん ばりでーしょん〜
Bean Validation
Spring Frameworkを使用し、REST通信を基本としたサンプルを記載する。
びーん ばりでーしょんって?
クライアントから送信されたRequestBodyの値をチェックする。
チェック内容は何種類かある。
- Null
- 空文字
- 文字数
- パターン(正規表現)
- 最大サイズ
- 最小サイズ
などなど...
とりあえずサンプル
コントローラでただバリデーションを実行するだけのサンプル。
@RestController
@RequestMapping("validation")
public class SampleController {
// バリデーションするだけ
@PostMapping
public SampleResource validation(
@RequestBody @Validated SampleResource resource) {
return resource;
}
}
@Getter
@Setter
public class SampleResource {
@NotNull
@Size(min = 5, max = 30)
@Pattern(regexp = "[a-zA-Z0-9]*")
private String message;
}
アノテーション | 説明 |
---|---|
@NotNull | Nullを禁止 |
@Size | {min}以上{max}以下であることを確認する |
@Pattern | 指定パターンであることを確認する |
more びーん ばりでーしょん
ネストしたクラスのバリデーション
フィールドに@Valid
を指定する。
上のサンプルコントローラ一緒
@Getter
@Setter
public class SampleResource {
@Valid
@NotNull
private SampleNestResource nestResource;
}
@Validでネストしたクラスのバリデーションを実行している。nestResource
が送信されてこない場合はフィールドにNullがバインドされてしまい、SampleNestResource
に指定したバリデーションが実行されないため、@NotNullで必須にしている。
@Getter
@Setter
public class SampleNestResource {
@NotNull
@Size(min = 5, max = 30)
@Pattern(regexp = "[a-zA-Z0-9]*")
private String message;
}
Collection内のチェック
List
などのCollection
をフィールドに指定した場合、Collection
ないのクラスのバリデーション指定とフィールドに対するバリデーションの指定が異なる。
上のサンプルコントローラ一緒
@Getter
@Setter
public class SampleResource {
@Size(min = 2)
private List<@NotNull String> strList;
}
@SizeでフィールドのList
要素が2以上かを確認
@NotNullでList
内のString
がNullではないことを確認
バリデーションエラーのハンドリング
ハンドリングを行わない場合はMethodArgumentNotValidException
が発生する。
RestController
ではBindingResultにエラーが入らないため、Errorsでエラー内容を取得する。
@RestController
@RequestMapping("validation")
public class SampleController {
// バリデーションするだけ
@PostMapping
public SampleResource validation(
@RequestBody @Validated SampleResource resource,
Errors errors) {
if (errors.hasErrors()){
throw new RuntimeException();
}
return resource;
}
}
Author And Source
この問題について(Spring のBean Validaiton 〜びーん ばりでーしょん〜), 我々は、より多くの情報をここで見つけました https://qiita.com/salvage0707/items/b627a9d664480d20deeb著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .