详解SpringMVC学习系列（6） 之 数据验证

在系列（4）、（5）中我们展示了如何绑定数据，绑定完数据之后如何确保我们得到的数据的正确性？这就是我们本篇要说的内容 —> 数据验证。

这里我们采用hibernate-validator来进行验证，hibernate-validator实现了jsr-303验证框架支持注解风格的验证。首先我们要到下载需要的jar包，这里以4.3.1.final作为演示，解压后把hibernate-validator-4.3.1.final.jar、jboss-logging-3.1.0.jar、validation-api-1.0.0.ga.jar这三个包添加到项目中。

配置之前项目中的springservlet-config.xml文件，如下：

<!-- 默认的注解映射的支持 --> 
  <mvc:annotation-driven validator="validator" conversion-service="conversion-service" />
  
  <bean id="validator" class="org.springframework.validation.beanvalidation.localvalidatorfactorybean">
    <property name="providerclass" value="org.hibernate.validator.hibernatevalidator"/>
    <!--不设置则默认为classpath下的 validationmessages.properties -->
    <property name="validationmessagesource" ref="validatemessagesource"/>
  </bean>
  <bean id="conversion-service" class="org.springframework.format.support.formattingconversionservicefactorybean" />
  <bean id="validatemessagesource" class="org.springframework.context.support.reloadableresourcebundlemessagesource"> 
    <property name="basename" value="classpath:validatemessages"/> 
    <property name="fileencodings" value="utf-8"/> 
    <property name="cacheseconds" value="120"/> 
  </bean>

其中<property name="basename" value="classpath:validatemessages"/>中的classpath:validatemessages为注解验证消息所在的文件，需要我们在resources文件夹下添加。

在com.demo.web.controllers包中添加一个validatecontroller.java内容如下：

package com.demo.web.controllers;

import java.security.nosuchalgorithmexception;
import javax.validation.valid;
import org.springframework.stereotype.controller;
import org.springframework.ui.model;
import org.springframework.validation.bindingresult;
import org.springframework.web.bind.annotation.modelattribute;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.requestmethod;
import com.demo.web.models.validatemodel;

@controller
@requestmapping(value = "/validate")
public class validatecontroller {
  
  @requestmapping(value="/test", method = {requestmethod.get})
  public string test(model model){

    if(!model.containsattribute("contentmodel")){
      model.addattribute("contentmodel", new validatemodel());
    }
    return "validatetest";
  }
  
  @requestmapping(value="/test", method = {requestmethod.post})
  public string test(model model, @valid @modelattribute("contentmodel") validatemodel validatemodel, bindingresult result) throws nosuchalgorithmexception{
    
    //如果有验证错误 返回到form页面
    if(result.haserrors())
      return test(model);
    return "validatesuccess";   
  }
  
}

其中@valid @modelattribute("contentmodel") validatemodel validatemodel的@valid 意思是在把数据绑定到@modelattribute("contentmodel") 后就进行验证。

在com.demo.web.models包中添加一个validatemodel.java内容如下：

package com.demo.web.models;

import org.hibernate.validator.constraints.email;
import org.hibernate.validator.constraints.notempty;
import org.hibernate.validator.constraints.range;

public class validatemodel{
  
  @notempty(message="{name.not.empty}")
  private string name;
  @range(min=0, max=150,message="{age.not.inrange}")
  private string age;
  @notempty(message="{email.not.empty}")
  @email(message="{email.not.correct}")
  private string email;
  
  public void setname(string name){
    this.name=name;
  }
  public void setage(string age){
    this.age=age;
  }
  public void setemail(string email){
    this.email=email;
  }
  
  public string getname(){
    return this.name;
  }
  public string getage(){
    return this.age;
  }
  public string getemail(){
    return this.email;
  }
  
}

在注解验证消息所在的文件即validatemessages.properties文件中添加以下内容：

name.not.empty=\u540d\u79f0\u4e0d\u80fd\u4e3a\u7a7a\u3002
age.not.inrange=\u5e74\u9f84\u8d85\u51fa\u8303\u56f4\u3002
email.not.correct=\u90ae\u7bb1\u5730\u5740\u4e0d\u6b63\u786e\u3002
email.not.empty=\u7535\u5b50\u90ae\u4ef6\u4e0d\u80fd\u60df\u6050\u3002

其中name.not.empty等分别对应了validatemodel.java文件中message=”xxx”中的xxx名称，后面的内容是在输入中文是自动转换的ascii编码，当然你也可以直接把xxx写成提示内容，而不用另建一个validatemessages.properties文件再添加，但这是不正确的做法，因为这样硬编码的话就没有办法进行国际化了。

在views文件夹中添加validatetest.jsp和validatesuccess.jsp两个视图，内容分别如下：

<%@ page language="java" contenttype="text/html; charset=utf-8"
  pageencoding="utf-8"%>
<!doctype html public "-//w3c//dtd html 4.01 transitional//en" "http://www.w3.org/tr/html4/loose.dtd">

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>

<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>insert title here</title>
</head>
<body>
  <form:form modelattribute="contentmodel" method="post">   
    
    <form:errors path="*"></form:errors><br/><br/>
      
    name：<form:input path="name" /><br/>
    <form:errors path="name"></form:errors><br/>
    
    age：<form:input path="age" /><br/>
    <form:errors path="age"></form:errors><br/>
    
    email：<form:input path="email" /><br/>
    <form:errors path="email"></form:errors><br/>

    <input type="submit" value="submit" />
    
  </form:form> 
</body>
</html>

<%@ page language="java" contenttype="text/html; charset=utf-8"
  pageencoding="utf-8"%>
<!doctype html public "-//w3c//dtd html 4.01 transitional//en" "http://www.w3.org/tr/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>insert title here</title>
</head>
<body>
  验证成功！
</body>
</html>

其中特别要指出的是validatetest.jsp视图中<form:form modelattribute="contentmodel" method="post">的modelattribute="xxx"后面的名称xxx必须与对应的@valid @modelattribute("xxx") 中的xxx名称一致，否则模型数据和错误信息都绑定不到。

<form:errors path="name"></form:errors>即会显示模型对应属性的错误信息，当path="*"时则显示模型全部属性的错误信息。

运行测试：

直接点击提交：

可以看到正确显示了设置的错误信息。

填写错误数据提交：

可以看到依然正确显示了设置的错误信息。

填写正确数据提交：

可以看到验证成功。

下面是主要的验证注解及说明：

数据验证的内容到此结束，代码下载：demo

更多信息请参考官方文档：http://docs.jboss.org/hibernate/validator/4.3/reference/en-us/html/validator-usingvalidator.html

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