SpringBoot参数校验示例详解

更新时间：2023年10月25日 10:19:35 作者：会洗碗的CV工程师

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

一、简单数据类型校验

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";
    }

4.3 测试结果

可以看到控制台输出可以识别到，

Ok，这里乱码是因为这个模块的JDK版本较高，和项目版本不切合，但是我们可以知道他是表示年龄要在6-18的就好啦

到此这篇关于SpringBoot参数校验示例详解的文章就介绍到这了,更多相关SpringBoot参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

浅谈SpringSecurity基本原理
今天带大家了解一下SpringSecurity的基本原理,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
2021-05-05
java之路径分隔符介绍
考虑到程序的可移植性，创建文件时建议大家选用"/",因为经过测试用java创建文件时在windows平台下用“/”也是可以的，java貌似在后台作过处理了。
2013-03-03
Java项目中如何访问WEB-INF下jsp页面
这篇文章主要介绍了Java项目中如何访问WEB-INF下jsp页面，文章通过示例代码和图文解析介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
java中sdk与jdk的区别详细解析
以下是对java中sdk与jdk的区别进行了详细的分析介绍，需要的朋友可以过来参考下
2013-08-08
Java初学者常问的问题(推荐)
本文介绍一些Java初学者常问的问题，很多朋友对可以用%除以一个小数吗？ a += b 和 a = a + b 的效果有区别吗？声明一个数组为什么需要花费大量时间？为什么Java库不用随机pivot方式的快速排序？等等一系列问题有疑惑，下面就通过本文给大家详细介绍下
2017-03-03
Java中常见字符串拼接九种方式详细例子
这篇文章主要给大家介绍了关于Java中常见字符串拼接的九种方式,字符串拼接是我们在Java代码中比较经常要做的事情,就是把多个字符串拼接到一起,文中通过代码介绍的非常详细,需要的朋友可以参考下
2023-07-07
Struts2学习教程之自定义类型转换器的方法
类型转换器的作用是将请求中的字符串或字符串数组参数与action中的对象进行相互转换。下面这篇文章主要给大家介绍了关于Struts2学习教程之自定义类型转换器的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下
2018-05-05
Java语言实现Blowfish加密算法完整代码分享
这篇文章主要介绍了Java语言实现Blowfish加密算法完整代码分享，简单介绍了blowfish加密算法，具有一定借鉴价值，需要的朋友可以参考下。
2017-11-11
Spring Boot启动过程（四）之Spring Boot内嵌Tomcat启动
这篇文章主要介绍了Spring Boot启动过程（四）之Spring Boot内嵌Tomcat启动的相关资料，非常不错，具有参考借鉴价值,需要的朋友可以参考下
2017-04-04
一文带你掌握JPA实体类注解
这篇文章主要给大家详细介绍一下 JPA 实体类中的注解，文中的示例代码讲解详细，对我们学习Java有一定的帮助，感兴趣的小伙伴可以了解一下
2023-01-01