前言

你還在為校驗入?yún)r寫的那一串 if...else... 而苦惱嘛？
你還在為了編寫一個功能全面的參數(shù)校驗器而夜夜不寐嘛？
No~ NoNo~ NoNoNo~ No！
人生苦短，大可不必講寶貴的編程時間耗費在這些事情上~
是時候換個活法啦！有現(xiàn)成的工具，拿去用吧！
賣個萌。。。(?ω?)

public class User {
    @NotBlank(message = "用戶名不能為空")
    private String name;
 
    @NotBlank(message = "ERP不能為空")
    @Size(min = 3, message = "ERP長度不能小于3")
    private String erp;
 
    @Min(value = 22, message = "年齡不能低于22歲")
    private int age;
 
    // ... getter and setter
}

看看上面這種參數(shù)校驗，多么的 優(yōu)雅~
直接通過在屬性上寫注解就可以達(dá)到給參數(shù)增加校驗規(guī)則的目的啦！

基于注解的參數(shù)校驗器

JSR303

JSR303是一套JavaBean參數(shù)校驗的 標(biāo)準(zhǔn)，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們JavaBean的屬性上面，就可以在需要校驗的時候進(jìn)行校驗了。

image.png

ps. 沒有列舉全，感興趣的可以看JSR303官方文檔。

Hibernate Validator

Hibernate Validator在JSR303的基礎(chǔ)上對校驗注解進(jìn)行了擴(kuò)展

image.png

ps. 同樣沒列舉全，大家感興趣可以看Hibernate Validator官方文檔。

Hibernate Validator就決定是你了

基本上Hibernate validator就包括了所有常用的校驗規(guī)則，而且它又是在JSR303基礎(chǔ)上的擴(kuò)展，所以直接 推薦使用 Hibernate Validator了。

Hibernate Validator版本

image.png

可以看到Hibernate validator目前有兩個穩(wěn)定的版本，各取所需。
這篇文章里面的例子用到的版本是 5.4.2.Final。

Maven引用

<dependency>
   <groupId>org.hibernate</groupId>
   <artifactId>hibernate-validator</artifactId>
   <version>5.4.2.Final</version>
</dependency>

image.png

代碼實現(xiàn)

對Object的屬性進(jìn)行校驗

// Bean屬性上添加相應(yīng)的注解，設(shè)置校驗規(guī)則
public class User {
    @NotBlank(message = "用戶名不能為空")
    private String name;
    @NotBlank(message = "ERP不能為空")
    @Size(min = 3, message = "ERP長度不能小于3")
    private String erp;
    @Min(value = 22, message = "年齡不能低于22歲")
    private int age;
 
    // ... getter and setter
}

如上，給 User 這個Bean的三個屬性增加了相應(yīng)的規(guī)則，message 后面規(guī)定的是校驗不通過時報的錯誤信息文案：

用戶名name字段不能為null，也不能為空字符串（會過濾空格）。
用戶erp字段不能為null，也不能為空字符串（會過濾空格），且字符串長度不能小于3。
用戶年齡age字段不能小于22。

// Controller的接口參數(shù)前面添加@Valid注解
import javax.validation.Valid;
 
@Controller
@RequestMapping(value = "/validate")
public class ValidateDemoController {
 
    @RequestMapping(value = "/user", method = RequestMethod.POST)
    @ResponseBody
    public String printValidatedUserInfo(@RequestBody @Valid User user) {
        return user.toString();
    }
 
}

如上，在Controller的接口參數(shù)（剛定義的Bean）之前添加 @Valid 注解。
這樣就可以用啦，校驗不通過的時候會拋出異常，具體怎么處理異常就根據(jù)自己的項目需要來吧。

分組校驗

有的時候，在不同場景下我們需要對同一個Bean里面的不同參數(shù)進(jìn)行校驗。
比如說，在新增用戶的時候我需要校驗姓名、erp和年齡，而在修改用戶的時候我只需要校驗erp。
又或者，部門A的員工的年齡不能低于22歲，無上限；而部門B的員工年齡不能高于35歲，無下限。
難道我們需要根據(jù)每一個場景都增加一個Bean嘛？會不會有點太浪費？
不用的！這里提供了一個分組的概念，不同的規(guī)則可以劃分到不同的組里面，校驗的時候選擇相應(yīng)的組，就會只校驗該組下面的所有規(guī)則。

// 首先定義兩個接口，作為兩個分組
public interface UserValidGroupOne {
}
 
public interface UserValidGroupTwo {
}

定義兩個接口 UserValidGroupOne 和 UserValidGroupTwo，作為兩個分組。

// Bean參數(shù)校驗規(guī)則劃分為兩個組
public class UserByGroup {
    @NotBlank(groups = {UserValidGroupOne.class, UserValidGroupTwo.class}, message = "用戶名不能為空")
    private String name;
 
    @NotBlank(groups = {UserValidGroupOne.class, UserValidGroupTwo.class}, message = "ERP不能為空")
    @Size(min = 3, groups = {UserValidGroupOne.class, UserValidGroupTwo.class}, message = "ERP長度不能小于3")
    private String erp;
 
    @Min(value = 22, groups = {UserValidGroupOne.class}, message = "年齡不能低于22歲")
    @Max(value = 35, groups = {UserValidGroupTwo.class}, message = "年齡不能高于35歲")
    private int age;
 
    // ... getter and setter
}

屬性前寫相應(yīng)注解增加校驗規(guī)則，注解里面的 groups 屬性表示這條規(guī)則屬于哪個分組，不加 groups 則表示在使用 Deafault 規(guī)則時起作用。
比如上面代碼中描述的是：

name和erp字段的校驗規(guī)則同屬于兩個分組。
age字段的校驗規(guī)則，在分組1中不能小于22，而在分組2中不能大于35。

//接口參數(shù)前面注明要用哪個分組的規(guī)則來進(jìn)行校驗
import org.springframework.validation.annotation.Validated;
 
@Controller
@RequestMapping(value = "/validate")
public class ValidateDemoController {
     
    @RequestMapping(value = "/userByGroup1", method = RequestMethod.POST)
    @ResponseBody
    public String printValidatedUserInfoByGroupOne(@RequestBody @Validated(value = {UserValidGroupOne.class}) UserByGroup userByGroup) {
        return userByGroup.toString();
    }
 
    @RequestMapping(value = "/userByGroup2", method = RequestMethod.POST)
    @ResponseBody
    public String printValidatedUserInfoByGroupTwo(@RequestBody @Validated(value = {UserValidGroupTwo.class}) UserByGroup userByGroup) {
        return userByGroup.toString();
    }
 
}

如上，在Controller的接口參數(shù)（剛定義的Bean）之前添加 @Validated 注解，注意不是 在【對Object的屬性進(jìn)行校驗】時講的 @Valid 注解。
在 @Validated 的 value 屬性上注明要使用的規(guī)則分組。
可寫多個分組，但是只有第一個分組才生效。
若使用 @Valid 則表示使用 默認(rèn) 校驗規(guī)則。

自定義注解

雖然Hibernate Validator提供了基本上所有常用的校驗規(guī)則，可還是有些場景不能滿足。
比如說，現(xiàn)在需要一個校驗規(guī)則，一個List中不能包含null。Hibernate Validator并沒有提供相應(yīng)注解。
這時候就需要我們自定義注解，來擴(kuò)展工具，滿足我們自己的需求。

//自定義參數(shù)校驗注解，校驗List集合中是否有null元素
import com.jd.ershou.service.impl.ListNotHasNullValidatorImpl;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
 
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
/**
 * 自定義參數(shù)校驗注解
 * 校驗 List 集合中是否有null 元素
 * Created by weixiaoyu on 2018/5/2.
 */
@Target({ANNOTATION_TYPE, METHOD, FIELD})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = ListNotHasNullValidatorImpl.class)
public @interface ListNotHasNull {
    /**
     * 添加value屬性，可以作為校驗時的條件,若不需要，可去掉此處定義
     */
    int value() default 0;
 
    String message() default "List集合中不能含有null元素";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
 
    /**
     * 定義List，為了讓Bean的一個屬性上可以添加多套規(guī)則
     */
    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        ListNotHasNull[] value();
    }
 
}

首先定義自定義注解 @ListNotHasNull，校驗List中不能含有null元素，注明其注解實現(xiàn)類為 ListNotHasNullValidatorImpl.class。
接下來編寫實現(xiàn)類的邏輯。

//注解@ListNotHasNull的實現(xiàn)類
import org.springframework.stereotype.Service;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.List;
 
/**
 * 自定義注解ListNotHasNull的實現(xiàn)類
 * 用于判斷List集合中是否含有null元素
 * Created by weixiaoyu on 2018/5/2.
 */
@Service
public class ListNotHasNullValidatorImpl implements ConstraintValidator<ListNotHasNull, List> {
     
    private int value;
 
    @Override
    public void initialize(ListNotHasNull constraintAnnotation) {
        // 傳入value值，可以在校驗中使用
        this.value = constraintAnnotation.value();
    }
 
    @Override
    public boolean isValid(List list, ConstraintValidatorContext constraintValidatorContext) {
        if (list != null) {
            for (Object object : list) {
                if (object == null) {
                    //如果List集合中含有Null元素，校驗失敗
                    return false;
                }
            }
        }
        return true;
    }
 
}

自定義注解的實現(xiàn)類實現(xiàn)了 ConstraintValidator 接口。
重要的是要重寫 isValid 方法，其中的邏輯就是需要的校驗規(guī)則。
接下來是測試用例。

//Bean的屬性中含有List
public class Person {
    @NotBlank(message = "姓名不能為空")
    private String name;
 
    @NotBlank(message = "性別不能為空")
    private String sex;
 
    @NotEmpty(message = "家庭成員不能為空")
    @ListNotHasNull(message = "所有家庭成員信息中不能有為null的")
    @Valid // 此處加@Valid注解的原因是注明要遞歸校驗，加上這個注解就會遞歸校驗List中每個元素的屬性是否符合規(guī)則
    private List<FamilyMember> familyMembers;
     
    // ... getter and setter
}

家庭成員 familyMembers 是一個List，其中每一個元素都是 FamilyMember 類。
在 familyMembers 上增加剛才自定義的 @ListNotHasNull 注解。
ps. 此處加 @Valid 注解的原因是注明要遞歸校驗，加上這個注解就會遞歸校驗List中每個元素 FamilyMember 的屬性是否符合其內(nèi)部定義規(guī)則。

//Controller的接口參數(shù)前面添加@Valid注解
import javax.validation.Valid;
 
@Controller
@RequestMapping(value = "/validate")
public class ValidateDemoController {
 
    @RequestMapping(value = "/person", method = RequestMethod.POST)
    @ResponseBody
    public String printValidatedPersonInfo(@RequestBody @Valid Person person) {
        return person.toString();
    }
 
}

同樣，在Controller的接口參數(shù)（剛定義的Bean）之前添加 @Valid 注解，校驗不通過則拋出異常。

Spring validator方法級別的校驗

JSR和Hibernate Validator的校驗只能對Object的屬性進(jìn)行校驗，不能對單個的參數(shù)進(jìn)行校驗。
Spring在此基礎(chǔ)上進(jìn)行了擴(kuò)展，添加了 MethodValidationPostProcessor 攔截器，可以實現(xiàn)對方法參數(shù)的校驗。
首先需要將 MethodValidationPostProcessor 注入到Spring容器中。

//注入到Spring容器中
@Configuration
public class PpValidatorBeanConfigurer {
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}

這里是通過Java Bean的方式，用 @Bean 注解，將 MethodValidationPostProcessor 注入到Spring容器中的。
也可以通過配置 xml 文件的方式，根據(jù)項目的需要選擇使用。

//在Controller類上添加@Validated注解，在接口方法的每一個參數(shù)前面添加相應(yīng)校驗規(guī)則注解
@Controller
@RequestMapping(value = "/validate")
@Validated
public class ValidateMethodController {
 
    @RequestMapping(value = "/param", method = RequestMethod.GET)
    @ResponseBody
    public String printValidatedParam(
            @NotBlank(message = "用戶名不能為空") String name,
            @Size(min = 3, message = "ERP長度不能小于3") String erp,
            @Min(value = 22, message = "年齡不能低于22歲") int age) {
 
        String msg = "name=" + name + ", erp=" + erp + ", age=" + age;
        return msg;
    }
 
}

需要在Controller類的上方添加 @Validated 注解，然后在接口方法的每一個參數(shù)前面添加相應(yīng)的校驗規(guī)則注解。
這樣方法級別的校驗就比較靈活了不是~

異常處理

之前一直在說，校驗不通過的時候會 拋出異常，具體異常如何處理請根據(jù)自己的項目需要來。
但具體都拋出哪些異常，如何處理，我這邊在寫測試用例的時候捕獲到了如下三類異常：

org.springframework.validation.BindException org.springframework.web.bind.MethodArgumentNotValidException
javax.validation.ConstraintViolationException

推薦使用 @ControllerAdvice 搭配 @ExceptionHandler 來捕獲Controller層拋出來的異常。
寫了簡單的處理邏輯，僅供參考。

//異常處理
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.BindException;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.Set;
 
/**
 * Created by weixiaoyu on 2018/5/2.
 */
@ControllerAdvice
public class PpValidatorExceptionHandler {
    private static final Logger LOGGER = LoggerFactory.getLogger(PpValidatorExceptionHandler.class);
 
    @ExceptionHandler(Throwable.class)
    @ResponseBody
    public String handleThrowableException(Throwable ex) {
        LOGGER.error("PpValidatorExceptionHandler.handleThrowableException", ex);
        String msg = "Throwable error: " + ex.toString();
        return msg;
    }
 
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public String handleBindException(BindException e1) {
        LOGGER.error("PpValidatorExceptionHandler.handleBindException", e1);
        List<ObjectError> errors = e1.getAllErrors();
        StringBuilder stringBuilder = new StringBuilder();
        for (ObjectError error : errors) {
            if (stringBuilder.length() != 0) {
                stringBuilder.append("，");
            }
            stringBuilder.append(error.getDefaultMessage());
        }
        String msg ="BindException error: " + stringBuilder.toString();
        return msg;
    }
 
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public String handleMethodArgumentNotValidException(MethodArgumentNotValidException e2) {
        List<ObjectError> errors = e2.getBindingResult().getAllErrors();
        StringBuilder stringBuilder = new StringBuilder();
        for (ObjectError error : errors) {
            if (stringBuilder.length() != 0) {
                stringBuilder.append("，");
            }
            stringBuilder.append(error.getDefaultMessage());
        }
        String msg ="MethodArgumentNotValidException error: " + stringBuilder.toString();
        return msg;
    }
 
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public String handleConstraintViolationException(ConstraintViolationException e3) {
        Set<ConstraintViolation<?>> violations = e3.getConstraintViolations();
        StringBuilder stringBuilder = new StringBuilder();
        for (ConstraintViolation<?> violation : violations) {
            if (stringBuilder.length() != 0) {
                stringBuilder.append("，");
            }
            stringBuilder.append(violation.getMessage());
        }
        String msg ="ConstraintViolationException error: " + stringBuilder.toString();
        return msg;
    }
 
}

結(jié)語

安利了這么多，覺得好使不？
那必須好使啊~~~
部門在我的安利下所有新項目都在用 Hibernate Validator 參數(shù)校驗器，經(jīng)過了多種線上環(huán)境驗證。大家就放心去用吧~
最后，有問題的話咱們共同探討~ 共同學(xué)習(xí)~ 共同進(jìn)步哈~

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

【擴(kuò)】基于注解的參數(shù)校驗器Hibernate Validator

【擴(kuò)】基于注解的參數(shù)校驗器Hibernate Validator

前言

基于注解的參數(shù)校驗器

JSR303

Hibernate Validator

Hibernate Validator在JSR303的基礎(chǔ)上對校驗注解進(jìn)行了擴(kuò)展

Hibernate Validator就決定是你了

Hibernate Validator版本

Maven引用

代碼實現(xiàn)

對Object的屬性進(jìn)行校驗

分組校驗

自定義注解

Spring validator方法級別的校驗

異常處理

結(jié)語

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

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

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九 欧美,1769亚洲,黄色成人av

【擴(kuò)】基于注解的參數(shù)校驗器Hibernate Validator

前言

基于注解的參數(shù)校驗器

JSR303

Hibernate Validator

Hibernate Validator在JSR303的基礎(chǔ)上對校驗注解進(jìn)行了擴(kuò)展

Hibernate Validator就決定是你了

Hibernate Validator版本

Maven引用

代碼實現(xiàn)

對Object的屬性進(jìn)行校驗

分組校驗

自定義注解

Spring validator方法級別的校驗

異常處理

結(jié)語

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

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

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av