來源：http://rrd.me/eqsVq
為什么要用validator
實(shí)戰(zhàn)演練
自定義參數(shù)注解
總結(jié)
很痛苦遇到大量的參數(shù)進(jìn)行校驗(yàn),在業(yè)務(wù)中還要拋出異常或者 不斷的返回異常時(shí)的校驗(yàn)信息,在代碼中相當(dāng)冗長, 充滿了if-else這種校驗(yàn)代碼,今天我們就來學(xué)習(xí)spring的javax.validation 注解式參數(shù)校驗(yàn).為什么要用validator
javax.validation的一系列注解可以幫我們完成參數(shù)校驗(yàn),免去繁瑣的串行校驗(yàn)不然我們的代碼就像下面這樣:
// http://localhost:8080/api/user/save/serial
/**
* 走串行校驗(yàn)
*
* @param userVO
* @return
*/
@PostMapping('/save/serial')
public Object save(@RequestBody UserVO userVO) {
String mobile = userVO.getMobile();
//手動(dòng)逐個(gè) 參數(shù)校驗(yàn)~ 寫法
if (StringUtils.isBlank(mobile)) {
return RspDTO.paramFail('mobile:手機(jī)號(hào)碼不能為空');
} else if (!Pattern.matches('^[1][3,4,5,6,7,8,9][0-9]{9}$', mobile)) {
return RspDTO.paramFail('mobile:手機(jī)號(hào)碼格式不對(duì)');
}
//拋出自定義異常等~寫法
if (StringUtils.isBlank(userVO.getUsername())) {
throw new BizException(Constant.PARAM_FAIL_CODE, '用戶名不能為空');
}
// 比如寫一個(gè)map返回
if (StringUtils.isBlank(userVO.getSex())) {
Map<String, Object> 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參數(shù)校驗(yàn)的標(biāo)準(zhǔn)，它定義了很多常用的校驗(yàn)注解，我們可以直接將這些注解加在我們JavaBean的屬性上面(面向注解編程的時(shí)代)，就可以在需要校驗(yàn)的時(shí)候進(jìn)行校驗(yàn)了,在SpringBoot中已經(jīng)包含在starter-web中,再其他項(xiàng)目中可以引用依賴,并自行調(diào)整版本: <!--jsr 303-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
</dependency>
<!-- hibernate validator-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.0.Final</version>
</dependency>
注解說明
1.@NotNull：不能為null，但可以為empty('',' ',' ')
2.@NotEmpty：不能為null，而且長度必須大于0 (' ',' ')
3.@NotBlank：只能作用在String上，不能為null，而且調(diào)用trim()后，長度必須大于0('test') 即：必須有實(shí)際字符
驗(yàn)證注解驗(yàn)證的數(shù)據(jù)類型說明
@AssertFalseBoolean,boolean驗(yàn)證注解的元素值是false
@AssertTrueBoolean,boolean驗(yàn)證注解的元素值是true
@NotNull任意類型驗(yàn)證注解的元素值不是null
@Null任意類型驗(yàn)證注解的元素值是null
@Min(value=值)BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存儲(chǔ)的是數(shù)字）子類型驗(yàn)證注解的元素值大于等于@Min指定的value值
@Max（value=值）和@Min要求一樣驗(yàn)證注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)和@Min要求一樣驗(yàn)證注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)和@Min要求一樣驗(yàn)證注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整數(shù)位數(shù), fraction=小數(shù)位數(shù))和@Min要求一樣驗(yàn)證注解的元素值的整數(shù)位數(shù)和小數(shù)位數(shù)上限
@Size(min=下限, max=上限)字符串、Collection、Map、數(shù)組等驗(yàn)證注解的元素值的在min和max（包含）指定區(qū)間之內(nèi)，如字符長度、集合大小
@Pastjava.util.Date,java.util.Calendar;Joda Time類庫的日期類型驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間早
@Future與@Past要求一樣驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間晚
@NotBlankCharSequence子類型驗(yàn)證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的首位空格
@Length(min=下限, max=上限)CharSequence子類型驗(yàn)證注解的元素值長度在min和max區(qū)間內(nèi)
@NotEmptyCharSequence子類型、Collection、Map、數(shù)組驗(yàn)證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0）
@Range(min=最小值, max=最大值)BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類型和包裝類型驗(yàn)證注解的元素值在最小值和最大值之間
@Email(regexp=正則表達(dá)式,flag=標(biāo)志的模式)CharSequence子類型（如String）驗(yàn)證注解的元素值是Email，也可以通過regexp和flag指定自定義的email格式
@Pattern(regexp=正則表達(dá)式,flag=標(biāo)志的模式)String，任何CharSequence的子類型驗(yàn)證注解的元素值與指定的正則表達(dá)式匹配
@Valid任何非原子類型指定遞歸驗(yàn)證關(guān)聯(lián)的對(duì)象如用戶對(duì)象中有個(gè)地址對(duì)象屬性，如果想在驗(yàn)證用戶對(duì)象時(shí)一起驗(yàn)證地址對(duì)象的話，在地址對(duì)象上加@Valid注解即可級(jí)聯(lián)驗(yàn)證
此處只列出Hibernate Validator提供的大部分驗(yàn)證約束注解，請參考hibernate validator官方文檔了解其他驗(yàn)證約束注解和進(jìn)行自定義的驗(yàn)證約束注解定義。
實(shí)戰(zhàn)演練
話不多說,直接走實(shí)踐路線,同樣使用的是SpringBoot的快速框架,詳細(xì)代碼見:github.com/leaJone/myb…
1. @Validated 聲明要檢查的參數(shù)
這里我們在控制器層進(jìn)行注解聲明
/**
* 走參數(shù)校驗(yàn)注解
*
* @param userDTO
* @return
*/
@PostMapping('/save/valid')
public RspDTO save(@RequestBody @Validated UserDTO userDTO) {
userService.save(userDTO);
return RspDTO.success();
}
2. 對(duì)參數(shù)的字段進(jìn)行注解標(biāo)注
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: 用戶傳輸對(duì)象
* @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個(gè)字符')
@Pattern(regexp = '^[\u4E00-\u9FA5A-Za-z0-9\*]*$', message = '用戶昵稱限制：最多20字符，包含文字、字母和數(shù)字')
private String username;
/** 手機(jī)號(hào)*/
@NotBlank(message = '手機(jī)號(hào)不能為空')
@Pattern(regexp = '^[1][3,4,5,6,7,8,9][0-9]{9}$', message = '手機(jī)號(hào)格式有誤')
private String mobile;
/**性別*/
private String sex;
/** 郵箱*/
@NotBlank(message = '聯(lián)系郵箱不能為空')
@Email(message = '郵箱格式不對(duì)')
private String email;
/** 密碼*/
private String password;
/*** 創(chuàng)建時(shí)間 */
@Future(message = '時(shí)間必須是將來時(shí)間')
private Date createTime;
}
3. 在全局校驗(yàn)中增加校驗(yàn)異常
MethodArgumentNotValidException是springBoot中進(jìn)行綁定參數(shù)校驗(yàn)時(shí)的異常,需要在springBoot中處理,其他需要 處理ConstraintViolationException異常進(jìn)行處理.
為了優(yōu)雅一點(diǎn),我們將參數(shù)異常,業(yè)務(wù)異常,統(tǒng)一做了一個(gè)全局異常,將控制層的異常包裝到我們自定義的異常中
為了優(yōu)雅一點(diǎn),我們還做了一個(gè)統(tǒng)一的結(jié)構(gòu)體,將請求的code,和msg,data一起統(tǒng)一封裝到結(jié)構(gòu)體中,增加了代碼的復(fù)用性
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());
}
/**
* 方法參數(shù)校驗(yàn)
*/
@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, '數(shù)據(jù)重復(fù)，請檢查后提交');
}
@ExceptionHandler(Exception.class)
public RspDTO handleException(Exception e) {
logger.error(e.getMessage(), e);
return new RspDTO(500, '系統(tǒng)繁忙,請稍后再試');
}
}
4. 測試
如下文:確實(shí)做到了參數(shù)校驗(yàn)時(shí)返回異常信息和對(duì)應(yīng)的code,方便了我們不再繁瑣的處理參數(shù)校驗(yàn)
在ValidationMessages.properties 就是校驗(yàn)的message,有著已經(jīng)寫好的默認(rèn)的message,且是支持i18n的,大家可以閱讀源碼賞析
自定義參數(shù)注解
1. 比如我們來個(gè) 自定義身份證校驗(yàn) 注解
@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdentityCardNumberValidator.class)
public @interface IdentityCardNumber {
String message() default '身份證號(hào)碼不合法';
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
這個(gè)注解是作用在Field字段上，運(yùn)行時(shí)生效，觸發(fā)的是IdentityCardNumber這個(gè)驗(yàn)證類。
message 定制化的提示信息，主要是從ValidationMessages.properties里提取，也可以依據(jù)實(shí)際情況進(jìn)行定制
groups 這里主要進(jìn)行將validator進(jìn)行分類，不同的類group中會(huì)執(zhí)行不同的validator操作
payload 主要是針對(duì)bean的，使用不多。
2. 然后自定義Validator
這個(gè)是真正進(jìn)行驗(yàn)證的邏輯代碼：
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在項(xiàng)目源碼中,可自行查看
3. 使用自定義的注解
@NotBlank(message = '身份證號(hào)不能為空')
@IdentityCardNumber(message = '身份證信息有誤,請核對(duì)后提交')
private String clientCardNo;
4.使用groups的校驗(yàn)
有的寶寶說同一個(gè)對(duì)象要復(fù)用,比如UserDTO在更新時(shí)候要校驗(yàn)userId,在保存的時(shí)候不需要校驗(yàn)userId,在兩種情況下都要校驗(yàn)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{
}
再在需要校驗(yàn)的地方@Validated聲明校驗(yàn)組
/**
* 走參數(shù)校驗(yàn)注解的 groups 組合校驗(yàn)
*
* @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個(gè)字符', groups = {Create.class, Update.class})
@Pattern(regexp = '^[\u4E00-\u9FA5A-Za-z0-9\*]*$', message = '用戶昵稱限制：最多20字符，包含文字、字母和數(shù)字')
private String username;
/**
* 手機(jī)號(hào)
*/
@NotBlank(message = '手機(jī)號(hào)不能為空')
@Pattern(regexp = '^[1][3,4,5,6,7,8,9][0-9]{9}$', message = '手機(jī)號(hào)格式有誤', groups = {Create.class, Update.class})
private String mobile;
/**
* 性別
*/
private String sex;
/**
* 郵箱
*/
@NotBlank(message = '聯(lián)系郵箱不能為空')
@Email(message = '郵箱格式不對(duì)')
private String email;
/**
* 密碼
*/
private String password;
/*** 創(chuàng)建時(shí)間 */
@Future(message = '時(shí)間必須是將來時(shí)間', groups = {Create.class})
private Date createTime;
}
注意:在聲明分組的時(shí)候盡量加上 extend javax.validation.groups.Default否則,在你聲明@Validated(Update.class)的時(shí)候,就會(huì)出現(xiàn)你在默認(rèn)沒添加groups = {}的時(shí)候的校驗(yàn)組@Email(message = '郵箱格式不對(duì)'),會(huì)不去校驗(yàn),因?yàn)槟J(rèn)的校驗(yàn)組是groups = {Default.class}.
5.restful風(fēng)格用法
在多個(gè)參數(shù)校驗(yàn),或者@RequestParam 形式時(shí)候,需要在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<User>().nonAbsent('用戶不存在');
}
return new RspDTO<User>().success(user);
}
@RestController
@RequestMapping('user/')
@Validated
public class UserController extends AbstractController {
....圣洛代碼...
總結(jié)
用起來很簡單,soEasy,重點(diǎn)參與的統(tǒng)一結(jié)構(gòu)體返回,統(tǒng)一參數(shù)校驗(yàn),是減少我們代碼大量的try catch 的法寶,我覺得在項(xiàng)目中,將異常處理好,并將異常做好日志管理,才是很好的升華,文章淺顯,只是一個(gè)菜鳥的進(jìn)階筆記….
這里只是個(gè)人見解,技術(shù)菜,歡迎大佬不吝賜教… 我是一個(gè)小白,技術(shù)在不斷的更新迭代,我只有不斷的填充自己的空白才能….跟上大佬們的步伐…
