javax.validation 引數驗證
阿新 • • 發佈：2020-07-31
為什麼要用validator
1. javax.validation的一系列註解可以幫我們完成引數校驗,免去繁瑣的序列校驗
2.什麼是javax.validation
<!--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>
3.註解說明
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（包含）指定區間之內，如字元長度、集合大小 |
| @Past | java.util.Date,java.util.Calendar;Joda Time類庫的日期型別 | 驗證註解的元素值（日期型別）比當前時間早 |
| @Future | 與@Past要求一樣 | 驗證註解的元素值（日期型別）比當前時間晚 |
| @NotBlank | CharSequence子型別 | 驗證註解的元素值不為空（不為null、去除首位空格後長度為0），不同於@NotEmpty，@NotBlank只應用於字串且在比較時會去除字串的首位空格 |
| @Length(min=下限, max=上限) | CharSequence子型別 | 驗證註解的元素值長度在min和max區間內 |
| @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註解即可級聯驗證 |
實戰演練
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; @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; /*** 建立時間 */ @Future(message = "時間必須是將來時間") private Date createTime; }
3. 在全域性校驗中增加校驗異常
import cn.hutool.core.util.StrUtil; import com.eyxyt.basement.bean.Result; import com.eyxyt.basement.enums.ResultEnum; import com.eyxyt.basement.exception.CustomException; import com.eyxyt.basement.exception.UnauthorizedException; import lombok.extern.slf4j.Slf4j; import org.apache.shiro.ShiroException; import org.apache.shiro.authz.AuthorizationException; import org.apache.shiro.authz.UnauthenticatedException; import org.springframework.dao.DuplicateKeyException; import org.springframework.http.HttpStatus; import org.springframework.web.HttpRequestMethodNotSupportedException; import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.*; import org.springframework.web.servlet.NoHandlerFoundException; import javax.servlet.http.HttpServletRequest; import javax.xml.bind.ValidationException; import java.util.StringJoiner; /** * 異常控制處理器 * @author cd.wang * @create 2020-07-15 14:39 * @since 1.0.0 */ @Slf4j @RestControllerAdvice public class CustomExceptionHandler { /** * 捕捉其他所有自定義異常 * @return */ @ExceptionHandler(CustomException.class) public Result handle(CustomException e) { if(StrUtil.isBlank(e.getText())){ e.setText(ResultEnum.ERROR.getText()); } return Result.error(e); } /** * 捕捉401 未授權異常 * @return */ @ExceptionHandler(UnauthorizedException.class) public Result handle(UnauthorizedException e) { return Result.error(ResultEnum.UNAUTHORIZED.getCode(), e.getMessage(), ResultEnum.UNAUTHORIZED.getText()); } /** * 捕捉所有Shiro異常 * @param e * @return */ @ExceptionHandler(ShiroException.class) public Result handle401(ShiroException e) { log.error("Shiro 異常 (" + e.getMessage() + ")"); return Result.error(ResultEnum.UNAUTHORIZED); } @ExceptionHandler(AuthorizationException.class) public Result handleAuthorizationException(AuthorizationException e){ log.error("Token 異常 (" + e.getMessage() + ")"); return Result.error(ResultEnum.UNAUTHORIZED); } /** * 單獨捕捉Shiro(UnauthorizedException)異常 * 該異常為訪問有許可權管控的請求而該使用者沒有所需許可權所丟擲的異常 * @param e * @return */ @ExceptionHandler(org.apache.shiro.authz.UnauthorizedException.class) public Result handle401(org.apache.shiro.authz.UnauthorizedException e) { log.error("無權訪問(Unauthorized):當前Subject沒有此請求所需許可權(" + e.getMessage() + ")"); return Result.error(ResultEnum.UNAUTHORIZED); } /** * 單獨捕捉Shiro(UnauthenticatedException)異常 * 該異常為以遊客身份訪問有許可權管控的請求無法對匿名主體進行授權，而授權失敗所丟擲的異常 * @param e * @return */ @ExceptionHandler(UnauthenticatedException.class) public Result handle401(UnauthenticatedException e) { log.error("無權訪問(Unauthorized):當前Subject是匿名Subject，請先登入(This subject is anonymous.)"); return Result.error(ResultEnum.UNAUTHORIZED); } /** * 方法引數校驗 */ @ExceptionHandler(MethodArgumentNotValidException.class) public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { log.error(e.getMessage(), e); // 按需重新封裝需要返回的錯誤資訊 解析原錯誤資訊， // 封裝後返回，此處返回非法的欄位名稱error.getField()， // 原始值error.getRejectedValue()，錯誤資訊 StringJoiner sj = new StringJoiner(";"); e.getBindingResult().getFieldErrors().forEach(x -> sj.add(x.getDefaultMessage())); return Result.error(ResultEnum.PARAM_ERROR, sj.toString()); } /** * ValidationException */ @ExceptionHandler(ValidationException.class) public Result handleValidationException(ValidationException e) { log.error(e.getMessage(), e); return Result.error(ResultEnum.PARAM_ERROR, e.getCause().getMessage()); } /** * ConstraintViolationException */ @ExceptionHandler(ConstraintViolationException.class) public Result handleConstraintViolationException(ConstraintViolationException e) { log.error(e.getMessage(), e); StringJoiner sj = new StringJoiner(";"); e.getConstraintViolations().forEach(x -> sj.add(x.getMessageTemplate())); return Result.error(ResultEnum.PARAM_ERROR, sj.toString()); } /** * 方法請求異常 * @param e * @return */ @ExceptionHandler(HttpRequestMethodNotSupportedException.class) public Result handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) { log.error(e.getMessage(), e); return Result.error(Constant.METHOD_NOT_SUPPORTED, "不支援'" + e.getMethod() + "'請求方法"); } /** * 捕捉404異常 * @return */ @ExceptionHandler(NoHandlerFoundException.class) public Result handle(NoHandlerFoundException e) { return Result.error(ResultEnum.NOT_FOUND); } /** * 捕捉資料庫異常 * @return */ @ExceptionHandler(DuplicateKeyException.class) public Result handle(DuplicateKeyException e) { return Result.error(ResultEnum.DATA_EXISTS); } /** * 捕捉其他所有異常 * @param request * @param ex * @return */ @ExceptionHandler(Exception.class) public Result globalException(HttpServletRequest request, Throwable ex) { log.error("--"+ this.getClass().getSimpleName()+"--> " + ex.getMessage()); ex.printStackTrace(); return Result.error(this.getStatus(request).value(), ex.toString() + ": " + ex.getMessage(), ResultEnum.ERROR.getText()); } /** * 獲取狀態碼 * @param request * @return */ private HttpStatus getStatus(HttpServletRequest request) { Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code"); if (statusCode == null) { return HttpStatus.INTERNAL_SERVER_ERROR; } return HttpStatus.valueOf(statusCode); }
自定義引數註解
1. 比如我們來個 自定義身份證校驗 註解
@Documented @Target({ElementType.PARAMETER, ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = IdentityCardNumberValidator.class) public @interface IdentityCardNumber { String message() default "身份證號碼不合法"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
這個註解是作用在Field欄位上，執行時生效，觸發的是IdentityCardNumber這個驗證類。
- message 定製化的提示資訊，主要是從ValidationMessages.properties裡提取，也可以依據實際情況進行定製
- groups 這裡主要進行將validator進行分類，不同的類group中會執行不同的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()); } }
3. 使用自定義的註解
@NotBlank(message = "身份證號不能為空") @IdentityCardNumber(message = "身份證資訊有誤,請核對後提交") private String clientCardNo;
4.使用groups的校驗
1. 先定義groups的分組介面Create和Update
import javax.validation.groups.Default; public interface Create extends Default { } import javax.validation.groups.Default; public interface Update extends Default{ }
同一個物件要複用,比如UserDTO在更新時候要校驗userId,在儲存的時候不需要校驗userId,在兩種情況下都要校驗username,那就用上groups了
2. 再在需要校驗的地方@Validated宣告校驗組
/** * 走引數校驗註解的 groups 組合校驗 * * @param userDTO * @return */ @PostMapping("/update/groups") public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) { userService.updateById(userDTO); return RspDTO.success(); }
3. 在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; /*** 建立時間 */ @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<User>().nonAbsent("使用者不存在");
}
return new RspDTO<User>().success(user);
}
@RestController @RequestMapping("user/") @Validated public class UserController extends AbstractController { }