SpringMVC中常用参数校验类注解使用示例教程

org.hibernate:hibernate-validator:5.3.5.Final

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.3.5.Final</version>
</dependency>

public class UserDTO {
    //不显示地址
    public interface CommonView {}
    //显示地址
    public interface AdminView extends commonView {}
    @JSONView(value = CommonView.class)
    private String username;
    @jsonView(value = AdminView.class )
    private String address;
    //Getter Setter ...
}    //该参数必须为空
    @Null(message = "无需ID")
    private Integer id;
    //根据正则校验手机号是否是由数字组成
    @Pattern(regexp = "^\\d{11}$", message = "手机格式不正确,不是11位")
    private String telephone;
    //校验该对象是否为null
    //对于String来说，空字符串可通过校验，所以String应该使用@NotBlank进行校验，此处仅做示例而已。
    @NotNull(message = "联系人不能为空")
    private String friendName;
    //校验对象是否是空对象，可用于Array,Collection,Map,String
    @NotEmpty(message = "家庭成员不能为空")
    private List families;
    //校验长度，可以用于Array,Collection,Map,String
    @Size(min = 4, max = 8, message = "用户名长度错误 by size")
    //校验长度，只能用于String
    @Length(min = 4, max = 8, message = "用户名长度错误 by length")
    private String username;
    //javax校验
    @Max(value = 200, message = "年龄一般不会超过200 by max")
    @Min(value = 1, message = "年龄一般不能小于1 by min")
    //hibernate校验，效果等同
    @Range(min = 0, max = 200, message = "年龄范围在0-200之间 by range")
    private Integer age;
    //校验参数是否是False, 相反的是@AssertTrue
    @AssertFalse(message = "用户初始化无需冻结")
    private Boolean lock;
    //String专用
    @NotBlank(message = "密码不能为空")
    @Size(min = 6, max = 12, message = "密码长度不对")
    private String passWord;
    //使用自定义校验注解->校验时间
    @Past(message = "生日只能为以前的时间")
    @JsonFORMat(pattern = "yyyy-MM-dd HH:mm")
    private Date birth;
    //校验Email
    @Email(message = "邮件地址不正确")
    private String email;

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {
    
    @GetMapping
    public String getUser(@Size(min = 5, max = 8, message = "用户名长度超出限制") String username) {
	 return username;       
    }
}

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {
    
    @PostMapping
    public UserDTO saveUserOuter(@RequestBody @Valid UserDTO userDTO) {
        return userDTO;
    }

}

public class UserDTO {
    //该参数必须为空
    @Null(message = "无需ID")
    private Integer id;
    //根据正则校验手机号是否是由数字组成
    @Pattern(regexp = "^\\d{11}$", message = "手机格式不正确,不是11位")
    private String telephone;
    //校验该对象是否为null
    //对于String来说，空字符串可通过校验，所以String应该使用@NotBlank进行校验，此处仅做示例而已。
    @NotNull(message = "联系人不能为空")
    private String friendName;
    //校验对象是否是空对象，可用于Array,Collection,Map,String
    @NotEmpty(message = "家庭成员不能为空")
    private List families;
    //校验长度，可以用于Array,Collection,Map,String
    @Size(min = 4, max = 8, message = "用户名长度错误 by size")
    //校验长度，只能用于String
    @Length(min = 4, max = 8, message = "用户名长度错误 by length")
    private String username;
    //javax校验
    @Max(value = 200, message = "年龄一般不会超过200 by max")
    @Min(value = 1, message = "年龄一般不能小于1 by min")
    //hibernate校验，效果等同
    @Range(min = 0, max = 200, message = "年龄范围在0-200之间 by range")
    private Integer age;
    //校验参数是否是False, 相反的是@AssertTrue
    @AssertFalse(message = "用户初始化无需冻结")
    private Boolean lock;
    //String专用
    @NotBlank(message = "密码不能为空")
    @Size(min = 6, max = 12, message = "密码长度不对")
    private String password;
    //使用自定义校验注解->校验时间
    @Past(message = "生日只能为以前的时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm")
    private Date birth;
    //校验Email
    @Email(message = "邮件地址不正确")
    private String email;
	//setter  getter ....
}

Variant of JSR-303's {@link javax.validation.Valid}, supporting the
specification of validation groups. Designed for convenient use with
Spring's JSR-303 support but not JSR-303 specific.

public class UserGroupValidDTO {
    public interface SaveGroup extends Default {}
    public interface UpdateGroup extends Default {}
    @Null(groups = {SaveGroup.class}, message = "不需要传入用户ID")
    @NotNull(groups = {UpdateGroup.class}, message = "用户ID不能为空")
    private Integer id;
    @NotBlank(message = "用户名不能为空")
    private String username;
    //Setter Getter ...
}

save --> SaveGroup |-->id  @Null
                   |-->Default --> username @NotBlank
                   
update--> UpdateGroup |-->id @NotNull
                      |-->Default --> username @NotBlank

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {
    
    @PostMapping("/save")
    public void validSaveUser(@RequestBody @Validated(value = UserGroupValidDTO.SaveGroup.class) UserGroupValidDTO userDTO) {
        //save user
    }
    
    @PostMapping("/update")
    public void validUpdateUser(@RequestBody @Validated(value = UserGroupValidDTO.UpdateGroup.class) UserGroupValidDTO userDTO) {
        //update user
    }

}

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PastTimeValidate.class)
public @interface PastDate {
    String message();
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
}

@CommonsLog
public class PastTimeValidate implements ConstraintValidator<PastDate, LocalDateTime> {
   @Override
   public void initialize(PastDate constraintAnnotation) {
      log.info("init enum PastDate");
   }
   @Override
   public boolean isValid(LocalDateTime localDateTime, ConstraintValidatorContext context) {
      return localDateTime.isBefore(LocalDateTime.now()) ? true : false;
   }
}