一、概要
validation主要是校验用户提交的数据的合法性，比如是否为空，密码是否符合规则，邮箱格式是否正确等等，校验框架比较多，用的比较多的是hibernate-validator， 也支持国际化，也可以自定义校验类型的注解
官方文档
二、基础使用
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;
@Data
public class UserQuery {
private Long id;
@NotBlank
@Length(min = 6, max = 15)
private String username;
@NotBlank
@Email
private String email;
@NotBlank
@Pattern(regexp = "^(1[3-9][0-9])\\d{8}$", message = "手机号格式不正确")
private String phone;
@Min(value = 1)
@Max(value = 100)
private int age;
@NotBlank
@Length(min = 6, max = 12, message = "昵称长度为6到12位")
private String nickname;
}
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
@RestController
public class AccountController {
@PostMapping("/users")
public String register(@Valid @RequestBody UserQuery user, BindingResult result) {
if (result.hasErrors()) {
FieldError fieldError = result.getFieldError();
String field = fieldError.getField();
String msg = fieldError.getDefaultMessage();
return field + ":" + msg;
}
return "success";
}
}
三、常用验证
1、JSR-330
validator内置注解
| 注解 | 详细信息 |
|---|---|
@Null |
被注释的元素必须为 null
|
@NotNull |
被注释的元素必须不为 null
|
@AssertTrue |
被注释的元素必须为 true
|
@AssertFalse |
被注释的元素必须为 false
|
@Min(value) |
被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
@Max(value) |
被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
@DecimalMin(value) |
被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
@DecimalMax(value) |
被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
@Size(max, min) |
被注释的元素的大小必须在指定的范围内 |
@Digits (integer, fraction) |
被注释的元素必须是一个数字，其值必须在可接受的范围内 |
@Past |
被注释的元素必须是一个过去的日期 |
@Future |
被注释的元素必须是一个将来的日期 |
@Pattern(value) |
被注释的元素必须符合指定的正则表达式 |
2、Hibernate Validator 附加的 constraint
| 注解 | 详细信息 |
|---|---|
@Email |
被注释的元素必须是电子邮箱地址 |
@Length |
被注释的字符串的大小必须在指定的范围内 |
@NotEmpty |
被注释的字符串的必须非空 |
@Range |
被注释的元素必须在合适的范围内 |
@NotBlank |
验证字符串非null，且长度必须大于0 |
注意：
-
@NotNull适用于任何类型被注解的元素必须不能与NULL -
@NotEmpty适用于String Map或者数组不能为Null且长度必须大于0 -
@NotBlank只能用于String上面 不能为null,调用trim()后，长度必须大于0
四、校验模式
1、说明
- 普通模式（默认是这个模式)
- 快速失败返回模式
2、普通模式
校验完所有的属性，然后返回所有的验证失败信息。默认就是普通模式无需配置
3、快速返回模式
只要有一个验证失败，则返回错误信息
@Configuration
public class ValidateConfig {
@Bean
public Validator validator() {
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
}
}
五、校验方式
1、说明
常见的验证方式:
- 封装成Bean进行校验
- 单个参数校验
- 分组校验
- 关联校验
2、栗子
2.1、请求参数封装成实体类
@Data
@Validated
public class ProductQuery {
@NotNull
private String keyword;
@Min(value = 0, message = "参数不合法")
private Long categoryId;
private Integer page = 1;
private Integer size = 10;
private Integer sort = 0;
}
@RestController
public class ValidatedController {
@GetMapping("/validated")
public String validatedBean(@Valid ProductQuery userVo, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
// 直接获取错误信息
List<String> errors = bindingResult.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.toList());
//获取参数的属性信息
// List<String> errors = bindingResult.getFieldErrors().stream().map(FieldError::getDefaultMessage).collect(Collectors.toList());
}
return "sucess";
}
}
2.2、方法参数校验
- 在类上使用@Validated注解
- 在参数上使用校验注解即可
@RestController
@Validated
public class ValidatedController {
@GetMapping("/validated/params")
public String validatedParams(@RequestParam @NotNull Long id, BindingResult bindingResult) {
return bindingResult.hasErrors() ? "success" : "error";
}
}
2.3、关联校验
校验对象内部包含另一个校验对象
@Data
@Validated
public class ProductQuery {
@NotNull
private String keyword;
@Min(value = 0, message = "参数不合法")
private Long categoryId;
private Integer page = 1;
private Integer size = 10;
private Integer sort = 0;
@Valid
BrandQuery brandQuery;
}
@Data
public class BrandQuery {
@NotBlank
private String brandName;
}
@GetMapping("/validated/association")
public String validatedAssociation(@Validated ProductQuery userVo, BindingResult bindingResult) {
return bindingResult.hasErrors() ? "success" : "error";
}
2.4、分组校验
在实际开发中经常会遇到这种情况：想要用一个实体类去接收多个
controller的参数，但是不同controller所需要的参数又有些许不同。分组顺序校验时，按指定的分组先后顺序进行验证，前面的验证不通过，后面的分组就不行验证。
六、校验错误处理
1、说明
- ConstraintViolationException
- MethodArgumentNotValidException
- BindException
2、栗子
2.1、方法参数校验处理
校验失败会抛出
ConstraintViolationException异常 然后我们在全局异常捕获类捕获这个异常,返回统一的结果集
@GetMapping("/validated/constraint")public ResponseResult<String> validatedError(@RequestParam @NotNull Long id) { return ResponseResult.success("success");}
@RestControllerAdvice@Slf4jpublic class GlobalExceptionHandler { /** * ConstraintViolationException * 单个参数违反约束校验异常 */ @ExceptionHandler(ConstraintViolationException.class) public ResponseResult<String> handleConstraintViolationException(ConstraintViolationException e) { log.error(e.getMessage(), e); return ResponseResult.error(); }}
2.2、请求参数表单对象
@Data@Validatedpublic class ProductQuery { @NotNull private String productId; @NotNull private String keyword; @Min(value = 0, message = "参数不合法") private Long categoryId; private Integer page = 1; private Integer size = 10; private Integer sort = 0; @Valid BrandQuery brandQuery;}
@PostMapping("/validate/method")public User methodArgs(@Valid @RequestBody ProductQuery productQuery){ return user;}
2.3、普通对象
也是不使用@RequestBody 会抛出BindException异常
@PostMapping("/validate/method")public ResponseResult<String> methodArgs(@Valid ProductQuery productQuery){ return ResponseResult.success("success");}
七、自定义校验
1、说明
- 创建约束注解类
- 创建验证器
2、创建注解类
@Target({ElementType.PARAMETER, ElementType.FIELD})@Documented@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy = CustomOrderValidator.class)public @interface CustomOrder { String values(); String message() default "必须是规定字段"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {};}
3、创建校验类
/** * 自定义排序字段校验规则 */public class CustomOrderValidator implements ConstraintValidator<CustomOrder, String> { private String values; @Override public void initialize(CustomOrder constraintAnnotation) { this.values = constraintAnnotation.values(); } /** * 否则，校验不通过。 * * @param value 用户输入的值，如从前端传入的某个值 */ @Override public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) { String[] args = values.split(", "); if (args.length > 0) { for (String val : args) { if (val.equals(value)) { return true; } } } return false; }}
4、使用
@GetMapping("/search")public ResponseResult<String> search(@CustomOrder(values = "1,2,3,4") Integer sort) { return ResponseResult.success("success");}
