SpringBoot参数校验示例详解

2023-10-25 10:19:36 作者：会洗碗的CV工程师

SpringBoot自带了validation工具可以从后端对前端传来的参数进行校验,本文给大家介绍SpringBoot参数校验及用法,感兴趣的朋友跟随小编一起看看吧

SpringBoot自带了validation工具可以从后端对前端传来的参数进行校验，用法如下：

首先得添加依赖

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

一、简单数据类型校验

1.1 编写相关Controller

@Validated
@RestController
public class TestController {
 
    @GetMapping("/t1")
    // name不能为空
    public String t1(@NotBlank String name){
        System.out.println(name);
        return name;
    }
}

在要开启参数校验的类上方添加Validated注解，代表该类开启参数校验，访问http://localhost:8080/t1，发现当没有传来参数时，会抛出 ConstraintViolationException 异常。接下来让我们测试一下啪

1.2 测试结果

可以看到不能为空，表示t1路径下第一个参数不能为空，接下来我们输入参数看看

如果我们不想输出这种提示信息，我们还可以自定义提示信息，这时就要在注解添加message属性，属性值代表错误信息

public String t1(@NotBlank(message = "名字不能为空") String name){
    System.out.println(name);
    return name;
}

再运行看看

这样就正常了。

二、异常处理

好喽，在上面我们可以看到异常页面不太好看，这样我们可以配置自定义的程序出现错误跳转的错误页面。

当抛出 ConstraintViolationException 异常后，我们可以使用SpringMVC的异常处理器，也可以使用SpringBoot自带的异常处理机制。
当程序出现了异常，SpringBoot会使用自带的 BasicErrorController 对象处理异常。该处理器会默认跳转到/resources/templates/error.html页面。

2.1 错误页面

<!DOCTYPE HTML>
<html>
<head>
    <meta charset="UTF-8">
    <title>错误页面</title>
</head>
<body>
<h1>服务器开小差了~</h1>
</body>
</html>

2.2 测试结果

OK，可以正常显示错误页面

三、参数校验相关注解

参数校验相关注解

注解	作用
@NotNull	判断包装类是否为null
@NotBlank	判断字符串是否为null或者是空串(去掉首尾空格)
@NotEmpty	判断集合是否为空
@Length	判断字符的长度(最大或者最小)
@Min	判断数值最小值
@Max	判断数值最大值
@Email	判断邮箱是否合法

3.1 测试Controller

    @RequestMapping("/t2")
    public String t2(@NotBlank @Length(min = 1,max = 5) String name,
                     @NotNull @Min(0) @Max(150) Integer age,
                     @NotEmpty @RequestParam List<String> address,
                     @NotBlank @Email String email){
        System.out.println(name);
        System.out.println(age);
        System.out.println(address);
        System.out.println(email);
        return "请求成功";
    }

OK，我们这个测试方法主要就是有四个参数，第一个name不能为空，且长度最小为1且不能超过5，第二个参数是年龄age，最小值为0且不能超过150，第三个参数值就是address，这是一个集合，不能为空，第四个参数是邮箱，邮箱格式也要正确。

3.2 测试结果

OK，接下来我们测试一下什么都没有输入，直接测试

接下来输入如下图

四、对象类型参数校验

SpringBoot也可以校验对象参数中的每个属性，用法如下：

4.1 添加实体类

package com.example.springbootdemo4.pojo;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
public class Student {
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "年龄不能没有") @Min(6) @Max(18)
    private Integer age;
    public Student() {
    }
    public Student(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "Student [" +
                "name='" + name + '\'' +
                ", age=" + age +
                " ]";
    }
}

4.2 添加测试方法

    @RequestMapping("/t3")
    public String t3(@Validated Student student, BindingResult brs){
        // 判断是否有参数异常
        if(brs.hasErrors()){
            // 所有参数异常
            List<ObjectError> list = brs.getAllErrors();
            // 遍历参数异常输出信息
            list.forEach(System.out::println);
            return "参数异常";
        }
        System.out.println(student);
        return "success";
    }