Spring Boot集成Hibernate Validator

廢話不多說，直接開始集成環境。

一、環境集成

　　在項目中hibernate-Validator包在spring-boot-starter-web包里面有，不需要重復引用 。（整個Demo都是用PostMan軟件進行數據傳輸。）

二、Demo實例

　　此Mode中添加了些簡單、常用的Validator注解

import com.shida.api.baseData.validatorUtils.IsMobile;
import org.hibernate.validator.constraints.Length;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.io.Serializable;

public class AccountVO implements Serializable {

    /**
     * 手機號
     */
    @IsMobile
    private String account;

    /**
     * 密碼
     */
    @NotNull
    @Length(min = 1 , max = 6 , message = "密碼不能為空且長度需要在1和6之間")
    private String password;

    /**
     * 賬戶狀態
     */
    @NotNull(message = "賬號狀態不能為空")
    private Integer status;

    /**
     * 賬戶擴展信息
     */
    @Valid
    private UserInfoVO userInfoVO;

    public String getAccount() {return account;}

    public void setAccount(String account) {this.account = account;}

    public String getPassword() {return password;}

    public void setPassword(String password) {this.password = password;}

    public Integer getStatus() {return status;}

    public void setStatus(Integer status) { this.status = status;}

    public UserInfoVO getUserInfoVO() {return userInfoVO;}

    public void setUserInfoVO(UserInfoVO userInfoVO) {this.userInfoVO = userInfoVO;}
}

 

接下來Post接口驗證，Controller中調用DemoVO驗證集合校驗情況：

package com.shida.account.center.controller;


import com.base.data.common.message.MessageVo;
import com.base.data.common.message.StatusCode;
import com.shida.account.center.service.IAccountService;
import com.shida.api.baseData.model.AccountVO;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.Valid;

@RestController
@Validated
@RequestMapping("/data/account")
public class AccountController {

    @Resource
    private IAccountService accountService;

    /**
     * 添加賬戶
     * @param accountVO
     * @return
     */
    @PostMapping(value = "/add")
    public MessageVo addAccount(@Valid @RequestBody AccountVO accountVO){
        MessageVo message = new MessageVo();
        accountService.addAccount(accountVO);
        message.setCode(StatusCode.success);
        message.setMsg("賬戶添加成功");
        message.setResult(accountVO);
        return message;
    }
}

PostMan請求入參：

 

PostMan返回結果：（MessageVo是我自己寫的一個返回Mode，用於承載返回結果。）

{
    "code": "204",
    "msg": "前后端校驗發生異常+[accountVO.account:手機號碼錯誤][accountVO.password:密碼不能為空][accountVO.status:賬號狀態不能為空]",
    "result": null
}

注：如果實體類想參與校驗則需要在實體類前加@Valid注解。不加則不參與校驗。

 

三、對象級聯校驗填坑。

 1、對象級聯校驗方式。

　　對象級聯校驗Mode為對象內部包含另一個對象最為屬性。內部對象也需要加入@Valid注解。則開啟內部對象校驗。（如果用PostMan作為自測接口方式，需要另加@RequestBody注解，RequestBody會自動將參數分配到各個Type中。否則會報錯。）

　　集合類的入參同樣也需要用@RequestBody注解。　　

　　controller實例：

   public MessageVo addAccount(@Valid @RequestBody AccountVO accountVO){
        MessageVo message = new MessageVo();
        return message;
    }

 

　　Mode實例：

public class AccountVO implements Serializable {

    @IsMobile
    private String account;

    @Valid
    private UserInfoVO userInfoVO;
 
}

　　UserInfoVO實例：

 

public class UserInfoVO implements Serializable {

    @NotNull
    private Integer sex;

}

 　　PostMan校驗結果：

四、自定義校驗器

　　一般情況，自定義驗證可以解決很多問題。但也有無法滿足情況的時候，此時，我們可以實現validator的接口，自定義自己需要的驗證器。如下所示，實現了一個自定義的大小寫驗證器：

public enum CaseMode {
    UPPER,
    LOWER;
}


@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {
    String message() default "";

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

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

    CaseMode value();
}


public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {
    private CaseMode caseMode;
    public void initialize(CheckCase checkCase) {
        this.caseMode = checkCase.value();
    }

    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (s == null) {
            return true;
        }

        if (caseMode == CaseMode.UPPER) {
            return s.equals(s.toUpperCase());
        } else {
            return s.equals(s.toLowerCase());
        }
    }
}

要驗證的Model：

    public class Demo{
        @CheckCase(value = CaseMode.LOWER,message = "userName必須是小寫")
        private String userName;

        public String getUserName() {
            return userName;
        }

        public void setUserName(String userName) {
            this.userName = userName;
        }
    }

validator配置：

    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
                .configure()
                .addProperty( "hibernate.validator.fail_fast", "true" )
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();

        return validator;
    }

驗證測試：

    @RequestMapping("/demo4")
    public void demo4(){
        Demo demo = new Demo();
        demo.setUserName("userName");
        Set<ConstraintViolation<Demo>> validate = validator.validate(demo);
        for (ConstraintViolation<Demo> dem : validate) {
            System.out.println(dem.getMessage());
        }
    }

輸出結果：

   userName必須是小寫

五、常見注解。

　　

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=)  被注釋的元素必須在合適的范圍內

六、參考資料　　

https://www.cnblogs.com/mr-yang-localhost/p/7812038.html#_label5