首页 > 开发 > Java > 正文

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

2024-07-13 10:08:36
字体:
来源:转载
供稿:网友

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

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

核心的pom依赖:

<dependency>  <groupId>org.hibernate</groupId>  <artifactId>hibernate-validator</artifactId>  <version>5.3.1.Final</version></dependency>

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

@Configuration@EnableAutoConfigurationpublic class FactoryConfig {    final static Logger logger= LoggerFactory.getLogger(FactoryConfig.class);   @Bean  public MethodValidationPostProcessor methodValidationPostProcessor(){   return new MethodValidationPostProcessor();  }    }

校验常用的注解如下:

@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实体类进行校验

下面看一个使用例子:

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层使用

//非实体类参数可以直接使用注解 @GetMapping("/check")@ResponseBodypublic 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页面中通过这个对象拿到详细的错误信息,

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

总结:

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

 

注:相关教程知识阅读请移步到JAVA教程频道。
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表