@RestController
@Slf4j
public class UserController {
@PostMapping("/register")
public void register(@Valid @RequestBody User user, BindingResult bindingResult) {
if(bindingResult.hasErrors()) {
log.error("【注册用户】参数不正确，user={}, msg={}", user, bindingResult.getFieldError().getDefaultMessage());
}
}
}
如果有多个参数需要校验，形式可以如下，即一个校验类对应一个校验结果：
foo(@Validated Foo foo, BindingResult fooBindingResult ，@Validated Bar bar, BindingResult barBindingResult);
分组校验
如果同一个类，在不同的使用场景下有不同的校验规则，那么可以使用分组校验。
@Data
public class User {
@Min(value = 20, message = "年龄不能小于20", groups = {Adult.class})
private Integer age;
public interface Adult{}
public interface Minor{}
}
在 Controller 中使用，注意使用分组功能必须使用 @Validated 注解：
@RestController
@Slf4j
public class UserController {
@PostMapping("/drink")
public void drink(@Validated({User.Adult.class}) @RequestBody User user, BindingResult bindingResult) {
if(bindingResult.hasErrors()) {
log.error("参数不正确，user={}, msg={}", user, bindingResult.getFieldError().getDefaultMessage());
}
}
@PostMapping("/live")
public void live(@Validated @RequestBody User user, BindingResult bindingResult) {
if(bindingResult.hasErrors()) {
log.error("参数不正确，user={}, msg={}", user, bindingResult.getFieldError().getDefaultMessage());
}
}
}
验证方式
验证请求体
验证请求体（RequestBody），需要验证的参数上加上了 @Valid 注解，如果验证失败，它将抛出 MethodArgumentNotValidException。默认情况下，Spring 会将此异常转换为 HTTP Status 400（错误请求）。
Controller：
@RestController
@RequestMapping("/api")
public class PersonController {
@PostMapping("/person")
public ResponseEntity<Person> getPerson(@RequestBody @Valid Person person) {
return ResponseEntity.ok().body(person);
}
}
ExceptionHandler：
@ControllerAdvice(assignableTypes = {PersonController.class})
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<Map<String, String>> 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.status(HttpStatus.BAD_REQUEST).body(errors);
}
}
验证请求参数
一定一定不要忘记在类上加上 Validated 注解了，这个参数可以告诉 Spring 去校验方法参数。
Controller：
@RestController
@RequestMapping("/api")
@Validated
public class PersonController {
@GetMapping("/person/{id}")
public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范围了") Integer id) {
return ResponseEntity.ok().body(id);
}
@PutMapping("/person")
public ResponseEntity<String> getPersonByName(@Valid @RequestParam("name") @Size(max = 6,message = "超过 name 的范围了") String name) {
return ResponseEntity.ok().body(name);
}
}
ExceptionHandler：
@ControllerAdvice(assignableTypes = {PersonController.class})
public class GlobalExceptionHandler {
@ExceptionHandler(ConstraintViolationException.class)
ResponseEntity<String> handleConstraintViolationException(ConstraintViolationException e) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
}
}
验证 Service 方法
此外还可以验证任何 Spring 组件的输入，而不是验证控制器级别的输入，我们可以使用 @Validated 和 @Valid 注释的组合来实现这一需求。
一定一定不要忘记在类上加上 Validated 注解了，这个参数可以告诉 Spring 去校验方法参数。
@Service
@Validated
public class PersonService {
public void validatePerson(@Valid Person person){
// do something
}
}
自定义 Validator
验证枚举值
主要实现：
Flag
FlagValidator
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Constraint(validatedBy = FlagValidator.class)
public @interface Flag {
String[] value() default {};
String message() default "flag is not found";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
public class FlagValidator implements ConstraintValidator<Flag, Integer> {
private String[] values;
@Override
public void initialize(Flag flag) {
this.values = flag.value();
}
@Override
public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
boolean isValid = false;
if (value == null) {
// 当状态为空时使用默认值
return true;
}
for (String val : values) {
if (val.equals(String.valueOf(value))) {
isValid = true;
break;
}
}
return isValid;
}
}
