Spring MVC 如何優雅的對參數進行校驗？

原文鏈接：juejin.im/post/5d3fbeb46fb9a06b317b3c48

作者： 錦成同學

juejin.im/post/5d3fbeb46fb9a06b317b3c48 

整理：後端技術精選

 很痛苦遇到大量的參數進行校驗,在業務中還要拋出異常或者不斷的返回異常時的校驗信息,在代碼中相當冗長, 充滿了if-else這種校驗代碼,今天我們就來學習spring的javax.validation 註解式參數校驗。

爲什麼要用validator

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

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

• @NotNull：不能爲null，但可以爲empty(""," "," ")

• @NotEmpty：不能爲null，而且長度必須大於0 (" "," ")

• @NotBlank：只能作用在String上，不能爲null，而且調用trim()後，長度必須大於0("test") 即：必須有實際字符

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

實戰演練

話不多說,直接走實踐路線,同樣使用的是SpringBoot的快速框架

詳細代碼見:

https://github.com/leaJone/mybot

 

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;

    /*** 創建時間 */
    @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和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;

    /*** 創建時間 */
    @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 的法寶,我覺得在項目中,將異常處理好,並將異常做好日誌管理,纔是很好的昇華,文章淺顯,只是一個菜鳥的進階筆記….

這裏只是個人見解,技術菜,歡迎大佬不吝賜教…