Bean Validation和Hibernate Validator

概述

Bean Validation是用于數(shù)據(jù)校驗(yàn)的一套規(guī)范，
而Hibernate Validator是此規(guī)范的參考實(shí)現(xiàn)且對其進(jìn)行了擴(kuò)展。

幾個概念

  • Bean
    符號java bean規(guī)范定義的java類的對象
  • 約束:
    驗(yàn)證條件，如非null，非空等，一般用注解定義
  • 校驗(yàn)器:
    對bean進(jìn)行驗(yàn)證的對象，規(guī)范中定義為Validator/ExecutableValidator
  • 約束違反(ConstraintViolation):
    校驗(yàn)器按照定義的約束去驗(yàn)證某個值的結(jié)果，稱為約束違反
  • 消息綁定文件
    用于提供約束違反消息描述的資源文件，默認(rèn)文件名為:ValidationMessages.properties

核心API

核心包為javax.validation，核心對象為Validator和ExecutableValidator

其中Validator主要用于驗(yàn)證bean對象，常用方法如下:

  • Set<ConstraintViolation> validateValue(bean,property,value,groups)
    驗(yàn)證值value是否違反對象bean中的property屬性上定義的約束
  • Set<ConstraintViolation> validateProperty(bean,property,groups)
    驗(yàn)證值對象bean中的property屬性的值是否違反其上定義的約束
  • Set<ConstraintViolation> validate(bean,groups)
    驗(yàn)證值對象bean中的所有屬性的值是否違反各自屬性定義的約束

而ExecutableValidator主要用于在方法執(zhí)行時驗(yàn)證方法參數(shù)和構(gòu)造器參數(shù)

  • Set<ConstraintViolation> validateConstructorParameters(constructor,paramValues,groups)
    驗(yàn)證構(gòu)造器constructor執(zhí)行的參數(shù)paramValues

  • Set<ConstraintViolation> validateConstructorReturnValue(constructor,createdObject，groups)
    驗(yàn)證構(gòu)造器constructor構(gòu)造的對象是否符合約束

  • Set<ConstraintViolation> validateParameters(object,method,paramValues,groups)
    驗(yàn)證對象object中的method方法執(zhí)行的參數(shù)paramValues

  • Set<ConstraintViolation> validateReturnValue(object,method,returnValue,groups)
    驗(yàn)證對象object中的method方法的返回值

其中ConstraintViolation表示驗(yàn)證結(jié)果。

常用約束

  • @NotNull
    不為 null，可用于任意類型
  • @NotBlank
    不為 null且trim后長度不為0，僅用于CharSequence
  • @NotEmpty
    不為null或者為空，可用于CharSequence/Collection/Map/數(shù)組
  • @Size(min,max)
    驗(yàn)證字符串的長度在min和max之間，包括min，max

其他請參見后文的約束列表

使用步驟

  1. 配置依賴
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>版本</version>
</dependency>
<!--還依賴于EL，如果是Web環(huán)境，則由容器提供-->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.1-b09</version>
    <scope>provided</scope>
</dependency>
  1. 編寫要進(jìn)行驗(yàn)證的bean
public class Student {
    @NotEmpty
    private String no;

    @NotEmpty
    @Size(min = 2, max = 14)
    private String name;

    @NotNull
    @Min(18)
    private int age;

    //getters and setters ...
}
  1. 獲取驗(yàn)證器
 ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
 Validator validator = factory.getValidator();
  1. 創(chuàng)建bean對象，進(jìn)行驗(yàn)證,獲取驗(yàn)證結(jié)果
Student student=new Student();
student.setNo("10001");
student.setName("張三");
student.setAge(15);

Set<ConstraintViolation<Student>> violations =
                validator.validate( student );
for(ConstraintViolation v:violations){
    System.out.println(v.getMessage());
}

自定義驗(yàn)證消息

public class Student {

    @NotNull(message = "學(xué)號不能為空")
    @Size(min = 2,
          max = 14,
          message = "學(xué)號[${validatedValue}]長度為{min}到 {max}"
          )
    private String no;
   

    //constructor, getters and setters ...
}

消息參數(shù)和消息表達(dá)式

被{}包圍的成為消息參數(shù)
被${}包圍的稱為消息表達(dá)式

消息參數(shù)解析規(guī)則如下:

  1. 所有的消息參數(shù)首先從自定義消息文件(ValidationMessages)從獲取，如果未找到，執(zhí)行步驟2

  2. 所有消息參數(shù)再從內(nèi)置消息文件中獲取(org.hibernate.validator.ValidationMessages)，如果未找到，執(zhí)行步驟3

  3. 所有消息參數(shù)再去約束注解進(jìn)行注解屬性匹配，匹配上，則取對應(yīng)屬性的值，如果還未找到，則原樣輸出。

  4. 消息表達(dá)式規(guī)則:
    消息表達(dá)式寫法類似EL表達(dá)式?？捎蒙舷挛娜缦?

    • 約束注解屬性值，用法:${屬性名}
    • 當(dāng)前驗(yàn)證值，使用${validatedValue>1}
    • 格式化器，用法:${formatter.format('%1$.2f',validatedValue)}，相當(dāng)于調(diào)用java.util.Formatter.format(format,...args);

特殊字符

  • \{={
  • \}=}
  • \=
  • \\=\

約束組

每個約束都至少要屬于一個組，沒有指定則屬于默認(rèn)(javax.validation.groups.Default)組。如果指定則不再屬于默認(rèn)組。

把約束分組可以讓我們在對bean進(jìn)行驗(yàn)證時可以更靈活。
比如:同樣一個bean，在新增和修改兩個業(yè)務(wù)場景中需要驗(yàn)證的屬性是不一樣的(如新增不需要驗(yàn)證id，修改時則需要)

步驟:
1.定義約束組
任意定義一個接口即可

public interface AddGroup{
}
public interface ModGroup{
}

2.在注解中聲明

public class Student {
    @NotNull(groups=Mod.class)
    public String no;
    @NotEmpty(groups=Add.class,Mod.class)
    publilc String name;
    
}

3.驗(yàn)證時使用

validator.validate(student,Add.class);
validator.validate(student,Add.class,Mod.class);

注:如果驗(yàn)證時未傳遞組類型，則使用默認(rèn)組

自定義約束

兩個步驟，如編寫一個驗(yàn)證字符串必須全是大寫的驗(yàn)證器

1.創(chuàng)建約束注解

@Target({ FIELD, METHOD, PARAMETER, ANNOTATION_TYPE, TYPE_USE })
@Retention(RUNTIME)
@Constraint(validatedBy = MyUpperCaseValidator.class)
public @interface UpperCase {
    String message() default "{must-upper}";

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

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

}

2.編寫驗(yàn)證器(Implement ConstraintValidator)

public class MyUpperCaseValidator implements ConstraintValidator<UpperCase, String> {

    @Override
    public void initialize(UpperCase constraintAnnotation) {
        
    }

    @Override
    public boolean isValid(String object, ConstraintValidatorContext constraintContext) {
        if ( object == null ) {
            return true;
        }
        return object.equals( object.toUpperCase() );
    }
}

兩種驗(yàn)證模式

  • 快速失敗(fail fast)
    當(dāng)發(fā)生第一個驗(yàn)證失敗時就立即結(jié)束。

設(shè)置快速失敗模式，如下:

    validator = Validation.byProvider(HibernateValidator.class )
                .configure()
                .failFast( true )
                .buildValidatorFactory()
                .getValidator();
  • 非快速失敗模式(默認(rèn))
    收集所有失敗再結(jié)束

spring集成

1.注冊驗(yàn)證器和方法驗(yàn)證

<bean id="validator"
    class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"/>

<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>

2.使用驗(yàn)證器

@Service
public class MyService {

    @Autowired
    private Validator validator;

}

3.進(jìn)行方法驗(yàn)證
在方法所在類上注解@Validated，以提供AOP切點(diǎn)

@Validated
public class XXXService{
    public @NotNull Object myValidMethod(@NotNull String arg1, @Max(10) int arg2){
    ...
}
}

如果方法參數(shù)或返回值驗(yàn)證失敗，則方法拋出ConstraintViolationException異常?？赏ㄟ^異常來獲取驗(yàn)證失敗消息。

spring mvc集成

如果Bean Validation jar包在類路徑中存在，則spring會默認(rèn)注冊。
這可以直接在Controller中對請求參數(shù)bean進(jìn)行驗(yàn)證

@Controller
public class UserController{
    @GetMapping("/user/add.do")
    public String addUser(@Validated UserBean bean){
        ...
    }
    @GetMapping("/user/mod.do")
    public String modUser(@Validated UserBean bean,Errors es){
        if(es.hasErrors){
            //獲得驗(yàn)證異常消息
        }
        .
    }
}

如果需要在方法中處理異常，則可以添加Errors參數(shù)，用于獲取驗(yàn)證異常消息
否則，驗(yàn)證失敗，方法拋出ConstraintViolationException異常。

非bean參數(shù)驗(yàn)證

上面的驗(yàn)證僅能針對bean生效，如果要驗(yàn)證非bean參數(shù)，寫法同spring集成。
如業(yè)務(wù)層參數(shù)驗(yàn)證:

@Service
@Validated
public class UserService {
    public @NotNull Object login(@NotEmpty String account, @NotEmpty String password){
        ...
    }
}

login方法會拋出ConstraintViolationException異常，可以表現(xiàn)層中統(tǒng)一處理。

<h1 id="constrain-list">驗(yàn)證約束列表</h1>

表 1. Bean Validation 中內(nèi)置的 constraint

  • @Null
    被注釋的元素必須為 null，可用于任意類型

  • @NotNull
    被注釋的元素必須不為 null，可用于任意類型

  • @NotBlank
    被注釋的元素必須不為 null且trim后長度不為0，僅用于CharSequence

  • @NotEmpty
    被注釋的元素不可為null或者為空，可用于CharSequence/Collection/Map/數(shù)組

  • @AssertTrue
    被注釋的元素必須為 true,用于boolean/Boolean字段

  • @AssertFalse
    被注釋的元素必須為 false,用于boolean/Boolean字段

  • @Min(value)
    被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值,可用于:于BigDecimal/BigInteger/byte, short, int, long 和對應(yīng)包裝類

注:不能用于double和float(因?yàn)樗纳嵛迦雴栴})

  • @Max(value)
    被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
  • @DecimalMin(value)
    和@Min含義一樣，但可用于CharSequence(字符串)
  • @DecimalMax(value)
    和@Max含義一樣，但可用于CharSequence(字符串)
  • @Size(max, min)
    被注釋的元素的大小必須在指定的范圍內(nèi)，可用于String/Collection/Map/Array
  • @Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字，其整數(shù)部分位數(shù)不能超過integer個，小數(shù)部分位數(shù)不能超過fraction個，可用于:同DecimalMax
  • @Positive
    被注釋的元素必須為正數(shù),可用于:同DecimalMax
  • @PositiveOrZero
    被注釋的元素必須為正數(shù)或0,可用于:同DecimalMax
  • @Negative
    被注釋的元素必須為負(fù)數(shù),可用于:同DecimalMax
  • @NegativeOrZero
    被注釋的元素必須為負(fù)數(shù)或0,可用于:同DecimalMax
  • @Past
    被注釋的元素必須是一個過去的日期，可用于:所有日期相關(guān)類
  • @PastOrPresent
    被注釋的元素必須是一個過去的日期或當(dāng)下，可用于:所有日期相關(guān)類
  • @Future
    被注釋的元素必須是一個將來的日期,可用于:所有日期相關(guān)類
  • @FutureOrPresent
    被注釋的元素必須是當(dāng)下或者將來的日期，可用于:所有日期相關(guān)類
  • @Pattern(regex=, flags=)
    被注釋的元素必須符合指定的正則表達(dá)式,僅用于String
  • @Email
    被注釋的元素必須是電子郵箱地址，僅用于String
  • @NotEmpty
    被注釋的字符串的必須非空，僅用于String
  • @Range
    被注釋的元素必須在合適的范圍內(nèi)

表 2. Hiberate Validator 增加的 constraint

  • @CreditCardNumber(ignoreNonDigitCharacters=)
    被注釋的字符串必須是一個有效的信用卡號

  • @EAN
    被注釋的字符串必須是一個有效的EAN碼(國際物品編碼協(xié)會制定的一種商品用條碼)

  • @URL(protocol=, host=, port=, regexp=, flags=)

  • @ISBN
    被注釋的字符串必須是一個有效的ISBN(國際標(biāo)準(zhǔn)圖書號)

  • @UniqueElements
    被注釋的集合中僅能包含唯一性元素

  • @Length
    被注釋的字符串的大小必須在指定的范圍內(nèi)，僅用于String

  • @Range(min=, max=)
    被注釋的元素的值是否在min和max范圍內(nèi)(包含min和max)，用于BigDecimal/BigInteger/CharSequence/byte, short, int, long及其包裝類。

其他請參見hiernate官方文檔

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 1.1 spring IoC容器和beans的簡介 Spring 框架的最核心基礎(chǔ)的功能是IoC（控制反轉(zhuǎn)）容器，...
    simoscode閱讀 6,863評論 2贊 22
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,697評論 19贊 139
  • 1.1 Spring IoC容器和bean簡介 本章介紹了Spring Framework實(shí)現(xiàn)的控制反轉(zhuǎn)（IoC）...
    起名真是難閱讀 2,682評論 0贊 8
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架，建立于...
    Hsinwong閱讀 22,970評論 1贊 92
  • 校區(qū)：科學(xué)創(chuàng)想機(jī)器人和平校區(qū) 時間：周日9：00-10：00 學(xué)員：王前森，冷野，張詩晗 教學(xué)目標(biāo)： 課程評價：
    Happy00閱讀 342評論 0贊 0

友情鏈接更多精彩內(nèi)容