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 | 判断数值最大值 |
| 判断邮箱是否合法 |
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 @Scope与@RefreshScope注解使用详解
spring的bean管理中，每个bean都有对应的scope。在BeanDefinition中就已经指定scope，默认的RootBeanDefinition的scope是prototype类型，使用@ComponentScan扫描出的BeanDefinition会指定是singleton，最常使用的也是singleton2022-11-11
这篇文章主要介绍了Spring 开发过程中Value 注解的使用场景，帮助大家更好的理解和使用spring框架，感兴趣的朋友可以了解下2020-11-11
这篇文章主要介绍了java读取properties配置文件的方法,涉及java操作properties配置文件的相关技巧,需要的朋友可以参考下2015-05-05
本篇文章是作为一个很适合新手阅读的初级小项目，客户管理，它主要实现数据库的增删查改操作，管理每位客户的不同信息，如果你也是开始学Java不久，这篇文章将很适合你2021-11-11
windows自带的游戏《扫雷》是陪伴了无数人的经典游戏，本文将利用Java语言实现这一经典的游戏，文中的示例代码讲解详细，感兴趣的可以学习一下2022-05-05
Quartz是一个定时任务框架，其他介绍网上也很详尽。这里要介绍一下Quartz里的几个非常核心的接口。通过实例代码给大家讲解SpringBoot集成Quartz实现定时任务的方法，感兴趣的朋友一起看看吧2020-05-05
这篇文章主要介绍了在Java编程中使用正则表达式,注意使用matches()方法检测一下Java对正则表达式的支持情况,需要的朋友可以参考下2015-08-08
本文介绍了 CORS 的知识以及如何在 Spring MVC 中配置 CORS，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-05-05
这篇文章主要给大家介绍了关于Java踩坑记录之Arrays.AsList的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-11-11
这篇文章主要为大家介绍了Java并发编程之原子类介绍，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-04-04
最新评论