详解如何在Spring Boot项目使用参数校验

2025-05-29 0 21

开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空,非null,整数值的范围,字符串的个数,日期,邮箱等等。最常见的就是我们直接写代码校验,这样以后比较繁琐,而且不够灵活。

Bean Validation 1.0(JSR-303)是一个校验规范,在spring Boot项目由于自带了hibernate validator 5(http://hibernate.org/validator/)实现,所以我们可以非常方便的使用这个特性 。

核心的pom依赖:

?

1

2

3

4

5
<dependency>

<groupId>org.hibernate</groupId>

<artifactId>hibernate-validator</artifactId>

<version>5.3.1.Final</version>

</dependency>

首先,需要我们声明一个Bean,注入校验器到Spring Boot的运行环境

?

1

2

3

4

5

6

7

8

9

10

11

12
@Configuration

@EnableAutoConfiguration

public class FactoryConfig {

final static Logger logger= LoggerFactory.getLogger(FactoryConfig.class);

@Bean

public MethodValidationPostProcessor methodValidationPostProcessor(){

return new MethodValidationPostProcessor();

}

}

校验常用的注解如下:

?

1

2

3

4

5

6

7

8

9

10

11

12
@AssertFalse 校验false

@AssertTrue 校验true

@DecimalMax(value=,inclusive=) 小于等于value,

inclusive=true,是小于等于

@DecimalMin(value=,inclusive=) 与上类似

@Max(value=) 小于等于value

@Min(value=) 大于等于value

@NotNull 检查Null

@Past 检查日期

@Pattern(regex=,flag=) 正则

@Size(min=, max=) 字符串,集合,map限制大小

@Valid 对po实体类进行校验

下面看一个使用例子:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38
package hello;

import javax.validation.constraints.Min;

import javax.validation.constraints.NotNull;

import javax.validation.constraints.Size;

public class PersonForm {

//名字不能为空,而且长度必须在2和30之间

@NotNull(message = "名称不能为空")

@Size(min=2, max=30, message = "名字长度必须在2和30之间")

private String name;

//年龄不能为空,而且必须大于等于18岁

@NotNull

@Min(18)

private Integer age;

public String getName() {

return this.name;

}

public void setName(String name) {

this.name = name;

}

public Integer getAge() {

return age;

}

public void setAge(Integer age) {

this.age = age;

}

public String toString() {

return "Person(Name: " + this.name + ", Age: " + this.age + ")";

}

}

接着看下如何在Controller层使用

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14
//非实体类参数可以直接使用注解

@GetMapping("/check")

@ResponseBody

public String check(@Min(0,message = "kpId必须大于等于0") @RequestParam int kpId,@RequestParam int level) {

return "ok";

}

//实体类注解校验使用@Valid

@PostMapping("/")

public String checkPersonInfo(@Valid PersonForm personForm, BindingResult bindingResult) {

if (bindingResult.hasErrors()) {

return "form";

}

return "redirect:/results";

}

注意上面的Spring提供的BindingResult是错误结果的一个封装,我们可以在web页面中通过这个对象拿到详细的错误信息,

?

1
<td th:if="${#fields.hasErrors('age')}" th:errors="*{age}">Age Error</td>

总结:

通过使用注解来快速检验传入的web参数还是非常简洁强大的,这里仅仅列举了一小部分的校验的知识,希望对大家的学习有所帮助,也希望大家多多支持快网idc。

原文链接:http://blog.csdn.net/u010454030/article/details/53009327

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

快网idc优惠网 建站教程 详解如何在Spring Boot项目使用参数校验 https://www.kuaiidc.com/116132.html

相关文章

发表评论
暂无评论