javax.validation 參數驗證

為什么要用validator

1. javax.validation的一系列注解可以幫我們完成參數校驗,免去繁瑣的串行校驗

2. 什么是javax.validation

JSR303 是一套JavaBean參數校驗的標准，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們JavaBean的屬性上面(面向注解編程的時代)，就可以在需要校驗的時候進行校驗了,在SpringBoot中已經包含在starter-web中,再其他項目中可以引用依賴,並自行調整版本:

     <!--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. 注解說明

@Null   被注釋的元素必須為 null    
@NotNull    被注釋的元素必須不為 null    
@AssertTrue     被注釋的元素必須為 true    
@AssertFalse    被注釋的元素必須為 false    
@Min(value)     被注釋的元素必須是一個數字，其值必須大於等於指定的最小值    
@Max(value)     被注釋的元素必須是一個數字，其值必須小於等於指定的最大值    
@DecimalMin(value)  被注釋的元素必須是一個數字，其值必須大於等於指定的最小值    
@DecimalMax(value)  被注釋的元素必須是一個數字，其值必須小於等於指定的最大值    
@Size(max=, min=)   被注釋的元素的大小必須在指定的范圍內    
@Digits (integer, fraction)     被注釋的元素必須是一個數字，其值必須在可接受的范圍內    
@Past   被注釋的元素必須是一個過去的日期    
@Future     被注釋的元素必須是一個將來的日期    
@Pattern(regex=,flag=)  被注釋的元素必須符合指定的正則表達式    


Hibernate Validator提供的校驗注解：  
@NotBlank(message =)   驗證字符串非null，且trim后長度必須大於0    
@Email  被注釋的元素必須是電子郵箱地址    
@Length(min=,max=)  被注釋的字符串的大小必須在指定的范圍內    
@NotEmpty   被注釋的字符串的必須非空    
@Range(min=,max=,message=)  被注釋的元素必須在合適的范圍內

@AssertFalse 校驗false  
@AssertTrue 校驗true  
@DecimalMax(value=,inclusive=) 小於等於value，  
inclusive=true,是小於等於  
@DecimalMin(value=,inclusive=) 與上類似  
@Max(value=) 小於等於value  
@Min(value=) 大於等於value  
@NotNull  檢查Null  
@Past  檢查日期  
@Pattern(regex=,flag=)  正則  
@Size(min=, max=)  字符串，集合，map限制大小  
@Valid 對po實體類進行校驗 

 

 

驗證注解	驗證的數據類型	說明
@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注解即可級聯驗證

此處只列出Hibernate Validator提供的大部分驗證約束注解，請參考hibernate validator官方文檔了解其他驗證約束注解和進行自定義的驗證約束注解定義。

 

 

實戰演練

 

1. @Validated 聲明要檢查的參數

　　添加@Valid或者@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 {

}

 

參考鏈接：https://www.cnblogs.com/moues/p/11399421.html