《SpringMVC从入门到放肆》十三、SpringMVC数据校验 - SpringMVC从入门到放肆

上一章，我们学习了SpringMVC的自定义类型转换器，但是如果转换后的数据传递到Controller的方法中，忽然发现有某些属性为Null了，这怎么办？我们需要一种有效的数据校验机制，来对数据进行有效的校验。

一、什么是数据校验？

数据校验，顾名思义，就是对数据进行校验，比如在进行登录操作时，我们就需要对用户名和密码进行验证，最起码需要保证用户名和密码不能为空，其次还需要保证密码的长度在多少位之内，这就叫作数据校验。

数据校验分为客户端和服务端两种：

1、客户端校验：JS校验。

2、服务端校验：SpringMVC的validation、Struts的validation，都有自己的校验机制。

二、开发准备

1、添加JAR包

1hibernate-validator-5.1.2.Final.jar
2validation-api-1.1.0.Final.jar

2、MAVEN的话，需要引入以下依赖

 1<!-- jsr303 validation dependencies-->
 2<dependency>
 3    <groupId>javax.validation</groupId>
 4    <artifactId>validation-api</artifactId>
 5    <version>${javax.validation.version}</version>
 6</dependency>
 7<dependency>
 8    <groupId>org.hibernate</groupId>
 9    <artifactId>hibernate-validator</artifactId>
10    <version>${hibernate.validator.version}</version>
11</dependency>

3、在spring-servlet.xml.xml中配置validator校验器

 1<!-- 校验器，配置validator -->
 2<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
 3    <property name="providerClass" value="org.hibernate.validator.HibernateValidator"></property>
 4    <property name="validationMessageSource" ref="validationMessageSource"></property>
 5</bean>
 6
 7<!-- 配置validationMessageSource -->
 8<bean id="validationMessageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
 9    <!-- 指定校验信息的资源文件的基本文件名称，不包括后缀，后缀默认是properties -->
10    <property name="basenames">
11        <list>
12            <value>classpath:validation</value>
13        </list>
14    </property>
15    <!-- 指定文件的编码 -->
16    <property name="fileEncodings" value="utf8"></property>
17    <!-- 对资源文件内容缓存的时间，单位秒 -->
18    <property name="cacheSeconds" value="120"></property>
19</bean>

4、将校验器注册到适配器中

方法一（推荐，如果大家用的是注解式编程，推荐使用该方法）：

1<mvc:annotation-driven validator="validator" />

方法二（如果大家使用非注解式变成，则可以按以下配置方法）

1<!-- 自定义WebBinding -->
2<bean id="myWebBinding" class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
3    <property name="validator" ref="validator" />
4</bean>
5
6<!-- 适配器 -->
7<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
8    <property name="webBindingInitializer" ref="myWebBinding" />
9</bean>

5、validation.properties
在src/main/resources下创建validation.properties文件，该配置文件的作用就是存校验失败的提示信息，如下：

1user.username.notnull=用户名不能为空
2user.password.notnull=密码不能为空
3user.password.size=密码长度必须为6-16位

三、具体开发

1、创建实体SysUser.java，并指定校验规则

 1package cn.itechyou.entity;
 2
 3import java.io.Serializable;
 4
 5import javax.validation.constraints.NotNull;
 6import javax.validation.constraints.Size;
 7
 8public class SysUser implements Serializable {
 9    @NotNull(message = "{user.username.notnull}")
10    private String username;
11    @NotNull(message = "{user.password.notnull}")
12    @Size(min = 6, max = 16, message = "{user.password.size}")
13    private String password;
14
15    //省略getter、setter
16}

注意：
1：{user.username.notnull}和{user.password.size}就是读取validation.properties配置文件中配置的信息。
2：使用注解对需要进行校验的属性进行绑定，而能够使这些注解生效的前提就是配置此前的几个步骤

2、在Controller中使用

 1package cn.itechyou.controller;
 2
 3import java.util.List;
 4
 5import org.springframework.stereotype.Controller;
 6import org.springframework.ui.Model;
 7import org.springframework.validation.BindingResult;
 8import org.springframework.validation.ObjectError;
 9import org.springframework.validation.annotation.Validated;
10import org.springframework.web.bind.annotation.RequestMapping;
11
12import cn.itechyou.entity.SysUser;
13
14@Controller
15@RequestMapping("/user")
16public class UserController {
17
18    /**
19     * 登录
20     * @param model
21     * @param user
22     * @param result
23     * @return
24     */
25    @RequestMapping("/login")
26    public String login(Model model,@Validated SysUser user,BindingResult result) {
27        if(result.hasErrors()) {
28            List<ObjectError> allErrors = result.getAllErrors();
29            for (ObjectError objectError : allErrors) {
30                System.out.println(objectError.getDefaultMessage());
31            }
32            model.addAttribute("errors", allErrors);
33            return "login";
34        }
35        return "success";
36    }
37}