springboot之Validation参数校验详细解读

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.5.Final</version>
</dependency>
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>jakarta.el</artifactId>
    <version>3.0.3</version>
</dependency>

/**
 * @Author lsc
 * <p> </p>
 */
@Data
public class SysUser {
    private Long id;
    @NotNull(message ="用户名不能为空")
    @Size(min = 3, max = 5, message = "用户名长度为{min}-{max}之间")
    private String username;
    @NotNull(message ="昵称不能为空")
    private String name;
    @NotNull(message ="密码不能为空")
    private String password;
    @Email(message = "邮箱格式不合法")
    private String email;
    private String gender;
}

/**
 * @Author lsc
 * <p> </p>
 */
@RestController
@Validated
public class SysUserController {
    // 方法参数为实体校验
    @PostMapping("/register")
    public ResponseEntity register(@Valid @RequestBody SysUser sysUser){
        return ResponseEntity.ok(sysUser);
    }
    // 方法参数校验
    @GetMapping("user")
    public ResponseEntity getUser(@NotNull(message ="用户名不能为空") String username) {
        SysUser sysUser = new SysUser();
        sysUser.setName("知识追寻者");
        return ResponseEntity.ok(sysUser);
    }
}

/**
 * @Author lsc
 * <p> </p>
 */
@ControllerAdvice
public class GlobHandler {
    // 捕获方法参数校验异常
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public ResponseEntity constraintViolationExceptionHandler(ConstraintViolationException e){
        Set<ConstraintViolation<?>> message = e.getConstraintViolations();
        HashMap<String, Object> map = new HashMap<>();
        message.stream().forEach(msg -> {
            String path = msg.getPropertyPath().toString();
            String field = path.substring(path.indexOf(".")+1);
            map.put(field,msg.getMessageTemplate());
        });
        return ResponseEntity.ok(map);
    }
    // 捕获实体参数校验异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public ResponseEntity resolveMethodArgumentNotValidException(MethodArgumentNotValidException e){
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        HashMap<String, Object> map = new HashMap<>();
        allErrors.stream().forEach(error -> {
            FieldError fieldError = (FieldError) error;
            map.put(fieldError.getField(), fieldError.getDefaultMessage());
        });
        return ResponseEntity.ok(map);
    }
}

@Target({ METHOD, FIELD })
@Retention(RUNTIME)
@Constraint(validatedBy = GenderValidator.class)
@Documented
public @interface Gender {
    String message() default "性别为男或者女";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default {};
}

/**
 * @Author lsc
 * <p> </p>
 */
public class GenderValidator implements ConstraintValidator<Gender, String> {
    // 初始化校验值
    @Override
    public void initialize(Gender constraintAnnotation) {
    }
    // 校验规则
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return "男".equals(value) || "女".equals(value);
    }
}

    @Gender()
    private String gender;

/**
 * @Author lsc
 * <p> </p>
 */
public interface ADD extends Default {
}

public interface Select extends Default {
}

    @NotNull(message ="用户名不能为空",groups = ADD.class)
    @Size(min = 3, max = 5, message = "用户名长度为{min}-{max}之间")
    private String username;
    @NotNull(message ="昵称不能为空", groups = Select.class)
    private String name;
    @NotNull(message ="密码不能为空",groups = ADD.class)
    private String password;
    @Email(message = "邮箱格式不合法", groups = Select.class)
    private String email;

    // 分组校验
    @PostMapping("/user")
    public ResponseEntity addUser(@Validated(value = ADD.class) @RequestBody SysUser sysUser){
        return ResponseEntity.ok(sysUser);
    }