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参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot项目部署到阿里云服务器的实现步骤
本文主要介绍了SpringBoot项目部署到阿里云服务器的实现步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-06-06
springboot实现自动邮件发送任务详解
这篇文章主要介绍了Springboot中的邮件任务，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧
2022-04-04
Java日常练习题,每天进步一点点(32)
下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧，希望可以帮到你
2021-07-07
IO流概述分类字节流写数据三种方式及问题分析
这篇文章主要为大家介绍了IO流概述分类字节流写数据三种方式及写数据问题分析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-12-12
springboot如何解决跨域后session获取不到sessionId不一致
这篇文章主要介绍了springboot如何解决跨域后session获取不到sessionId不一致问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-01-01
基于Calendar获取当前时间的性能比较
这篇文章主要介绍了Calendar获取当前时间的性能比较，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
SpringBoot手写自定义starter源码
这篇文章主要介绍了SpringBoot手写自定义starter源码,SpringBoot拥有很多方便使用的starter,比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等,各自都代表了一个相对完整的功能模块,需要的朋友可以参考下
2023-10-10
Java链表超详细讲解(通俗易懂,含源码)
链表是一种物理存储结构上非连续存储结构,数据元素的逻辑顺序是通过链表中的引用链接次序实现的,下面这篇文章主要给大家介绍了关于Java链表超详细讲解的相关资料,本文讲解的内容通俗易懂,含源码,需要的朋友可以参考下
2022-09-09
springboot项目(jar包)指定配置文件启动图文教程
这篇文章主要给大家介绍了关于springboot项目(jar包)指定配置文件启动的相关资料,在多环境部署过程中、及线上运维中可能会遇到临时指定配置文件的情况,需要的朋友可以参考下
2023-07-07
SpringBoot整合Spring Boot Admin实现服务监控的方法
这篇文章主要介绍了SpringBoot整合Spring Boot Admin实现服务监控,内容包括Server端服务开发，Client端服务开发其中Spring Boot Admin还可以对其监控的服务提供告警功能，如服务宕机时，可以及时以邮件方式通知运维人员，感兴趣的朋友跟随小编一起看看吧
2022-03-03