作者： 錦成同學(xué)
juejin.im/post/5d3fbeb46fb9a06b317b3c48
整理：后端技術(shù)精選

很痛苦遇到大量的參數(shù)進(jìn)行校驗(yàn),在業(yè)務(wù)中還要拋出異撤绯樱或者不斷的返回異常時(shí)的校驗(yàn)信息,在代碼中相當(dāng)冗長(zhǎng), 充滿(mǎn)了if-else這種校驗(yàn)代碼,今天我們就來(lái)學(xué)習(xí)spring的javax.validation 注解式參數(shù)校驗(yàn).

為什么要用validator

1.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)~ 寫(xiě)法
        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ì)");
        }

        //拋出自定義異常等~寫(xiě)法
        if (StringUtils.isBlank(userVO.getUsername())) {
            throw new BizException(Constant.PARAM_FAIL_CODE, "用戶(hù)名不能為空");
        }

        // 比如寫(xiě)一個(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;
        }
        //.........各種寫(xiě)法 ...
        userService.save(userVO);
        return RspDTO.success();
    }

這被大佬看見(jiàn),一定說(shuō),都9102了還這么寫(xiě),然后被勸退了…..

2.什么是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)目中可以引用依賴(lài),并自行調(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>

image

3.注解說(shuō)明

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

• @NotEmpty：不能為null救斑，而且長(zhǎng)度必須大于0 (" "," ")

• @NotBlank：只能作用在String上，不能為null真屯，而且調(diào)用trim()后脸候，長(zhǎng)度必須大于0("test") 即：必須有實(shí)際字符

image

此處只列出Hibernate Validator提供的大部分驗(yàn)證約束注解，請(qǐng)參考hibernate validator官方文檔了解其他驗(yàn)證約束注解和進(jìn)行自定義的驗(yàn)證約束注解定義绑蔫。

實(shí)戰(zhàn)演練

話(huà)不多說(shuō),直接走實(shí)踐路線,同樣使用的是SpringBoot的快速框架

詳細(xì)代碼見(jiàn):

https://github.com/leaJone/mybot

1. @Validated 聲明要檢查的參數(shù)

這里我們?cè)诳刂破鲗舆M(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: 用戶(hù)傳輸對(duì)象
 * @date 2019/7/30 13:55
 */
@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用戶(hù)ID*/
    @NotNull(message = "用戶(hù)id不能為空")
    private Long userId;

    /** 用戶(hù)名*/
    @NotBlank(message = "用戶(hù)名不能為空")
    @Length(max = 20, message = "用戶(hù)名不能超過(guò)20個(gè)字符")
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用戶(hù)昵稱(chēng)限制：最多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í)間必須是將來(lái)時(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)體,將請(qǐng)求的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, "路徑不存在配深，請(qǐng)檢查路徑是否正確");
    }

    @ExceptionHandler(DuplicateKeyException.class)
    public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(DUPLICATE_KEY_CODE, "數(shù)據(jù)重復(fù)携添，請(qǐng)檢查后提交");
    }


    @ExceptionHandler(Exception.class)
    public RspDTO handleException(Exception e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(500, "系統(tǒng)繁忙,請(qǐng)稍后再試");
    }
}

4. 測(cè)試

如下文:確實(shí)做到了參數(shù)校驗(yàn)時(shí)返回異常信息和對(duì)應(yīng)的code,方便了我們不再繁瑣的處理參數(shù)校驗(yàn)

image

在ValidationMessages.properties 就是校驗(yàn)的message,有著已經(jīng)寫(xiě)好的默認(rèn)的message,且是支持i18n的,大家可以閱讀源碼賞析

自定義參數(shù)注解

1. 比如我們來(lái)個(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)證類(lèi)薪寓。

• message 定制化的提示信息，主要是從ValidationMessages.properties里提取澜共，也可以依據(jù)實(shí)際情況進(jìn)行定制

• groups 這里主要進(jìn)行將validator進(jìn)行分類(lèi)，不同的類(lèi)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 = "身份證信息有誤,請(qǐng)核對(duì)后提交")
    private String clientCardNo;

4.使用groups的校驗(yàn)

有的寶寶說(shuō)同一個(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 = {}的分組類(lèi)型

@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用戶(hù)ID*/
    @NotNull(message = "用戶(hù)id不能為空", groups = Update.class)
    private Long userId;

    /**
     * 用戶(hù)名
     */
    @NotBlank(message = "用戶(hù)名不能為空")
    @Length(max = 20, message = "用戶(hù)名不能超過(guò)20個(gè)字符", groups = {Create.class, Update.class})
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用戶(hù)昵稱(chēng)限制：最多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í)間必須是將來(lái)時(shí)間", groups = {Create.class})
    private Date createTime;

}

注意:在聲明分組的時(shí)候盡量加上 extend javax.validation.groups.Default 否則,在你聲明@Validated(Update.class)的時(shí)候,就會(huì)出現(xiàn)你在默認(rèn)沒(méi)添加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 = "用戶(hù)id不能為空") Long userId) {
        User user = userService.selectById(userId);
        if (user == null) {
            return new RspDTO<User>().nonAbsent("用戶(hù)不存在");
        }
        return new RspDTO<User>().success(user);
    }

@RestController
@RequestMapping("user/")
@Validated
public class UserController extends AbstractController {

....省略代碼...

總結(jié)

用起來(lái)很簡(jiǎn)單,soEasy,重點(diǎn)參與的統(tǒng)一結(jié)構(gòu)體返回,統(tǒng)一參數(shù)校驗(yàn),是減少我們代碼大量的try catch 的法寶,我覺(jué)得在項(xiàng)目中,將異常處理好,并將異常做好日志管理,才是很好的升華,文章淺顯,只是一個(gè)菜鳥(niǎo)的進(jìn)階筆記….

這里只是個(gè)人見(jiàn)解,技術(shù)菜,歡迎大佬不吝賜教…