欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

springmvc使用JSR-303进行数据校验实例

程序员文章站 2024-03-06 12:32:49
项目中,通常使用较多的是前端的校验,比如页面中js校验以及form表单使用bootstrap校验。然而对于安全要求较高点建议在服务端进行校验。 服务端校验: 控...

项目中,通常使用较多的是前端的校验,比如页面中js校验以及form表单使用bootstrap校验。然而对于安全要求较高点建议在服务端进行校验。

服务端校验:

  • 控制层controller:校验页面请求的参数的合法性。在服务端控制层controller校验,不区分客户端类型。
  • 业务层service(使用较多):主要校验关键业务参数,仅限于service接口中使用的参数。
  • 持久层dao:一般是不校验的。

环境集成

1、添加jar包:

此处使用hibernate-validator实现(版本:hibernate-validator-4.3.0.final-dist.zip),将如下jar包添加到classpath(web-inf/lib下即可):

  • dist/lib/required/validation-api-1.0.0.ga.jar jsr-303规范api包
  • dist/hibernate-validator-4.3.0.final.jar hibernate 参考实现

2、在spring配置总添加对jsr-303验证框架的支持

<!-- 校验错误信息配置文件 -->
 <bean id="messagesource"
  class="org.springframework.context.support.reloadableresourcebundlemessagesource">
  <!-- 资源文件名-->
  <property name="basenames"> 
   <list> 
   <value>classpath:customvalidationmessages</value>
   </list> 
  </property>
  <!-- 资源文件编码格式 -->
  <property name="fileencodings" value="utf-8" />
  <!-- 对资源文件内容缓存时间,单位秒 -->
  <property name="cacheseconds" value="120" />
 </bean>

<!-- 校验器 -->
 <bean id="validator"
  class="org.springframework.validation.beanvalidation.localvalidatorfactorybean">
  <!-- hibernate校验器-->
  <property name="providerclass" value="org.hibernate.validator.hibernatevalidator" />
  <!-- 指定校验使用的资源文件,在文件中配置校验错误信息,如果不指定则默认使用classpath下的validationmessages.properties -->
  <property name="validationmessagesource" ref="messagesource" />
 </bean>

自动注册validator

<mvc:annotation-driven conversion-service="conversionservice" validator="validator">
 </mvc:annotation-driven>

例子说明

例子一:

import javax.validation.constraints.notnull; 
public class usermodel { 
 @notnull(message="{username.not.empty}") 
 private string username; 
} 

通过@notnull指定此username字段不允许为空,当验证失败时将从之前指定的messagesource中获取“username.not.empty”对于的错误信息,此处只有通过“{错误消息键值}”格式指定的才能从messagesource获取。

@controller 
public class helloworldcontroller { 
 @requestmapping("/validate/hello") 
 public string validate(@valid @modelattribute("user") usermodel user, errors errors) { 

  if(errors.haserrors()) { 
   return "validate/error"; 
  } 
  return "redirect:/success"; 
 } 
} 

通过在命令对象上注解@valid来告诉spring mvc此命令对象在绑定完毕后需要进行jsr-303验证,如果验证失败会将错误信息添加到errors错误对象中。

验证失败后需要展示的页面(/web-inf/jsp/error.jsp)

<%@ page language="java" contenttype="text/html; charset=utf-8" pageencoding="utf-8"%> 
<%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> 

<form:form commandname="user"> 
 <form:errors path="*" cssstyle="color:red"></form:errors><br/> 
</form:form> 

在浏览器地址栏中输入http://localhost:8080/validate/hello,即没有username数据,请求后将直接到验证失败界面并显示错误消息“用户名不能为空”,如果请求时带上“?username=zhang”将重定向到成功页面。

例子二:

public class items {
 private integer id;
 @size(min=1,max=20,message="{items.name.length.error}")
 private string name;

 @notnull(message="{items.createtime.isnull}")
 private date createtime;

 省略set()和get()...
}
public string edititemssubmit(model model, @validated items items, 
bindingresult bindingresult) throws exception {
  if(bindingresult.haserrors()){
   list<objecterror> allerrors = bindingresult.getallerrors();
   for(objecterror objecterror:allerrors) {
  system.out.println(objecterror.getdefaultmessage());
   }

   //可以直接使用model将提交pojo回显到页面
   model.addattribute("items",items);

   // 出错重新到商品修改页面
   return "items/edititems";
  }
  return "success";
 }
<table width="100%" border=1>
<tr>
 <td>商品名称</td>
 <td><form:input type="text" path="items.name" value="${items.name }"/></td><form:errors path="items.name"/>
</tr>
<tr>
 <td>商品生产日期</td>
 <td><input type="text" name="createtime" value="<fmt:formatdate value="${items.createtime}" pattern="yyyy-mm-dd hh:mm:ss"/>"/></td>
</tr>

然后jsp页面还是之前的页面,并能显示输入不合法的并通过<form:errors path="items.name"/>显示出来,这样明显更加简单。

当我们配置了messagesource bean时,默认将为验证的对象自动生成如下错误消息键:

  • 验证错误注解简单类名.验证对象名.字段名
  • 验证错误注解简单类名.字段名
  • 验证错误注解简单类名.字段类型全限定类名
  • 验证错误注解简单类名

使用的优先级是:从高到低,即最前边的具有最高的优先级,而且以上所有默认的错误消息键优先级高于自定义的错误消息键。

如测试用例

复制代码 代码如下:

public string pattern(@valid @modelattribute(“model”) patternmodel model, errors errors)

将自动产生如下错误消息键:

  • pattern.model.value=验证错误注解简单类名.验证对象名.字段名
  • pattern.value=验证错误注解简单类名.字段名
  • pattern.java.lang.string=验证错误注解简单类名.字段类型全限定类名
  • pattern=验证错误注解简单类名

内置的验证约束注解如下表所示(摘自hibernate validator reference):

验证注解 验证的数据类型 说明
@assertfalse boolean,boolean 验证注解的元素值是false
@asserttrue boolean,boolean 验证注解的元素值是true
@notnull 任意类型 验证注解的元素值不是null
@null 任意类型 验证注解的元素值是null
@min(value=值) bigdecimal,biginteger, byte, short, int, long,等任何number或charsequence(存储的是数字)子类型 验证注解的元素值大于等于@min指定的value值
@max(value=值) 和@min要求一样 验证注解的元素值小于等于@max指定的value值
@decimalmin(value=值) 和@min要求一样 验证注解的元素值大于等于@ decimalmin指定的value值
@decimalmax(value=值) 和@min要求一样 验证注解的元素值小于等于@ decimalmax指定的value值
@digits(integer=整数位数, fraction=小数位数) 和@min要求一样 验证注解的元素值的整数位数和小数位数上限
@size(min=下限, max=上限) 字符串、collection、map、数组等 验证注解的元素值的在min和max(包含)指定区间之内,如字符长度、集合大小
@past java.util.date, java.util.calendar; joda time类库的日期类型 验证注解的元素值(日期类型)比当前时间早
@future 与@past要求一样 验证注解的元素值(日期类型)比当前时间晚
@notblank charsequence子类型 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@notempty,@notblank只应用于字符串且在比较时会去除字符串的首位空格
@length(min=下限, max=上限) charsequence子类型 验证注解的元素值长度在min和max区间内
@notempty charsequence子类型、collection、map、数组 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@range(min=最小值, max=最大值) bigdecimal,biginteger,charsequence, byte, short, int, long等原子类型和包装类型 验证注解的元素值在最小值和最大值之间
@email(regexp=正则表达式,flag=标志的模式) charsequence子类型(如string) 验证注解的元素值是email,也可以通过regexp和flag指定自定义的email格式
@pattern(regexp=正则表达式,flag=标志的模式) string,任何charsequence的子类型 验证注解的元素值与指定的正则表达式匹配
@valid 任何非原子类型 指定递归验证关联的对象;如用户对象中有个地址对象属性,如果想在验证用户对象时一起验证地址对象的话,在地址对象上加@valid注解即可级联验证

此处只列出hibernate validator提供的大部分验证约束注解,请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。

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