第十二章 数据校验
在Web应用三层架构体系中,表述层负责接收浏览器提交的数据,业务逻辑层负责数据的处理。为了能够让业务逻辑层基于正确的数据进行处理,我们需要在表述层对数据进行检查,将错误的数据隔绝在业务逻辑层之外。
1.校验概述
JSR 303是Java为Bean数据合法性校验提供的标准框架,它已经包含在JavaEE 6.0标准中。JSR 303通过在Bean 属性上标注类似于@NotNull、@Max等标准的注解指定校验规则,并通过标准的验证接口对Bean进行验证。
JSR 303只是一套标准,需要提供其实现才可以使用。Hibernate Validator是JSR 303的一个参考实现,除支持所有标准的校验注解外,它还支持以下的扩展注解:
Spring4.0拥有自己独立的数据校验框架,同时支持JSR 303标准的校验框架。Spring在进行数据绑定时,可同时调用校验框架完成数据校验工作。在Spring MVC中,可直接通过注解驱动(mvc:annotation-driven)的方式进行数据校验。Spring的LocalValidatorFactroyBean既实现了Spring的Validator接口,也实现了JSR 303的 Validator接口。只要在Spring容器中定义了一个LocalValidatorFactoryBean,即可将其注入到需要数据校验的 Bean中。Spring本身并没有提供JSR 303的实现,所以必须将JSR 303的实现者的jar包放到类路径下。
配置mvc:annotation-driven/后,SpringMVC会默认装配好一个LocalValidatorFactoryBean,通过在处理方法的入参上标注@Validated注解即可让Spring MVC在完成数据绑定后执行数据校验的工作。
2.操作步骤
①导入验证环境
[1]在当前工程类路径下加入以下jar包
1classmate-0.8.0.jar
2hibernate-validator-5.0.0.CR2.jar
3hibernate-validator-annotation-processor-5.0.0.CR2.jar
4jboss-logging-3.1.1.GA.jar
5validation-api-1.1.0.CR1.jar
[2]在Tomcat的lib目录下加入以下jar包[Tomcat7及以上版本不需要加]
1javax.el-2.2.4.jar
2javax.el-api-2.2.4.jar
3el-api-2.2.jar
②在需要验证的字段上添加验证注解
@NotEmpty private String empName;
③目标方法的bean前添加@Validated注解
※注意:在@Validated注解修饰的bean之后, 紧跟Errors(或BindingResult)类型的参数。在@Validated注解修饰的bean和Errors参数之间不能再有其他的参数!
④调用hasErrors()方法在目标方法中检验是否没有通过验证
//检测是否存在“数据绑定”错误 boolean hasErrors = bindingResult.hasErrors(); if(hasErrors) { return "error"; }
⑤显示错误消息
[1]使form:errors标签 [2]form:errors 标签必须在 SpringMVC 的 form:form 标签中使用
<form:form modelAttribute="employee"> <form:input path="age"/><form:errors path="age"/> </form:form>
实战案例:
正确的数据
页面:
<a href="${pageContext.request.contextPath }/convert?age=15">测试自动的类型转换</a>
Employee
public class Employee { private Integer age; @DateTimeFormat(pattern="yyyy-MM-dd") private Date birthday;
spring-mvc.xml
<context:component-scan base-package="com.spring.mvc.handlers"/> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/page/"/> <property name="suffix" value=".jsp"/> </bean>
handlers
@RequestMapping("/convert") public String convertFail(Employee employee, BindingResult bindingResult, Model model) { System.out.println(employee); //检测是否存在“数据绑定”错误 boolean hasErrors = bindingResult.hasErrors(); if(hasErrors) { return "error"; } model.addAttribute("employee", employee); return "target"; }
error.jsp
<h1>Error</h1> <form:form modelAttribute="employee"> <form:input path="age"/><form:errors path="age"/> </form:form>
target.jsp
<h1>Target</h1>
页面点击‘’测试自动的类型转换‘’
控制台输出Employee [age=15, birthday=null]
给一个类型错误的数据
页面:
<a href="${pageContext.request.contextPath }/convert?age=abc">测试自动的类型转换</a>
Employee
public class Employee { private Integer age;
点击页面‘’测试自动的类型转换‘’后
控制台输出Employee [age=null, birthday=null]
页面显示
我们再深入了解数据校验,自定义类型转换
直接上代码更直观
还是引用上面的代码
spring-mvc.xml
<context:component-scan base-package="com.spring.mvc.handlers"/> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/page/"/> <property name="suffix" value=".jsp"/> </bean> <!-- 配置自定义类型转换器 --> <bean id="embeddedValueResolverAware" class="org.springframework.format.support.FormattingConversionServiceFactoryBean"> <property name="converters"> <set><!-- 这里是我们自己写的类,用类设置自己需要的类型转换--> <bean class="com.spring.mvc.convert.AddressConvert"/> </set> </property> </bean> <mvc:annotation-driven conversion-service="embeddedValueResolverAware"/>
Address
public class Address { private String city; private String street; private String no;
Student
public class Student { private Integer stuId; private String stuName; private Address address;
AddressConvert
import org.springframework.core.convert.converter.Converter; import com.atguigu.spring.mvc.entity.Address; public class AddressConvert implements Converter<String, Address> { @Override public Address convert(String source) { //使用逗号分隔符拆分字符串 String[] split = source.split(","); //从拆分得到的数组中获取Address对象的各个属性值 String city = split[0]; String street = split[1]; String no = split[2]; //创建对象并返回 return new Address(city, street, no); } }
页面:
<form action="${pageContext.request.contextPath }/convert/save/stu" method="post"> id:<input type="text" name="stuId" /><br/> 姓名:<input type="text" name="stuName" /><br/> 地址:<input type="text" name="address"/><br/> <input type="submit" value="保存"/> </form>
handlers
@Controller public class ConvertHandler { @RequestMapping("/convert/save/stu") public String saveStu(Student student) { System.out.println(student); return "target"; }
页面
控制台输出
Student [stuId=45, stuName=gf, address=Address [city=fgf, street=hfdfd, no=gfddf]]
如果Student和Address实体类没有给toString方法,那address=只有地址
执行saveStu方法完