springboot使用校验框架validation校验的示例

b/s系统中对http请求数据的校验多数在客户端进行，这也是出于简单及用户体验性上考虑，但是在一些安全性要求高的系统中服务端校验是不可缺少的。

spring3支持jsr-303验证框架，jsr-303 是java ee 6 中的一项子规范，叫做beanvalidation，官方参考实现是hibernate validator（与hibernate orm 没有关系），jsr 303 用于对java bean 中的字段的值进行验证。

validator主要是校验用户提交的数据的合理性的，比如是否为空了，密码长度是否大于6位，是否是纯数字的，等等。那么在spring boot怎么使用这么强大的校验框架呢。

validation与 springboot 结合

1. bean 中添加标签

部分代码：

标签需要加在属性上，@notblank 标签含义文章末尾有解释

public class user {
  private integer id;
  @notblank(message = "{user.name.notblank}")
  private string name;
  private string username;

2. controller中开启验证

在controller 中 请求参数上添加@validated 标签开启验证

  @requestmapping(method = requestmethod.post)
  public user create(@requestbody @validated user user) {
    return userservice.create(user);
  }

3. resource 下新建错误信息配置文件

在resource 目录下新建提示信息配置文件“validationmessages.properties“

注意：名字必须为“validationmessages.properties“ 因为springboot自动读取classpath中的validationmessages.properties里的错误信息

validationmessages.properties 文件的编码为ascii。数据类型为 key value 。key“user.name.notblank“为第一步 bean的标签 大括号里面对应message的值

value 为提示信息 ，但是是ascii 。（内容为“名字不能为空“）

4. 自定义异常处理器，捕获错误信息

当验证不通过时会抛异常出来，异常的message 就是 validationmessages.properties 中配置的提示信息。此处定义异常处理器。捕获异常信息（因为验证不通过的项可能是多个所以统一捕获处理），并抛给前端。（此处是前后端分离开发）

  public void methodargumentnotvalidexception(exception ex, httpservletrequest request, httpservletresponse response) {
    logger.error( ":" + commonutil.gethttpclientinfo(request), ex);
    methodargumentnotvalidexception c = (methodargumentnotvalidexception) ex;
    list<objecterror> errors =c.getbindingresult().getallerrors();
    stringbuffer errormsg=new stringbuffer();
    errors.stream().foreach(x -> errormsg.append(x.getdefaultmessage()).append(";"));
    pouplateexceptionresponse(response, httpstatus.internal_server_error, errormsg.tostring());
  }


 private void pouplateexceptionresponse(httpservletresponse response, httpstatus errorcode, string errormessage) {
    try {
      response.senderror(errorcode.value(), errormessage);
    } catch (ioexception e) {
      logger.error("failed to populate response error", e);
    }
  }

5. 附上部分标签含义

限制	说明
@null	限制只能为null
@notnull	限制必须不为null
@assertfalse	限制必须为false
@asserttrue	限制必须为true
@decimalmax(value)	限制必须为一个不大于指定值的数字
@decimalmin(value)	限制必须为一个不小于指定值的数字
@digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@future	限制必须是一个将来的日期
@max(value)	限制必须为一个不大于指定值的数字
@min(value)	限制必须为一个不小于指定值的数字
@past	限制必须是一个过去的日期
@pattern(value)	限制必须符合指定的正则表达式
@size(max,min)	限制字符长度必须在min到max之间
@past	验证注解的元素值（日期类型）比当前时间早
@notempty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@notblank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@notempty，@notblank只应用于字符串且在比较时会去除字符串的空格
@email	验证注解的元素值是email，也可以通过正则表达式和flag指定自定义的email格式

示例

 @pattern(regexp="^[a-za-z0-9]+$",message="{account.username.space}")
 @size(min=3,max=20,message="{account.username.size}")

示例2

在这里我们主要是使用注解进行学习。我们先说说我们的需求：

我们有一个demo.html，在页面上有两个元素 姓名输入框，密码输入库，提交按钮。

提交到后台之后，使用validator进行校验，然后如果存在错误，转发到demo.html,

我们先编写一个实体类接收用户的输入，以及使用validator注解校验：

package com.kfit.demo;
 
import org.hibernate.validator.constraints.length;
import org.hibernate.validator.constraints.notempty; 
public class demo {  
  private long id; 
  @notempty(message="姓名不能为空")
  private string name;  
  @notempty(message="密码不能为空")
  @length(min=6,message="密码长度不能小于6位")
  private string password;
 
  publiclong getid() {
    return id;
  }
 
  publicvoid setid(longid) {
    this.id = id;
  }
 
  public string getname() {
    return name;
  }
 
  public void setname(string name) {
    this.name = name;
  }
 
  public string getpassword() {
    return password;
  }
 
  public void setpassword(string password) {
    this.password = password;
  }
 
  @override
  public string tostring() {
    return "demo [id=" + id + ", name=" + name + ", password=" + password + "]";
  }
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。