软件编程
位置:首页>> 软件编程>> java编程>> springboot使用校验框架validation校验的示例

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

作者:双斜杠少年  发布时间:2021-06-10 18:20:25 

标签: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 。(内容为“名字不能为空“)

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<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 + "]";
 }
}

来源:http://blog.csdn.net/u012373815/article/details/72049796

0
投稿

猜你喜欢

手机版 软件编程 asp之家 www.aspxhome.com