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

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

bean validation 1.0（jsr-303）是一个校验规范，在spring boot项目由于自带了hibernate validator 5()实现，所以我们可以非常方便的使用这个特性 。

核心的pom依赖：

<dependency>
  <groupid>org.hibernate</groupid>
  <artifactid>hibernate-validator</artifactid>
  <version>5.3.1.final</version>
</dependency>

首先，需要我们声明一个bean，注入校验器到spring boot的运行环境

@configuration
@enableautoconfiguration
public 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")
@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页面中通过这个对象拿到详细的错误信息,

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

总结：

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