image

前言

??在日常的開發(fā)中币厕，參數(shù)校驗(yàn)是非常重要的一個(gè)環(huán)節(jié)，嚴(yán)格參數(shù)校驗(yàn)會(huì)減少很多出bug的概率芽腾，增加接口的安全性旦装。也會(huì)減少對(duì)接時(shí)不必要的溝通。比如說：在對(duì)接的時(shí)候前端動(dòng)不動(dòng)就甩個(gè)截圖過來說接口有問題摊滔，你檢查了半天發(fā)現(xiàn)前端傳遞的參數(shù)有問題阴绢。針對(duì)以上：今天給大家分享一下SpringBoot如何實(shí)現(xiàn)統(tǒng)一參數(shù)校驗(yàn)。

實(shí)現(xiàn)方式

??使用 @Validated注解配合參數(shù)校驗(yàn)注解艰躺， 比如：@NotEmpty對(duì)參數(shù)進(jìn)行校驗(yàn)呻袭。然后對(duì)拋出的異常ControllerAdvice進(jìn)行捕獲然后調(diào)整輸出數(shù)據(jù)。

TestController

@RestController
public class TestController {

    /**
     * 表單請(qǐng)求
     * @param form 請(qǐng)求參數(shù)
     * @return 響應(yīng)數(shù)據(jù)
     */
    @PostMapping("/formRequest")
    public ResultVo formRequest(@Validated RequestForm form){
        return ResultVoUtil.success(form);
    }

    /**
     * JSON請(qǐng)求
     * @param form 請(qǐng)求參數(shù)
     * @return 響應(yīng)數(shù)據(jù)
     */
    @PostMapping("/jsonRequest")
    public ResultVo jsonRequest(@RequestBody @Validated RequestForm form){
        return ResultVoUtil.success(form);
    }

}

RequestForm

@Data
public class RequestForm {

    @NotEmpty(message = "姓名不能為空")
    private String name;

    @Min(value = 1 , message = "年齡不能小于1歲")
    private Integer age;

    @NotEmpty(message = "性別不能為空")
    private Integer sex;

}

測(cè)試結(jié)果

請(qǐng)求：http://localhost:8080/formRequest 不傳任何參數(shù)腺兴。

image

??這個(gè)時(shí)候SpringBoot已經(jīng)根據(jù)校驗(yàn)注解對(duì)參數(shù)進(jìn)行校驗(yàn)了左电。并且輸出了一大堆的錯(cuò)誤信息。這個(gè)時(shí)候前端在對(duì)接的時(shí)候看到這樣的錯(cuò)誤信息页响，反手就是給你截個(gè)圖告訴你接口有問題篓足。所以這個(gè)時(shí)候就該使用 ControllerAdvice規(guī)范異常返回信息了。

image

ControllerAdvice

@Slf4j
@RestControllerAdvice
public class ControllerAdvice {

    /**
     * 攔截表單參數(shù)校驗(yàn)
     */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler({BindException.class})
    public ResultVo bindException(BindException e) {
        BindingResult bindingResult = e.getBindingResult();
        return ResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
    }
    
    /**
     * 攔截JSON參數(shù)校驗(yàn)
     */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResultVo bindException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        return ResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
    }

}

@RestControllerAdvice會(huì)將返回的數(shù)據(jù)以json輸出闰蚕，如果不需要可以使用@ControllerAdvice

以上代碼只返回了錯(cuò)誤信息纷纫。可以根據(jù)實(shí)際情況進(jìn)行調(diào)整陪腌。

image

這個(gè)時(shí)候的錯(cuò)誤信息就比較友好了，非常明確的指出了缺少參數(shù)烟瞧。

常用校驗(yàn)注解

案例

@Data
public class ExampleForm {

    @NotEmpty(message = "姓名不能為空")
    @Length(min = 1 , max = 10 , message = "名字長(zhǎng)度1~10")
    private String name;

    @Range(min = 1 , max = 99 , message = "年齡范圍在1~99歲")
    private Integer age;

    @Pattern(regexp = "^[1][3,4,5,7,8][0-9]{9}$" , message = "電話號(hào)碼有誤")
    private String phone;

    @Email(message = "郵箱格式有誤")
    private String email;

    @Valid
    @Size(min = 1 ,max =  10 , message = "列表中的元素?cái)?shù)量為1~10")
    private List<RequestForm> requestFormList;

    @Future(message = "開始時(shí)間必須大于當(dāng)前時(shí)間")
    private Date beginTime;
    
}

實(shí)現(xiàn)嵌套驗(yàn)證

??在實(shí)際的開發(fā)中檀夹，前臺(tái)會(huì)后臺(tái)傳遞一個(gè)list筋粗，我們不僅要限制每次請(qǐng)求list內(nèi)的個(gè)數(shù)策橘，同時(shí)還要對(duì)list內(nèi)基本元素的屬性值進(jìn)行校驗(yàn)。這個(gè)時(shí)候就需要進(jìn)行嵌套驗(yàn)證了娜亿，實(shí)現(xiàn)的方式很簡(jiǎn)單丽已。在list上添加@Vaild就可以實(shí)現(xiàn)了。

@Data
public class JsonRequestForm {
    
    @Vaild
    @Size(min = 1 ,max =  10 , message = "列表中的元素?cái)?shù)量為1~10")
    private List<RequestForm> requestFormList;
    
}

代碼地址

https://gitee.com/huangxunhui/unifiedParamCheck.git

結(jié)尾

??如果覺得對(duì)你有幫助买决，可以多多評(píng)論沛婴，多多點(diǎn)贊哦，也可以到我的主頁看看策州，說不定有你喜歡的文章瘸味，也可以隨手點(diǎn)個(gè)關(guān)注哦，謝謝够挂。

??我是不一樣的科技宅旁仿，每天進(jìn)步一點(diǎn)點(diǎn)，體驗(yàn)不一樣的生活孽糖。我們下期見枯冈！