springboot 整合 hibernate validator 校验

最新推荐文章于 2024-10-29 07:00:00 发布

haiyabtx

最新推荐文章于 2024-10-29 07:00:00 发布

阅读量538

点赞数

分类专栏： SpringBoot

本文链接：https://blog.youkuaiyun.com/haiyabtx/article/details/114301179

版权

SpringBoot 专栏收录该内容

9 篇文章

订阅专栏

spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖。

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

    Bean Validation 中内置的 constraint       
    @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(regex=,flag=)  被注释的元素必须符合指定的正则表达式       
    Hibernate Validator 附加的 constraint       
    @NotBlank(message =)   验证字符串非null，且长度必须大于0       
    @Email  被注释的元素必须是电子邮箱地址       
    @Length(min=,max=)  被注释的字符串的大小必须在指定的范围内       
    @NotEmpty   被注释的字符串的必须非空       
    @Range(min=,max=,message=)  被注释的元素必须在合适的范围内

    @NotBlank(message="用户名不能为空")
    private String userName;

    @NotBlank(message="年龄不能为空")
    @Pattern(regexp="^[0-9]{1,2}$",message="年龄不正确")
    private String age;

    @AssertFalse(message = "必须为false")
    private Boolean isFalse;
    /**
     * 如果是空，则不校验，如果不为空，则校验
     */
    @Pattern(regexp="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",message="出生日期格式不正确")
    private String birthday;

    @Length(min = 5, max = 17, message = "length长度在[5,17]之间")
    private String length;

    /**@Size不能验证Integer，适用于String, Collection, Map and arrays*/
    @Size(min = 1, max = 3, message = "size在[1,3]之间")
    private String age;

    @Range(min = 150, max = 250, message = "range在[150,250]之间")
    private int high;

    @Size(min = 3,max = 5,message = "list的Size在[3,5]")
    private List<String> list;

    //大于0.01，不包含0.01
    @NotNull
    @DecimalMin(value = "0.01", inclusive = false)
    private Integer greaterThan;
    
    //大于等于0.01
    @NotNull
    @DecimalMin(value = "0.01", inclusive = true)
    private BigDecimal greatOrEqualThan;
    
    @Length(min = 1, max = 20, message = "message不能为空")
    //不能将Length错用成Range
    //@Range(min = 1, max = 20, message = "message不能为空")
    private String message;

自定义参数注解

1. 比如我们来个自定义身份证校验注解

@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdentityCardNumberValidator.class)
public @interface IdentityCardNumber {

    String message() default "身份证号码不合法";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

这个注解是作用在Field字段上，运行时生效，触发的是IdentityCardNumber这个验证类。

message 定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定制
groups 这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作
payload 主要是针对bean的，使用不多。

2. 然后自定义Validator

public class IdentityCardNumberValidator implements ConstraintValidator<IdentityCardNumber, Object> {

    @Override
    public void initialize(IdentityCardNumber identityCardNumber) {
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        return IdCardValidatorUtils.isValidate18Idcard(o.toString());
    }
}

3. 使用自定义的注解

 @NotBlank(message = "身份证号不能为空")
    @IdentityCardNumber(message = "身份证信息有误,请核对后提交")
    private String clientCardNo;

@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用户ID*/
    @NotNull(message = "用户id不能为空", groups = Update.class)
    private Long userId;

    /**
     * 用户名
     */
    @NotBlank(message = "用户名不能为空")
    @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")
    private String username;

    /**
     * 手机号
     */
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误", groups = {Create.class, Update.class})
    private String mobile;

    /**
     * 性别
     */
    private String sex;

    /**
     * 邮箱
     */
    @NotBlank(message = "联系邮箱不能为空")
    @Email(message = "邮箱格式不对")
    private String email;

    /**
     * 密码
     */
    private String password;

    /*** 创建时间 */
    @Future(message = "时间必须是将来时间", groups = {Create.class})
    private Date createTime;

}

一、简介

开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验，比如非空，非null，整数值的范围，字符串的个数，日期，邮箱等等。最常见的就是我们直接写代码校验，这样以后比较繁琐，而且不够灵活。
　　Bean Validation 1.0（JSR-303）是一个校验规范，在Spring Boot项目由于自带了Hibernate validator 5(http://hibernate.org/validator/)实现，所以我们可以非常方便的使用这个特性

二、关键使用

1、添加包

hibernate-validator