Hibernate Validator 校验注解

亦凉 2023-02-21 06:59 7阅读 0赞

**Hibernate Validator 校验注解：**

## **一、@NotBlank、@NotEmpty、@NotNull** ##

**@NotBlank 字符序列不为null，并且长度大于0（不包括：空字符串或都是空格的字符串）  
@NotEmpty 字符序列不为null，但可以为空字符串或都是空格的字符串  
@NotNull 字符序列不为null**

## **二、约束说明** ##

<table> 
 <thead> 
  <tr> 
   <th>约束</th> 
   <th>用法说明</th> 
   <th>应用数据类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@NotBlank</td> 
   <td>检查带注释的字符序列不为null，<br>并且长度大于0</td> 
   <td>CharSequence</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>检查带注释的元素是否不为null或为空</td> 
   <td>CharSequence，Collection，Map和数组</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>检查注释的值不是null</td> 
   <td>任何类型</td> 
  </tr> 
  <tr> 
   <td>@Range(min=,max=)</td> 
   <td>检查带注释的值是否介于（包括）指定的最小值和最大值之间</td> 
   <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Max(value=)</td> 
   <td>检查带注释的值是否小于或等于指定的最大值</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Min(value=)</td> 
   <td>检查带注释的值是否大于或等于指定的最小值</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>检查指定的字符序列是否为有效的电子邮件地址。可选参数regexp，flags允许您指定电子邮件必须匹配的其他正则表式</td> 
   <td>CharSequence</td> 
  </tr> 
  <tr> 
   <td>@Size(min=,max=)</td> 
   <td>检查带注释的元素的大小是否介于min和之间max（包括）</td> 
   <td>CharSequence，Collection，Map和数组</td> 
  </tr> 
  <tr> 
   <td>@URL(protocol=,<br>host=,port=,<br>regexp=,flags=)</td> 
   <td>可选参数protocol，host或port指定时，相应的URL片段必须在指定的值相匹配。regexp并flags允许指定URL必须匹配的其他正则表达式</td> 
   <td>CharSequence</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>检查带注释的日期是否是将来的日期</td> 
   <td>Boolean，boolean</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>检查带注释的元素为true</td> 
   <td>Boolean，boolean</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value=,<br>inclusive=)</td> 
   <td>inclusive=false时，检查带注释的值是否小于指定的最大值。inclusive=true时，该值是否小于或等于指定的最大值。</td> 
   <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value=,<br>inclusive=)</td> 
   <td>inclusive=false时，检查带注释的值是否大于指定的最小值。inclusive=true时，该值是否大于或等于指定的最小值。</td> 
   <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer=,fraction=)</td> 
   <td>检查带注释的值是否是最多由integer数字和fraction小数位组成的数字</td> 
   <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>检查带注释的日期是否是将来的日期</td> 
   <td>Date，Calendar，Instant，LocalDate，LocalDateTime，LocalTime，MonthDay，OffsetDateTime，OffsetTime，Year，YearMonth，ZonedDateTime，HijrahDate，JapaneseDate，MinguoDate，ThaiBuddhistDate</td> 
  </tr> 
  <tr> 
   <td>@FutureOrPresent</td> 
   <td>查带注释的日期是现在还是将来</td> 
   <td>Date，Calendar，Instant，LocalDate，LocalDateTime，LocalTime，MonthDay，OffsetDateTime，OffsetTime，Year，YearMonth，ZonedDateTime，HijrahDate，JapaneseDate，MinguoDate，ThaiBuddhistDate</td> 
  </tr> 
  <tr> 
   <td>@Negative</td> 
   <td>检查元素是否严格为负。零值被视为无效。</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@NegativeOrZero</td> 
   <td>检查元素是负数或零。</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@Null</td> 
   <td>检查注释的值是null</td> 
   <td>任何类型</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>检查带注释的日期是否是过去的日期</td> 
   <td>Date，Calendar，Instant，LocalDate，LocalDateTime，LocalTime，MonthDay，OffsetDateTime，OffsetTime，Year，YearMonth，ZonedDateTime，HijrahDate，JapaneseDate，MinguoDate，ThaiBuddhistDate</td> 
  </tr> 
  <tr> 
   <td>@PastOrPresent</td> 
   <td>检查带注释的日期是过去还是现在</td> 
   <td>Date，Calendar，Instant，LocalDate，LocalDateTime，LocalTime，MonthDay，OffsetDateTime，OffsetTime，Year，YearMonth，ZonedDateTime，HijrahDate，JapaneseDate，MinguoDate，ThaiBuddhistDate</td> 
  </tr> 
  <tr> 
   <td>@Pattern(regex=,flags=)</td> 
   <td>regex考虑给定标志，检查带注释的字符串是否与正则表达式匹配match</td> 
   <td>CharSequence</td> 
  </tr> 
  <tr> 
   <td>@Positive</td> 
   <td>检查元素是否严格为正。零值被视为无效。</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
  <tr> 
   <td>@PositiveOrZero</td> 
   <td>检查元素是正数还是零。</td> 
   <td>BigDecimal，BigInteger，byte，short，int，long</td> 
  </tr> 
 </tbody> 
</table>

## **二、定义不满足约束的消息** ##

**1.上面约束都都默认约束违规消息，当然我们也可以自定义**。

@NotNull(message = "name不为空")
    private String name;
    
    @Min(value = 2,message = "count最小值应为{value}")
    private int count;

**2.单个参数约束**

public void test2(
            @NotNull @Future Date startDate,
            @Min(1) int count) { 
    }

**3.类参数约束**

public class User { 
    
        @NotNull
        private String name;
    
        @Min(18)
        private int  age;
    
        //geter... seter...
    }
    
    public class Test { 
        public boolean Test1(@Valid User user) { 
            //...
            return false;
        }
    }

增加@Valid注解后，表示需要对其中的参数进行校验。

\*\*4.返回值约束\*\*

@NotNull
    @Size(min = 1)
    public List<@NotNull User> getUsers() { 
        //...
        return null;
    }