SpringBoot参数校验机制之一：基本验证概念

引言

在实际项目开发中，我们会对Controller层接收到的参数进行基本的校验，本文主要介绍SpringBoot项目中使用注解对输入参数进行初步规则校验的方法。本文将从以下几个方面进行阐述。

• Rest请求方式

• 校验框架

• 常用的参数校验注解

• 代码示例

---

一、Rest请求方式

在当下的WEB后台开发模式下，基本都采用了前后台分离的开放方式。所谓前后台分离就是后台给前段返回统一的JSON格式数据，前端通过解析JSON数据将后台处理的数据展示在页面。前端调用Rest风格的后台接口。

1. Get请求

一般用于页面展示数据的查询操作，不涉及数据库数据的变化。常用的Controller层注解为@GetMapping。

2. POST请求

提交数据到后台服务，需要修改服务器中的数据。提交的数据放在HTTP请求中的消息体重。常用的Controller层注解为@PostMapping。

3. DELETE请求

主要通过HTTP请求删除指定URL服务器资源。常见返回的状态码包括：

（1）200（OK）：删除成功，同时返回删除的资源。

（2）202 (Accepted) ： 删除请求已经接受，但没有被立即执行。

（3）204 (No Content) - 删除请求已经被执行，但是没有返回资源（也许是请求删除不存在的资源造成的）。

4. PUT请求

主要用于通过HTTP请求的方式ge更改服务器资源，常见的返回状态码包括：

（1）200 （OK）： 已存在资源被更改。

（2）201 （created）：如果新资源被创建。

二、校验框架

在日常开发工作中，对于Controller层接收的参数进行校验的时候可以通过代码来进行，但是这些校验操作与具体的业务无关，可以通过抽象一个校验工具类的方法实现，但是总会觉得这部分代码糅合在代码中显得臃肿不实用。同时也不能保证验证参数的有效性。Hibernate validator提供了一套基于注解的参数验证机制，它可以与现有框架进行有机集成。spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖，因为该包中已经包含了hibernate-validator包的引用。

org.springframework.boot

spring-boot-starter-web

三、常用的参数校验注解

以下表格是一些常用校验注解的说明。

| @Null | 限制只能为null |

| — | — |

| @NotNull | 限制必须不为null |

| @AssertFalse | 限制必须为false |

| @AssertTrue | 限制必须为true |

| @Max(value) | 限制必须为一个不大于指定值的数字 |

| @Min(value) | 限制必须为一个不小于指定值的数字 |

| @NotBlank | 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格 |

| @NotEmpty | 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0） |

| @Email | 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式 |

| @Range | 验证字段的范围,最小值到最大值 |

四、代码示例

public class StudentDto {

@NotNull(message = “field is null”)

private String name;

@NotNull(message = “field is null”)

@Max(100)

private int age;

@NotNull(message = “field is null”)

private boolean sexuality;

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public int getAge() {

return age;

}

public void setAge(int age) {

this.age = age;

}

public boolean isSexuality() {

retu
rn sexuality;

}

public void setSexuality(boolean sexuality) {

this.sexuality = sexuality;
}
}

最后

小编这些年深知大多数初中级工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Java全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你需要这些资料，⬅专栏获取
uU2ct-1719527723572)]

[外链图片转存中…(img-57uFrRub-1719527723573)]

[外链图片转存中…(img-wZrjZ1VI-1719527723574)]

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你需要这些资料，⬅专栏获取