摘要：所以就有今天的話題利用注解對(duì)進(jìn)行校驗(yàn)。利用注解對(duì)進(jìn)行校驗(yàn)，主要是利用框架，實(shí)現(xiàn)了的接口關(guān)于校驗(yàn)的接口，直接使用非常方便，省時(shí)省力。

最近寫業(yè)務(wù)代碼，因?yàn)轫撁鎻?fù)雜，導(dǎo)致對(duì)應(yīng)的Bean屬性非常多，而產(chǎn)品大佬又提出各種校驗(yàn)要求。

emmmmmm......如果寫if條件來校驗(yàn)，那簡直是又臭又長。

所以就有今天的話題——利用注解對(duì)Bean進(jìn)行校驗(yàn)。

利用注解對(duì)Bean進(jìn)行校驗(yàn)，主要是利用hibernate-validator框架，hibernate-validator實(shí)現(xiàn)了validation-api的接口關(guān)于Bean校驗(yàn)的接口，直接使用hibernate-validator非常方便，省時(shí)省力。

此hibernate-validator+SpringMVC可以實(shí)現(xiàn)以下功能：

注解java bean聲明校驗(yàn)規(guī)則；

添加message錯(cuò)誤信息源實(shí)現(xiàn)國際化配置；

結(jié)合spring form中的errors標(biāo)簽展現(xiàn)錯(cuò)誤信息。

優(yōu)勢：

代碼簡潔、處理校驗(yàn)可以更加優(yōu)雅。

實(shí)現(xiàn)要求：

使用hibernate validator至少要引入兩個(gè)jar包：

    
        org.hibernate.validator
        hibernate-validator
        6.0.1.Final
    
    
    
        org.glassfish
        javax.el
        3.0.1-b08
    

java bean中使用注解添加檢驗(yàn)規(guī)則。

hibernate validator使用的注解定義在hibernate-validator-6.0.1.Final.jar、validation-api-1.1.0.Final.jar兩個(gè)包中，

@AssertFalse 驗(yàn)證注解的元素值是false
@AssertTrue 驗(yàn)證注解的元素值是true
@DecimalMax（value=x） 驗(yàn)證注解的元素值小于等于@ DecimalMax指定的value值
@DecimalMin（value=x） 驗(yàn)證注解的元素值小于等于@ DecimalMin指定的value值
@Digits(integer=整數(shù)位數(shù), fraction=小數(shù)位數(shù)) 驗(yàn)證注解的元素值的整數(shù)位數(shù)和小數(shù)位數(shù)上限
@Future 驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間晚
@Max（value=x） 驗(yàn)證注解的元素值小于等于@Max指定的value值
@Min（value=x） 驗(yàn)證注解的元素值大于等于@Min指定的value值
@NotNull 驗(yàn)證注解的元素值不是null
@Null 驗(yàn)證注解的元素值是null
@Past 驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間早
@Pattern(regex=正則表達(dá)式, flag=) 驗(yàn)證注解的元素值與指定的正則表達(dá)式匹配
@Size(min=最小值, max=最大值) 驗(yàn)證注解的元素值的在min和max（包含）指定區(qū)間之內(nèi)，如字符長度、集合大小
@Valid 驗(yàn)證關(guān)聯(lián)的對(duì)象，如賬戶對(duì)象里有一個(gè)訂單對(duì)象，指定驗(yàn)證訂單對(duì)象
@NotEmpty 驗(yàn)證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0）
@Range(min=最小值, max=最大值) 驗(yàn)證注解的元素值在最小值和最大值之間
@NotBlank 驗(yàn)證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的空格
@Length(min=下限, max=上限) 驗(yàn)證注解的元素值長度在min和max區(qū)間內(nèi)
@Email 驗(yàn)證注解的元素值是Email，也可以通過正則表達(dá)式和flag指定自定義的email格式

利用hibernate validator實(shí)現(xiàn)Bean校驗(yàn)，一般有兩種做法：

利用@ModelAttribute和@Valid注解；

利用validate()、validateValue()、validateProperty()等方法在需要之處直接調(diào)用。

Bean對(duì)象：

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class Car {

    @NotNull
    private String manufacturer;

    @NotNull
    @Size(min = 2, max = 14)
    private String licensePlate;

    @Min(2)
    private int seatCount;
    
    public Car(String manufacturer, String licencePlate, int seatCount) {
        this.manufacturer = manufacturer;
        this.licensePlate = licencePlate;
        this.seatCount = seatCount;
    }

    //getters and setters ...
}

驗(yàn)證器

import org.apache.commons.collections4.CollectionUtils;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

public class ValidateTest {

    /**
     * 驗(yàn)證器
     */
    private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
    
    public static void main(String[] args) {
        Car car = new Car(null, "12", 1);
        //執(zhí)行驗(yàn)證
        Set> constraintViolations = validator.validate(car);
        //打印校驗(yàn)信息
        if (CollectionUtils.isNotEmpty(constraintViolations)) {
            for (ConstraintViolation constraintViolation : constraintViolations) {
                System.out.println(constraintViolation.getPropertyPath().toString() + ": " + constraintViolation.getMessage());
            }
        }
    }
}

輸出結(jié)果：

seatCount: 最小不能小于2
manufacturer: 不能為null

校驗(yàn)demo

import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.validation.Valid;

@Controller("/Validate")
public class ValidateTestController {
    @RequestMapping("/demo1")
    public void validateDemo(@Valid @ModelAttribute("car") Car car, BindingResult result) {
        if(result.hasErrors()){
            for (ObjectError error : result.getAllErrors()) {
                System.out.println(error.getDefaultMessage());
            }
        }
    }
}

測試數(shù)據(jù)：

{
    "manufacturer": null,
    "licensePlate": "",
    "seatCount": 1
}

結(jié)果：

不能為null
個(gè)數(shù)必須在2和14之間
最小不能小于2

注意，需要加上@ModelAttribute注解，否則會(huì)報(bào)錯(cuò)： An Error/BindingResult argument is
expected to be declared immediately after the model attribute

校驗(yàn)demo

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.validation.Valid;

@Controller
@RequestMapping("/validate")
public class ValidateTestController {

    @RequestMapping("/demo1")
    public void validateDemo(@Valid Car car) { }
}

測試數(shù)據(jù)：

{
    "manufacturer": null,
    "licensePlate": "",
    "seatCount": 1
}

統(tǒng)一異常處理類：

@Component
public class ExceptionResolver implements HandlerExceptionResolver {
    /**
     * 日志
     */
    private static final Logger LOG = LoggerFactory.getLogger(AuditCommonExceptionResolver.class);

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        if (ex instanceof BindException) {
            BindException exs = (BindException) ex;
            for (ObjectError o : exs.getAllErrors()) {
                System.out.println(o.getDefaultMessage());
            }
        } else if (ex instanceof ConstraintViolationException) {
            ConstraintViolationException exs = (ConstraintViolationException) ex;
            Set> violations = exs.getConstraintViolations();
            for (ConstraintViolation item : violations) {
                System.out.println(item.getMessage());
            }
        } else {
            LOG.error("捕獲未處理異常，異常信息：{}", ex.getMessage());
        }
        return new ModelAndView("/sys/errorPage.jsp");
    }
}

結(jié)果：

不能為null
個(gè)數(shù)必須在2和14之間
最小不能小于2

注意：我自己測試的時(shí)候，捕獲的是BindException異常，但是看網(wǎng)上好多文章寫的都是捕獲ConstraintViolationException異常，

比較以上三種校驗(yàn)方式（準(zhǔn)確的說應(yīng)該是三種hibernate validator的使用方式），可以發(fā)現(xiàn)2、3大同小異，使用@Valid可以不用再自己寫校驗(yàn)的處理方法，但是方式1可以更加靈活，可以按照自己需求處理和組織校驗(yàn)的返回信息。

hibernate validator的更詳細(xì)的使用說明，可以參考官方文檔，以前沒關(guān)注，這次認(rèn)真的看了一下，發(fā)現(xiàn)hibernate validator的功能還是很強(qiáng)大的，最新的5.0、6.0版本只有英文文檔，4.0版本有中文文檔。地址如下：https://docs.jboss.org/hibern...

使用方式1，在我自己電腦注解沒有添加message信息時(shí)，默認(rèn)返回的是中文，如@NotNull：不能為null，@NotEmpty：不能為空等等，但是，當(dāng)部署到服務(wù)器以后，就變成英文，如@NotNull：may not be null，@NotEmpty：may not be empty等等，很是詭異。后來研讀源碼發(fā)現(xiàn)，hibernate validator通過messageInterpolator字段來實(shí)現(xiàn)國際化的，messageInterpolator字段中存放著當(dāng)前操作系統(tǒng)的語言環(huán)境參數(shù)，然后根據(jù)語言環(huán)境參數(shù)去對(duì)應(yīng)的配置文檔中讀取默認(rèn)提示信息，而messageInterpolator則會(huì)在項(xiàng)目啟動(dòng)時(shí)初始化，因?yàn)槲易约旱碾娔X是中文環(huán)境，而公司的系統(tǒng)環(huán)境是英文的，所以導(dǎo)致這個(gè)問題。