Spring MVC 数据校验

数据校验是 Web 应用必须处理的内容，Spring MVC 提供了两种方法来对用户的输入数据进行校验，一种是 Spring 自带的 Validation 校验框架，另一种是利用 JRS-303 验证框架进行验证。

Hibernate-Validator 实现了 JSR-303 验证框架支持注解风格的验证。

Hibernate-Validator 主要的校验注解说明：

注解 功能 @Null 验证对象是否为 null @NotNull 验证对象是否不为 null @AssertTrue 验证 Boolean 对象是否为 true @AssertTrue 验证 Boolean 对象是否为 false @Max(value) 验证 Number 和 String 对象是否小于等于指定值 @Min(value) 验证 Number 和 String 对象是否大于等于指定值 @DecimalMax(value) 验证注解的元素值小于等于 @DecimalMax 指定的 value 值 @DecimalMin(value) 验证注解的元素值大于等于 @DecimalMin 指定的 value 值 @Digits(integer,fraction) 验证字符串是否符合指定格式的数字，integer 指定整数精度，fraction 指定小数精度 @Size(min,max) 验证对象长度是否在给定的范围内 @Past 验证 Date 和 Calendar 对象是否在当前时间之前 @Future 验证 Date 和 Calendar 对象是否在当前时间之后 @Pattern 验证 String 对象是否符合正则表达式的规则 @NotBlank 检查字符串是不是 Null，被 Trim 的长度是否大于0，只对字符串，且会去掉前后空格 @URL 验证是否是合法的 url @Email 验证是否是合法的邮箱 @CreditCardNumber 验证是否是合法的信用卡号 @Length(min,max) 验证字符串的长度必须在指定范围内 @NotEmpty 检查元素是否为 Null 或 Empty @Range(min,max,message) 验证属性值必须在合适的范围内

这里给个 Hibernate-Validator 验证注册信息的简单例子：

环境

• JDK1.7
• Tomcat 7
• Spring MVC 4.2.0 RELEASE

注：Spring MVC 相关 jar 包我已经上传到 这里 ，包括 Spring 的全部 jar、commons 相关 jar 和 Hibernate-Validator 的相关 jar。

项目结构

1 新建项目工程

（1）首先在 Eclipse 里新建一个动态 Web 工程（Dynamic Web Project），命名为 ValidatorTest ，并自动生成 web.xml。
（2）将前面下载的 jar 包拷贝到工程的 WebContent/WEB-INF/lib/ 目录下。

2 配置 web.xml 文件

修改 web.xml 文件内容如下：

<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">  <display-name>ValidatorTest</display-name>    <!-- 配置 Spring MVC DispatchcerServlet 前端控制器 -->    <servlet>        <servlet-name>springmvc</servlet-name>        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>        <init-param>            <param-name>contextConfigLocation</param-name>            <param-value>/WEB-INF/springmvc-config.xml</param-value>        </init-param>        <load-on-startup>1</load-on-startup>    </servlet>    <!-- Servlet 映射声明 -->    <servlet-mapping>        <servlet-name>springmvc</servlet-name>        <url-pattern>/</url-pattern>    </servlet-mapping>    <!-- 避免中文乱码 -->    <filter>        <filter-name>characterEncodingFilter</filter-name>        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>        <init-param>            <param-name>encoding</param-name>            <param-value>UTF-8</param-value>        </init-param>        <init-param>            <param-name>forceEncoding</param-name>            <param-value>true</param-value>        </init-param>    </filter>    <filter-mapping>        <filter-name>characterEncodingFilter</filter-name>        <url-pattern>/*</url-pattern>    </filter-mapping>

3 springmvc-config.xml 文件

在 WebContent/WEB-INF/ 目录下新建 Spring MVC 配置文件 springmvc-config.xml，添加如下代码：

<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context"    xmlns:aop="http://www.springframework.org/schema/aop"    xsi:schemaLocation="http://www.springframework.org/schema/beans        http://www.springframework.org/schema/beans/spring-beans-4.2.xsd        http://www.springframework.org/schema/mvc        http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd        http://www.springframework.org/schema/context        http://www.springframework.org/schema/context/spring-context-4.2.xsd        http://www.springframework.org/schema/aop        http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">    <context:component-scan base-package="gler.bind.controller" />    <mvc:annotation-driven />    <bean id="viewResolver"        class="org.springframework.web.servlet.view.InternalResourceViewResolver">        <property name="prefix" value="/WEB-INF/views/" />        <property name="suffix" value=".jsp" />    </bean></beans>

4 实体类

在项目目录 Java Resources/src 的包 gler.bind.entity 下新建类 User.java，包含 username、password、age、phone 和 email 属性，在 User 类要校验的属性前添加必要的 Hibernate Validator 注解对前台提交的数据进行验证，代码如下：

package gler.bind.entity;import javax.validation.constraints.Pattern;import org.hibernate.validator.constraints.Email;import org.hibernate.validator.constraints.Length;import org.hibernate.validator.constraints.NotBlank;import org.hibernate.validator.constraints.Range;public class User {    @NotBlank(message = "用户名不能为空")    private String username;    @NotBlank(message = "密码不能为空")    @Length(min = 6, max = 16, message = "密码的长度必须在6~16位之间")    private String password;    @Range(min = 18, max = 60, message = "年龄必须在18岁到60岁之间")    private Integer age;    @Pattern(regexp = "^1[3|4|5|7|8][0-9]{9}$", message = "请输入正确格式的手机号")    private String phone;    @Email(message = "请输入合法的邮箱地址")    private String email;    public String getUsername() {        return username;    }    public void setUsername(String username) {        this.username = username;    }    public String getPassword() {        return password;    }    public void setPassword(String password) {        this.password = password;    }    public Integer getAge() {        return age;    }    public void setAge(Integer age) {        this.age = age;    }    public String getPhone() {        return phone;    }    public void setPhone(String phone) {        this.phone = phone;    }    public String getEmail() {        return email;    }    public void setEmail(String email) {        this.email = email;    }}

5 Controller 类的实现

在包 gler.bind.controller 下新建 Controller 类 UserController.java，代码如下：

package gler.bind.controller;import javax.validation.Valid;import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.validation.Errors;import org.springframework.web.bind.annotation.ModelAttribute;import org.springframework.web.bind.annotation.RequestMapping;import gler.bind.entity.User;@Controllerpublic class UserController {    // 进入注册页面    @RequestMapping(value = "/registerform")    public String registerform(Model model) {        model.addAttribute("user", new User());        return "register";    }    // 注册请求的响应方法    @RequestMapping(value = "/register")    public String register(@Valid  @ModelAttribute("user") User user, Errors errors,Model model) {        if(errors.hasErrors()){            return "register";        }        model.addAttribute("user", user);        return "success";    }}

其中 @Valid @ModelAttribute("user") User user 的 @Valid 意思是在把数据绑定到 @ModelAttribute("user") 后就进行验证。后面跟着 Errors 对象保存校验信息，如果 errors 中有错误信息，则返回 register 页面，验证成功则跳转到 success 页面。

6 JSP 页面

（1）register.jsp

在 WebContent/WEB-INF 目录下新建文件夹 views，并在该路径下新建一个 JSP 页面命名为 register.jsp，添加 <form:errors> 标签显示属性的错误信息，代码如下：

<%@ 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>注册页面</title></head><body>    <div id="global">        <form:form modelAttribute="user" method="post" action="register">            <fieldset>                <legend>注册</legend>                <p>                    <label>用户名:</label>                    <form:input path="username" />                    <form:errors path="username" cssStyle="color:red"/>                </p>                <p>                    <label>密   码:</label>                    <form:password path="password" />                    <form:errors path="password" cssStyle="color:red"/>                </p>                <p>                    <label>年   龄:</label>                    <form:input path="age" />                    <form:errors path="age" cssStyle="color:red"/>                </p>                <p>                    <label>电   话:</label>                    <form:input path="phone" />                    <form:errors path="phone" cssStyle="color:red"/>                </p>                <p>                    <label>邮   箱:</label>                    <form:input path="email" />                    <form:errors path="email" cssStyle="color:red"/>                </p>                <p id="buttons">                    <input id="submit" type="submit" value="注册"> <input                        id="reset" type="reset" value="重置">                </p>            </fieldset>        </form:form>    </div></body></html>

（2）success.jsp

在 WebContent/WEB-INF/views 目录下新建一个 JSP 页面命名为 success.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"><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Insert title here</title></head><body>    <h5>注册成功，个人信息如下：</h5>    用户名：${user.username}    <br />密   码：${user.password}    <br />年   龄：${user.age}    <br />电   话：${user.phone}    <br />邮   箱：${user.email}    <br /></body></html>

7 运行测试

在 Tomcat 上运行 BindTest，打开浏览器输入 URL http://localhost:8080/ValidatorTest/registerform：

什么注册信息都不填，点击注册：

填写部分不合格信息：

如果信息验证通过，跳转至成功页面，显示用户的基本信息：

参考链接

• 《Spring+MyBatis 企业应用实战》
• Spring MVC—数据绑定和表单标签