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

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

专注于为中小企业提供成都做网站、成都网站制作服务,电脑端+手机端+微信端的三站合一,更高效的管理,为中小企业定边免费做网站提供优质的服务。我们立足成都，凝聚了一批互联网行业人才，有力地推动了1000多家企业的稳健成长，帮助中小企业通过网站建设实现规模扩充和转变。

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 。（内容为“名字不能为空“）

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

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

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

  public void MethodArgumentNotValidException(Exception ex, HttpServletRequest request, HttpServletResponse response) {
    logger.error( ":" + CommonUtil.getHttpClientInfo(request), ex);
    MethodArgumentNotValidException c = (MethodArgumentNotValidException) ex;
    List 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 + "]";
  }
}

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

名称栏目：springboot使用校验框架validation校验的示例
文章起源：http://dzwzjz.com/article/ppjdpd.html

大橙子网站建设，新征程启航

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

其他资讯