springboot介面接參註解詳解

一杯酒慰風塵發表於2020-10-16
Spring Boot

為什麼要用validator

javax.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<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了還這麼寫,然後被勸退了.....

  1. 什麼是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>

 

1、註解說明 

   1.@NotNull：不能為null，但可以為empty(""," ","   ")
   2.@NotEmpty：不能為null，而且長度必須大於0 (" ","  ")
   3.@NotBlank：只能作用在String上，不能為null，而且呼叫trim()後，長度必須大於0("test")    即：必須有實際字元
驗證註解驗證的資料型別說明
@AssertFalseBoolean,boolean驗證註解的元素值是false
@AssertTrueBoolean,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（包含）指定區間之內，如字元長度、集合大小
@Pastjava.util.Date,java.util.Calendar;Joda Time類庫的日期型別驗證註解的元素值（日期型別）比當前時間早
@Future與@Past要求一樣驗證註解的元素值（日期型別）比當前時間晚
@NotBlankCharSequence子型別驗證註解的元素值不為空（不為null、去除首位空格後長度為0），不同於@NotEmpty，@NotBlank只應用於字串且在比較時會去除字串的首位空格
@Length(min=下限, max=上限)CharSequence子型別驗證註解的元素值長度在min和max區間內
@NotEmptyCharSequence子型別、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註解即可級聯驗證

話不多說,直接走實踐路線,同樣使用的是SpringBoot的快速框架,詳細程式碼見:github.com/leaJone/myb…

2、@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;

    /*** 建立時間 */
    @Future(message = "時間必須是將來時間")
    private Date createTime;

}

 

3、在全域性校驗中增加校驗異常

MethodArgumentNotValidException是springBoot中進行繫結引數校驗時的異常,需要在springBoot中處理,其他需要 處理ConstraintViolationException異常進行處理.

  • 為了優雅一點,我們將引數異常,業務異常,統一做了一個全域性異常,將控制層的異常包裝到我們自定義的異常中

  • 為了優雅一點,我們還做了一個統一的結構體,將請求的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<? 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());
    }
}

IdCardValidatorUtils在專案原始碼中,可自行檢視

3、使用自定義的註解

    @NotBlank(message = "身份證號不能為空")
    @IdentityCardNumber(message = "身份證資訊有誤,請核對後提交")
    private String clientCardNo;

4、使用groups的校驗

有的寶寶說同一個物件要複用,比如UserDTO在更新時候要校驗userId,在儲存的時候不需要校驗userId,在兩種情況下都要校驗username,那就用上groups了:

先定義groups的分組介面Create和


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;

    /*** 建立時間 */
    @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 {
    ......
}

總結

用起來很簡單,soEasy,重點參與的統一結構體返回,統一引數校驗,是減少我們程式碼大量的try catch 的法寶,我覺得在專案中,將異常處理好,並將異常做好日誌管理,才是很好的昇華,文章淺顯,只是一個菜鳥的進階筆記....

這裡只是個人見解,技術菜,歡迎大佬不吝賜教... 我是一個小白,技術在不斷的更新迭代,我只有不斷的填充自己的空白才能....跟上大佬們的步伐...

 

相關文章