這么寫參數校驗(Validator)就不會被勸退了~
來自：掘金（作者：錦成同學）
原文鏈接：
https://juejin.im/post/5d3fbeb46fb9a06b317b3c48
- 為什么要用validator
- 實戰(zhàn)演練
- 1. @Validated 聲明要檢查的參數
- 2. 對參數的字段進行注解標注
- 3. 在全局校驗中增加校驗異常
- 4. 測試
- 自定義參數注解
- 1. 比如我們來個 自定義身份證校驗 注解
- 2. 然后自定義Validator
- 3. 使用自定義的注解
- 4.使用groups的校驗
- 5.restful風格用法
- 總結
很痛苦遇到大量的參數進行校驗,在業(yè)務中還要拋出異常或者 不斷的返回異常時的校驗信息,在代碼中相當冗長, 充滿了if-else這種校驗代碼,今天我們就來學習spring的javax.validation 注解式參數校驗.
為什么要用validatorjavax.validation的一系列注解可以幫我們完成參數校驗,免去繁瑣的串行校驗不然我們的代碼就像下面這樣:
?//??http://localhost:8080/api/user/save/serial
????/**
?????*?走串行校驗
?????*
?????*?@param?userVO
?????*?@return
?????*/
????@PostMapping("/save/serial")
????public?Object?save(@RequestBody?UserVO?userVO)?{
????????String?mobile?=?userVO.getMobile();
????????//手動逐個?參數校驗~?寫法
????????if?(StringUtils.isBlank(mobile))?{
????????????return?RspDTO.paramFail("mobile:手機號碼不能為空");
????????}?else?if?(!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$",?mobile))?{
????????????return?RspDTO.paramFail("mobile:手機號碼格式不對");
????????}
????????//拋出自定義異常等~寫法
????????if?(StringUtils.isBlank(userVO.getUsername()))?{
????????????throw?new?BizException(Constant.PARAM_FAIL_CODE,?"用戶名不能為空");
????????}
????????//?比如寫一個map返回
????????if?(StringUtils.isBlank(userVO.getSex()))?{
????????????Map?result?=?new?HashMap<>(5);
????????????result.put("code",?Constant.PARAM_FAIL_CODE);
????????????result.put("msg",?"性別不能為空");
????????????return?result;
????????}
????????//.........各種寫法?...
????????userService.save(userVO);
????????return?RspDTO.success();
????}
這被大佬看見,一定說,都9102了還這么寫,然后被勸退了.....
- 什么是
javax.validation
JSR303 是一套JavaBean參數校驗的標準，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們JavaBean的屬性上面(面向注解編程的時代)，就可以在需要校驗的時候進行校驗了,在SpringBoot中已經包含在starter-web中,再其他項目中可以引用依賴,并自行調整版本:
????????
????????
????????????javax.validation
????????????validation-api
????????????1.1.0.Final
????????
????????
????????
????????????org.hibernate
????????????hibernate-validator
????????????5.2.0.Final
????????
- 注解說明
??????1.@NotNull：不能為null，但可以為empty("","?","???")
??????2.@NotEmpty：不能為null，而且長度必須大于0?("?","??")
??????3.@NotBlank：只能作用在String上，不能為null，而且調用trim()后，長度必須大于0("test")????即：必須有實際字符
| 驗證注解 | 驗證的數據類型 | 說明 |
|---|---|---|
| @AssertFalse | Boolean,boolean | 驗證注解的元素值是false |
| @AssertTrue | Boolean,boolean | 驗證注解的元素值是true |
| @NotNull | 任意類型 | 驗證注解的元素值不是null |
| @Null | 任意類型 | 驗證注解的元素值是null |
| @Min(value=值) | BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存儲的是數字）子類型 | 驗證注解的元素值大于等于@Min指定的value值 |
| @Max（value=值） | 和@Min要求一樣 | 驗證注解的元素值小于等于@Max指定的value值 |
| @DecimalMin(value=值) | 和@Min要求一樣 | 驗證注解的元素值大于等于@ DecimalMin指定的value值 |
| @DecimalMax(value=值) | 和@Min要求一樣 | 驗證注解的元素值小于等于@ DecimalMax指定的value值 |
| @Digits(integer=整數位數, fraction=小數位數) | 和@Min要求一樣 | 驗證注解的元素值的整數位數和小數位數上限 |
| @Size(min=下限, max=上限) | 字符串、Collection、Map、數組等 | 驗證注解的元素值的在min和max（包含）指定區(qū)間之內，如字符長度、集合大小 |
| @Past | java.util.Date,java.util.Calendar;Joda Time類庫的日期類型 | 驗證注解的元素值（日期類型）比當前時間早 |
| @Future | 與@Past要求一樣 | 驗證注解的元素值（日期類型）比當前時間晚 |
| @NotBlank | CharSequence子類型 | 驗證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應用于字符串且在比較時會去除字符串的首位空格 |
| @Length(min=下限, max=上限) | CharSequence子類型 | 驗證注解的元素值長度在min和max區(qū)間內 |
| @NotEmpty | CharSequence子類型、Collection、Map、數組 | 驗證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0） |
| @Range(min=最小值, max=最大值) | BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類型和包裝類型 | 驗證注解的元素值在最小值和最大值之間 |
| @Email(regexp=正則表達式,flag=標志的模式) | CharSequence子類型（如String） | 驗證注解的元素值是Email，也可以通過regexp和flag指定自定義的email格式 |
| @Pattern(regexp=正則表達式,flag=標志的模式) | String，任何CharSequence的子類型 | 驗證注解的元素值與指定的正則表達式匹配 |
| @Valid | 任何非原子類型 | 指定遞歸驗證關聯的對象如用戶對象中有個地址對象屬性，如果想在驗證用戶對象時一起驗證地址對象的話，在地址對象上加@Valid注解即可級聯驗證 |
此處只列出Hibernate Validator提供的大部分驗證約束注解，請參考hibernate validator官方文檔了解其他驗證約束注解和進行自定義的驗證約束注解定義。
實戰(zhàn)演練話不多說,直接走實踐路線,同樣使用的是SpringBoot的快速框架,詳細代碼見:github.com/leaJone/myb…
1. @Validated 聲明要檢查的參數
這里我們在控制器層進行注解聲明
?/**
?????*?走參數校驗注解
?????*
?????*?@param?userDTO
?????*?@return
?????*/
????@PostMapping("/save/valid")
????public?RspDTO?save(@RequestBody?@Validated?UserDTO?userDTO)?{
????????userService.save(userDTO);
????????return?RspDTO.success();
????}
2. 對參數的字段進行注解標注
import?lombok.Data;
import?org.hibernate.validator.constraints.Length;
import?javax.validation.constraints.*;
import?java.io.Serializable;
import?java.util.Date;
/**
?*?@author?LiJing
?*?@ClassName:?UserDTO
?*?@Description:?用戶傳輸對象
?*?@date?2019/7/30?13:55
?*/
@Data
public?class?UserDTO?implements?Serializable?{
????private?static?final?long?serialVersionUID?=?1L;
????/***?用戶ID*/
????@NotNull(message?=?"用戶id不能為空")
????private?Long?userId;
????/**?用戶名*/
????@NotBlank(message?=?"用戶名不能為空")
????@Length(max?=?20,?message?=?"用戶名不能超過20個字符")
????@Pattern(regexp?=?"^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$",?message?=?"用戶昵稱限制：最多20字符，包含文字、字母和數字")
????private?String?username;
????/**?手機號*/
????@NotBlank(message?=?"手機號不能為空")
????@Pattern(regexp?=?"^[1][3,4,5,6,7,8,9][0-9]{9}$",?message?=?"手機號格式有誤")
????private?String?mobile;
????/**性別*/
????private?String?sex;
????/**?郵箱*/
????@NotBlank(message?=?"聯系郵箱不能為空")
????@Email(message?=?"郵箱格式不對")
????private?String?email;
????/**?密碼*/
????private?String?password;
????/***?創(chuàng)建時間?*/
????@Future(message?=?"時間必須是將來時間")
????private?Date?createTime;
}
3. 在全局校驗中增加校驗異常
MethodArgumentNotValidException是springBoot中進行綁定參數校驗時的異常,需要在springBoot中處理,其他需要 處理ConstraintViolationException異常進行處理.
- 為了優(yōu)雅一點,我們將參數異常,業(yè)務異常,統一做了一個全局異常,將控制層的異常包裝到我們自定義的異常中
- 為了優(yōu)雅一點,我們還做了一個統一的結構體,將請求的code,和msg,data一起統一封裝到結構體中,增加了代碼的復用性
import?com.boot.lea.mybot.dto.RspDTO;
import?org.slf4j.Logger;
import?org.slf4j.LoggerFactory;
import?org.springframework.dao.DuplicateKeyException;
import?org.springframework.web.bind.MethodArgumentNotValidException;
import?org.springframework.web.bind.annotation.ExceptionHandler;
import?org.springframework.web.bind.annotation.RestControllerAdvice;
import?org.springframework.web.servlet.NoHandlerFoundException;
import?javax.validation.ConstraintViolationException;
import?javax.validation.ValidationException;
/**
?*?@author?LiJing
?*?@ClassName:?GlobalExceptionHandler
?*?@Description:?全局異常處理器
?*?@date?2019/7/30?13:57
?*/
@RestControllerAdvice
public?class?GlobalExceptionHandler?{
????private?Logger?logger?=?LoggerFactory.getLogger(getClass());
????private?static?int?DUPLICATE_KEY_CODE?=?1001;
????private?static?int?PARAM_FAIL_CODE?=?1002;
????private?static?int?VALIDATION_CODE?=?1003;
????/**
?????*?處理自定義異常
?????*/
????@ExceptionHandler(BizException.class)
????public?RspDTO?handleRRException(BizException?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(e.getCode(),?e.getMessage());
????}
????/**
?????*?方法參數校驗
?????*/
????@ExceptionHandler(MethodArgumentNotValidException.class)
????public?RspDTO?handleMethodArgumentNotValidException(MethodArgumentNotValidException?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(PARAM_FAIL_CODE,?e.getBindingResult().getFieldError().getDefaultMessage());
????}
????/**
?????*?ValidationException
?????*/
????@ExceptionHandler(ValidationException.class)
????public?RspDTO?handleValidationException(ValidationException?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(VALIDATION_CODE,?e.getCause().getMessage());
????}
????/**
?????*?ConstraintViolationException
?????*/
????@ExceptionHandler(ConstraintViolationException.class)
????public?RspDTO?handleConstraintViolationException(ConstraintViolationException?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(PARAM_FAIL_CODE,?e.getMessage());
????}
????@ExceptionHandler(NoHandlerFoundException.class)
????public?RspDTO?handlerNoFoundException(Exception?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(404,?"路徑不存在，請檢查路徑是否正確");
????}
????@ExceptionHandler(DuplicateKeyException.class)
????public?RspDTO?handleDuplicateKeyException(DuplicateKeyException?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(DUPLICATE_KEY_CODE,?"數據重復，請檢查后提交");
????}
????@ExceptionHandler(Exception.class)
????public?RspDTO?handleException(Exception?e)?{
????????logger.error(e.getMessage(),?e);
????????return?new?RspDTO(500,?"系統繁忙,請稍后再試");
????}
}
4. 測試
如下文:確實做到了參數校驗時返回異常信息和對應的code,方便了我們不再繁瑣的處理參數校驗
在ValidationMessages.properties 就是校驗的message,有著已經寫好的默認的message,且是支持i18n的,大家可以閱讀源碼賞析
自定義參數注解1. 比如我們來個 自定義身份證校驗 注解
@Documented
@Target({ElementType.PARAMETER,?ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy?=?IdentityCardNumberValidator.class)
public?@interface?IdentityCardNumber?{
????String?message()?default?"身份證號碼不合法";
????Class[]?groups()?default?{};
????Class[]?payload()?default?{};
}
這個注解是作用在Field字段上，運行時生效，觸發(fā)的是IdentityCardNumber這個驗證類。
- message 定制化的提示信息，主要是從ValidationMessages.properties里提取，也可以依據實際情況進行定制
- groups 這里主要進行將validator進行分類，不同的類group中會執(zhí)行不同的validator操作
- payload 主要是針對bean的，使用不多。
2. 然后自定義Validator
這個是真正進行驗證的邏輯代碼：
public?class?IdentityCardNumberValidator?implements?ConstraintValidator<IdentityCardNumber,?Object>?{
????@Override
????public?void?initialize(IdentityCardNumber?identityCardNumber)?{
????}
????@Override
????public?boolean?isValid(Object?o,?ConstraintValidatorContext?constraintValidatorContext)?{
????????return?IdCardValidatorUtils.isValidate18Idcard(o.toString());
????}
}
IdCardValidatorUtils在項目源碼中,可自行查看
3. 使用自定義的注解
????@NotBlank(message?=?"身份證號不能為空")
????@IdentityCardNumber(message?=?"身份證信息有誤,請核對后提交")
????private?String?clientCardNo;
4.使用groups的校驗
有的寶寶說同一個對象要復用,比如UserDTO在更新時候要校驗userId,在保存的時候不需要校驗userId,在兩種情況下都要校驗username,那就用上groups了:
先定義groups的分組接口
Create和Update
import?javax.validation.groups.Default;
public?interface?Create?extends?Default?{
}
import?javax.validation.groups.Default;
public?interface?Update?extends?Default{
}
再在需要校驗的地方
@Validated聲明校驗組
?/**
?????*?走參數校驗注解的?groups?組合校驗
?????*
?????*?@param?userDTO
?????*?@return
?????*/
????@PostMapping("/update/groups")
????public?RspDTO?update(@RequestBody?@Validated(Update.class)?UserDTO?userDTO)?{
????????userService.updateById(userDTO);
????????return?RspDTO.success();
????}
在DTO中的字段上定義好
groups = {}的分組類型
@Data
public?class?UserDTO?implements?Serializable?{
????private?static?final?long?serialVersionUID?=?1L;
????/***?用戶ID*/
????@NotNull(message?=?"用戶id不能為空",?groups?=?Update.class)
????private?Long?userId;
????/**
?????*?用戶名
?????*/
????@NotBlank(message?=?"用戶名不能為空")
????@Length(max?=?20,?message?=?"用戶名不能超過20個字符",?groups?=?{Create.class,?Update.class})
????@Pattern(regexp?=?"^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$",?message?=?"用戶昵稱限制：最多20字符，包含文字、字母和數字")
????private?String?username;
????/**
?????*?手機號
?????*/
????@NotBlank(message?=?"手機號不能為空")
????@Pattern(regexp?=?"^[1][3,4,5,6,7,8,9][0-9]{9}$",?message?=?"手機號格式有誤",?groups?=?{Create.class,?Update.class})
????private?String?mobile;
????/**
?????*?性別
?????*/
????private?String?sex;
????/**
?????*?郵箱
?????*/
????@NotBlank(message?=?"聯系郵箱不能為空")
????@Email(message?=?"郵箱格式不對")
????private?String?email;
????/**
?????*?密碼
?????*/
????private?String?password;
????/***?創(chuàng)建時間?*/
????@Future(message?=?"時間必須是將來時間",?groups?=?{Create.class})
????private?Date?createTime;
}
注意:在聲明分組的時候盡量加上 extend javax.validation.groups.Default否則,在你聲明@Validated(Update.class)的時候,就會出現你在默認沒添加groups = {}的時候的校驗組@Email(message = "郵箱格式不對"),會不去校驗,因為默認的校驗組是groups = {Default.class}.
5.restful風格用法
在多個參數校驗,或者@RequestParam 形式時候,需要在controller上加注@Validated
?@GetMapping("/get")
????public?RspDTO?getUser(@RequestParam("userId")?@NotNull(message?=?"用戶id不能為空")?Long?userId)?{
????????User?user?=?userService.selectById(userId);
????????if?(user?==?null)?{
????????????return?new?RspDTO().nonAbsent("用戶不存在");
????????}
????????return?new?RspDTO().success(user);
????}
@RestController
@RequestMapping("user/")
@Validated
public?class?UserController?extends?AbstractController?{
....圣洛代碼...
用起來很簡單,soEasy,重點參與的統一結構體返回,統一參數校驗,是減少我們代碼大量的try catch 的法寶,我覺得在項目中,將異常處理好,并將異常做好日志管理,才是很好的升華,文章淺顯,只是一個菜鳥的進階筆記....
這里只是個人見解,技術菜,歡迎大佬不吝賜教... 我是一個小白,技術在不斷的更新迭代,我只有不斷的填充自己的空白才能....跟上大佬們的步伐...
推薦閱讀：
喜歡我可以給我設為星標哦
好文章，我?在看?
評論
圖片
表情