一、准备
1.1 校验理解
项目中,通常使用较多的是前端的校验,比如页面中js
校验。对于安全要求较高建议在服务端进行校验。服务端校验有:
- 控制层:校验页面请求的参数的合法性。在服务端校验不区分客户端(pc、手机、远程调用),其校验是一致的。
- 业务层(使用较多):主要校验关键的业务参数,仅限于
service
接口中使用的参数。 - 持久层:一般是不校验的。
1.2 springmvc 校验
springmvc
使用hibernate
的校验框架validation
(和hibernate
没有关系)。思路
页面提交请求的参数,请求到Controller
方法中,使用validation
进行校验。如果校验出错,需要将错误信息展示到页面。具体需求
商品修改,添加校验(检验商品名称长度,生成日期的非空校验)如果校验出错,在商品修改页面显示错误信息。
1.3 环境
添加相关校验包:
hibernate-validator-4.3.0.Final.jar
jboss-logging-3.1.0.CR2.jar
validation-api-1.0.0.GA.jar
二、入门程序(工程springmvc-mybatis04
)
2.1 配置校验器
springmvc.xml
<!-- 校验器 ,LocalValidatorFactoryBean是spring提供的一个校验接口-->
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
<!-- hibernate校验器 -->
<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>
<value>classpath:CustomValidationMessages</value>
</list>
</property>
<!-- 资源文件编码格式 -->
<property name="fileEncodings" value="utf-8" />
<!-- 对资源文件内容缓存时间,单位秒 -->
<property name="cacheSeconds" value="120" />
</bean>
说明:配置的相关详细信息在文件中已经标明。
2.2 将校验器注入到处理器适配器中
springmvc.xml
<mvc:annotation-driven conversion-service="conversionService" validator="validator"></mvc:annotation-driven>
说明:这种配置方式比较简单,如果我们的适配器和映射器是分开配置的,那么在配置校验器的时候就比较麻烦:
<!-- 自定义webBinder -->
<bean id="customBinder"
class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
<property name="validator" ref="validator" />
</bean>
<!-- 注解适配器 -->
<bean
class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<property name="webBindingInitializer" ref="customBinder"></property>
</bean>
2.3 在pojo中添加校验规则
Items.java
private Integer id;
//校验名称:1到30字符,message就是校验出错的提示信息,
@Size(min=1, max=30, message="{items.name.length.error}")
private String name;
private Float price;
private String pic;
//非空校验
@NotNull(message="{items.createtime.isNull}")
private Date createtime;
private String detail;
说明:这里我们对名字和生产日期进行了校验配置,当然校验的出错信息我们肯定不能写死,需要放在一个配置文件中。
config/CustomValidationMessages.properties
2.4 在Controller方法中配置使用
editItemsSubmit.java
@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(Model model, HttpServletRequest request, Integer id,
@Validated ItemsCustom itemsCustom, BindingResult bindingResult) throws Exception{
//获取校验的错误信息
if(bindingResult.hasErrors()){
//输出错误信息
List<ObjectError> allErrors = bindingResult.getAllErrors();
for(ObjectError error : allErrors){
//输出错误信息
System.out.println(error.getDefaultMessage());
}
model.addAttribute("allErrors", allErrors);//将错误信息传递到页面
return "items/editItems";//出错后回到修改页面
}
itemsService.updateItems(id, itemsCustom);
return "forward:queryItems.action";
}
说明:在需要校验的pojo
前面添加@Validated
,在需要校验的pojo
后边添加BindingResult
来接收检验出错的信息。然后我们可以从BindingResult
获得相关的校验错误信息,当然最后我们还需要将错误信息返回到页面中。
注意:@Validated
和BindingResult
必须是配对出现的,并且形参顺序是固定的(一前一后)。
2.5 校验错误信息在页面中展示
editItems.jsp
<!-- 显示错误信息 -->
<c:if test="${allErrors != null}">
<c:forEach items="${allErrors}" var="error">
${error.defaultMessage }
</c:forEach>
</c:if>
说明:这里我们直接将错误信息显示在了页面顶部。
三、分组校验(工程springmvc-mybatis05
)
3.1 需求
在pojo
中定义校验规则,但是pojo
是被多个Controller
所公用,当不同的Controller
需要对同一个pojo
进行校验,但是每个Controller
方法需要不同的校验规则。
解决方法:定义多个校验分组(其实是一个接口),分组中定义了有哪些校验规则。每个Controller
方法使用不同的校验分组。
3.2 校验分组
我们定义两个校验组,注意:校验组就是两个接口,没有任何方法,只是用来标识不同的分组。
ValidationGroup1.java
package cn.itcast.ssm.controller.validation;
//一个校验分组
public interface ValidationGroup1 {
//接口中不需要定义任何方法,仅仅是对不同的校验规则进行分组
//此分组只校验商品名称的长度
}
ValidationGroup2.java
package cn.itcast.ssm.controller.validation;
//一个校验分组
public interface ValidationGroup2 {
//此分组校验商品名称长度和生产日期非空
}
3.3 在校验的pojo中添加分组
Items.java
private Integer id;
//校验名称:1到30字符,message就是校验出错的提示信息,groups标识此校验属于哪个分组,可以定义多个
@Size(min=1, max=30, message="{items.name.length.error}", groups={ValidationGroup1.class})
private String name;
private Float price;
private String pic;
//非空校验
@NotNull(message="{items.createtime.isNull}")
private Date createtime;
说明:可以看到我们将名字校验分在ValidationGroup1
这个组中,当然我们可以添加多个分组,但是找了一下,没找到如何为一个校验字段添加多个分组。这里说明一下,之后再解决。
3.4 Controller方法中使用分组
@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(Model model, HttpServletRequest request, Integer id,
@Validated(value={ValidationGroup1.class}) ItemsCustom itemsCustom, BindingResult bindingResult) throws Exception{
//获取校验的错误信息
if(bindingResult.hasErrors()){
//输出错误信息
List<ObjectError> allErrors = bindingResult.getAllErrors();
for(ObjectError error : allErrors){
//输出错误信息
System.out.println(error.getDefaultMessage());
}
model.addAttribute("allErrors", allErrors);//将错误信息传递到页面
return "items/editItems";//出错后回到修改页面
}
itemsService.updateItems(id, itemsCustom);
return "forward:queryItems.action";
}
说明:这里我们可以看到在注解@Validated
中使用value
指定校验分组。当然这里我们可以指定多个分组,如:@Validated(value={ValidGroup1.class,ValidGroup2.class })
最后:这里我们给出一些校验的注解:
注解 | 含义 |
---|---|
@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=) |
被注释的元素必须在合适的范围内 |
待解决问题:如何为一个字段添加多个分组?