一、Validation
b/s系统中对http请求数据的校验多数在客户端进行,这也是出于简单及用户体验性上考虑,但是在一些安全性要求高的系统中服务端校验是不可缺少的,springmvc实现控制层添加校验。
Spring3支持JSR-303验证框架,JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation,官方参考实现是Hibernate Validator(与Hibernate ORM 没有关系),JSR 303 用于对Java Bean 中的字段的值进行验证。
目前最新的为:JSR-349
二、Maven依赖
<!--数据校验依赖-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.4.3.Final</version>
</dependency>
三、配置spring-mvc.xml
<!--校数校验-->
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
<property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
<!-- 如果不加默认到 使用classpath下的ValidationMessages.properties -->
<property name="validationMessageSource" ref="messageSource"/>
</bean>
<!-- 国际化的消息资源文件(本系统中主要用于显示/错误消息定制) -->
<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
<property name="basenames">
<list>
<!-- 在web环境中一定要定位到classpath 否则默认到当前web应用下找-->
<value>classpath:messages</value>
</list>
</property>
<property name="useCodeAsDefaultMessage" value="false"/>
<property name="defaultEncoding" value="UTF-8"/>
<property name="cacheSeconds" value="60"/>
</bean>
<!--添加数据校验器-->
<mvc:annotation-driven validator="validator"/>
四、创建错误消息提示文件messages.properties
user.username.null=用户不能为空
user.password.illegal=密码必须为5到20之间的大小写字符
user.age.illegal=年龄必须在18到60之间。
五、实体类
import lombok.Data;
import org.hibernate.validator.constraints.NotEmpty;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import java.util.Date;
@Data
public class User {
private Long id;
@NotNull(message = "{user.username.null}")
private String username;
@Pattern(regexp = "[a-zA-Z]{5,20}", message = "{user.password.illegal}")
private String password;
@Range(min = 18, max = 60, message = "{user.age.illegal}")
private Integer age;
@DateTimeFormat(pattern = "yyyy-MM-dd")
private Date birth;
}
六、控制器
/**
* @param model 用于向页面传递数据
* @param user
* @param result 获取校验错误信息
* @return
*/
@PostMapping("add")
public ModelAndView add(Model model,@Valid User user, BindingResult result) {
if (result.hasErrors()) {
log.info("数据校验失败");
// 输出错误信息
List<ObjectError> allErrors = result.getAllErrors();
for (ObjectError objectError : allErrors) {
// 输出错误信息
log.info(objectError.getDefaultMessage());
}
// 将错误信息传到页面
model.addAttribute("allErrors", allErrors);
}
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("/user/addUser");
return modelAndView;
}
七、JSP页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head>
<title>错误显示</title>
</head>
<body>
<c:if test="${allErrors!=null }">
<ul>
<c:forEach items="${allErrors}" var="error">
<li>${error.defaultMessage}</li>
</c:forEach>
</ul>
</c:if>
</body>
</html>
八、测试
九、分组校验
在pojo中定义校验规则,而pojo是被多个Controller所共用的。当不同的Controller方法对同一个pojo进行校验时,但是每个 Controller方法需要不同的校验怎么办。例如有的Controller只需要校验商品的名字长度,有的Controller需要校验日期。
定义多个不同的校验分组。多个不同的校验分组其实就是一个接口。每个Controller方法使用不同的校验分组。
而在校验分组中定义了哪些校验规则。
- 定义分组:
分组就是一个标识,这里定义一个接口:
public interface ValidGroup1 {
//接口中不需要定义任何方法,仅是对不同的校验规则进行分组
//此分组只校验商品名称长度
}
public interface ValidGroup2 {
//接口中不需要定义任何方法,仅是对不同的校验规则进行分组
}
- POJO 注解校验
// 这里指定分组ValidGroup1,此@Size校验只适用ValidGroup1校验
@Size(min=1,max=30,message="{user.username.length.error}",groups={Val
idGroup1.class})
private String username;
在@Validated 中添加 value={ValidGroup1.class}表示商品修改使用了 ValidGroup1 分组校验规则,也可以指定多个分组中间用逗号分隔,
@Validated(value={ValidGroup1.class,ValidGroup2.class })
- 控制器调用
@PostMapping("add")
public ModelAndView add(Model model,@Validated({ValidGroup1.class}) User user, BindingResult result) {
}
十、校验注解
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator 附加的 constraint
@NotBlank(message =) 验证字符串非 null,且长度必须大于 0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内