寫在前面：

參數(shù)校驗(yàn)基本上是controller必做的事情，畢竟前端傳過來(lái)的一切都不可信。 但是每次if(StrUtil.isNotNull())啥的有時(shí)候多還難寫。validation可以簡(jiǎn)化這一操作。 

項(xiàng)目構(gòu)建

采用boot3，主要依賴為spring web 和validation

主要依賴：

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

項(xiàng)目結(jié)構(gòu)

問題展示

先來(lái)個(gè)簡(jiǎn)單的案例

@RestController
public class ValidationController {
@GetMapping("/get")
public String get(String name,String age){
System.out.println(name);
System.out.println(age);
return "ok";
}
}

點(diǎn)擊這個(gè)就可以發(fā)送請(qǐng)求了

發(fā)送出去不會(huì)做任何校驗(yàn)

這個(gè)的處理我們可以選擇加上@RequestParam注解。@RequestParam默認(rèn)屬性require為true，就是必須要傳值，

public String get(@RequestParam String name,@RequestParam String age)

報(bào)錯(cuò)返回

封裝成實(shí)體類也是一樣的。

但是這樣只能做非null判斷，不能做復(fù)雜的判斷。在body里面的時(shí)候更加不會(huì)校驗(yàn)了

validation使用

那么validation又如何做到呢。

快速入門

需求：get請(qǐng)求中，name長(zhǎng)度在2-10，age在10-100歲之間且都不為null。

@GetMapping("/get")
public String get(@Length(max = 10,min = 2) String name,
@Min(10)@Max(100) String age){
System.out.println("name = " + name);
System.out.println("age = " + age);
return "ok";
}

為null發(fā)送，好ok一點(diǎn)用沒有。

我查資料發(fā)現(xiàn)需要參數(shù)前面加上啟動(dòng)校驗(yàn)@Validated或者@Valid注解，但是無(wú)論我怎么放到都是沒有校驗(yàn)。全部無(wú)效。

我之前研究了半天，然后才發(fā)現(xiàn)，如果想要這樣校驗(yàn)的話，需要在controller類上面加上@Validated且Valid都不行。

如果是實(shí)體類接收就不一樣了。直接在方法就可以了

注釋

到這里基本使用應(yīng)該就差不多知道了?，F(xiàn)在來(lái)進(jìn)行注解的學(xué)習(xí)。

注解通用屬性基本上都有的

無(wú)參注解，無(wú)必須傳的值

大小注解，用于限值大小

基于正則類型

腳本注解

@ScriptAssert
它根據(jù)批注元素計(jì)算腳本表達(dá)式。此約束可用于實(shí)現(xiàn)驗(yàn)證例程，腳本表達(dá)式可以用任何腳本或表達(dá)式語(yǔ)言編寫，在類路徑上可以找到 JSR 223 （“JavaTM 平臺(tái)腳本”）兼容引擎。下面的清單顯示了使用 JDK 附帶的 JavaScript 引擎的示例：
我看到的時(shí)候給我震驚了一下，他注解寫的啥？？任何表達(dá)式語(yǔ)言？？不過可能是我沒見過世面，或者是知識(shí)點(diǎn)用的少，java6就支持JavaScript。不過一般很少用吧。

下面是一個(gè)校驗(yàn)時(shí)間的腳本

@ScriptAssert(lang = "javascript", script = "_this.startDate.before(_this.endDate)")   
public class CalendarEvent {
     private Date startDate;
     private Date endDate;
     //...
}

注意！??！java11開始就移除了NashornScriptEngineFactory，所以11以上需要添加依賴才可以使用javascript需要新增

        <dependency>
            <groupId>org.openjdk.nashorn</groupId>
            <artifactId>nashorn-core</artifactId>
            <version>15.4</version>
        </dependency>

沒有通過

修改時(shí)間通過了

Valid與Validated區(qū)別

Validated是Valid的加強(qiáng)版

使用范圍

經(jīng)過我的層層驗(yàn)證

• controller類上：
• 在controller類上只有使用validated，將開啟所有的路徑參數(shù)驗(yàn)證，對(duì)實(shí)體類（路徑和body）無(wú)效
• 方法上：
• 全部無(wú)效，無(wú)論是路徑還說(shuō)body，2個(gè)注解都沒用。
• 入?yún)⑸希?/li>
• 只有在對(duì)body或者路徑參數(shù)實(shí)體類或者添加注解才有效，2個(gè)都有效，對(duì)單獨(dú)的類型無(wú)效
• 實(shí)體類的屬性上
• Valid有效，且路徑參數(shù)有效，body無(wú)效，body需要自己參數(shù)開啟，無(wú)論參數(shù)是否加驗(yàn)證注解

兩者是否能用于成員屬性（字段）上直接影響能否提供嵌套驗(yàn)證的功能。

分組

@Validated：提供了一個(gè)分組功能，可以在入?yún)Ⅱ?yàn)證時(shí)，根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制。沒有添加分組屬性時(shí)，默認(rèn)驗(yàn)證沒有分組的驗(yàn)證屬性。Valid是不能進(jìn)行分組的，靈活性更差。

public class DemoQuery {
    @Length(max = 10, min = 2,groups = {Demo1.class, Demo2.class},message = "name長(zhǎng)度不符合要求")
    private String name;
    @Min(value = 10,groups = {Demo1.class}) @Max(100)
    @NotNull
    private Integer age;
}

    @PostMapping("/post2")
    public String post2(@Validated({Demo2.class}) @RequestBody DemoQuery query, @NotNull String id) {
        System.out.println("name = " + query.getName());
        System.out.println("age = " + query.getAge());
        System.out.println("id = " + id);
        return "ok";
    }

不通過

通過

改為demo1

嵌套驗(yàn)證

新增一個(gè)類

@Data
public class NestedQuery {
    @NotNull
    private String id;
    @Valid
    @NotNull
    private DemoQuery querys;
}

    @GetMapping("/nested")
    public String nested(@Validated NestedQuery query, BindingResult bindingResult) {
        System.out.println("id = " + query.getId());
        System.out.println("query = " + query.getQuerys());
        System.out.println(bindingResult);
        return "ok";
    }

發(fā)送返回的居然是ok，

但是在控制臺(tái)，驗(yàn)證說(shuō)出錯(cuò)了，說(shuō)明嵌套的錯(cuò)誤不會(huì)直接返回，而是會(huì)記錄。需要自己處理一下。

如

Assert.isTrue(!bindingResult.hasErrors(),"參數(shù)錯(cuò)誤");

結(jié)束：收工，累死了。

到此這篇關(guān)于spring boot validation參數(shù)校驗(yàn)及分組嵌套各種類型及使用小結(jié)的文章就介紹到這了,更多相關(guān)spring boot validation參數(shù)校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論