springboot校验注解
时间: 2023-08-17 12:08:02 浏览: 52
Spring Boot提供了一套方便的校验注解,可以用于对请求参数进行校验。下面是一些常用的校验注解:
1. @NotNull:验证注解的元素值不为null。
2. @NotEmpty:验证注解的元素值不为null且不为空。
3. @NotBlank:验证注解的元素值不为null且去除首尾空格后不为空。
4. @Min:验证注解的元素值大于等于指定的最小值。
5. @Max:验证注解的元素值小于等于指定的最大值。
6. @Size:验证注解的元素值的大小在指定范围内。
7. @Pattern:验证注解的元素值符合指定的正则表达式。
8. @Email:验证注解的元素值是一个有效的电子邮件地址。
使用这些注解,可以在Controller层的请求参数上进行标记,然后在处理请求的方法中使用@Valid注解进行参数校验。如果校验失败,会抛出MethodArgumentNotValidException异常,可以通过ExceptionHandler进行统一处理。
例如,对一个User对象进行校验:
```java
public class User {
@NotBlank(message = "用户名不能为空")
private String username;
@Size(min = 6, max = 20, message = "密码长度必须在6到20之间")
private String password;
// 省略getter和setter
}
@RestController
public class UserController {
@PostMapping("/users")
public void createUser(@Valid @RequestBody User user) {
// 处理创建用户的逻辑
}
// 异常处理
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<Object> handleValidationExceptions(MethodArgumentNotValidException ex) {
Map<String, String> errors = new HashMap<>();
ex.getBindingResult().getAllErrors().forEach((error) -> {
String fieldName = ((FieldError) error).getField();
String errorMessage = error.getDefaultMessage();
errors.put(fieldName, errorMessage);
});
return ResponseEntity.badRequest().body(errors);
}
}
```
在上面的例子中,@NotBlank注解用于校验username字段不能为空,@Size注解用于校验password字段的长度必须在6到20之间。`@Valid`注解用于标记需要进行校验的参数,当校验失败时,会抛出MethodArgumentNotValidException异常,可以通过ExceptionHandler进行统一处理。