一、準(zhǔn)備
1.1 校驗(yàn)理解
項(xiàng)目中,通常使用較多的是前端的校驗(yàn),比如頁面中js
校驗(yàn)。對(duì)于安全要求較高建議在服務(wù)端進(jìn)行校驗(yàn)。服務(wù)端校驗(yàn)有:
- 控制層:校驗(yàn)頁面請(qǐng)求的參數(shù)的合法性。在服務(wù)端校驗(yàn)不區(qū)分客戶端(pc、手機(jī)、遠(yuǎn)程調(diào)用),其校驗(yàn)是一致的。
- 業(yè)務(wù)層(使用較多):主要校驗(yàn)關(guān)鍵的業(yè)務(wù)參數(shù),僅限于
service
接口中使用的參數(shù)。 - 持久層:一般是不校驗(yàn)的。
1.2 springmvc 校驗(yàn)
springmvc
使用hibernate
的校驗(yàn)框架validation
(和hibernate
沒有關(guān)系)。思路
頁面提交請(qǐng)求的參數(shù),請(qǐng)求到Controller
方法中,使用validation
進(jìn)行校驗(yàn)。如果校驗(yàn)出錯(cuò),需要將錯(cuò)誤信息展示到頁面。具體需求
商品修改,添加校驗(yàn)(檢驗(yàn)商品名稱長(zhǎng)度,生成日期的非空校驗(yàn))如果校驗(yàn)出錯(cuò),在商品修改頁面顯示錯(cuò)誤信息。
1.3 環(huán)境
添加相關(guān)校驗(yàn)包:
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 配置校驗(yàn)器
springmvc.xml
<!-- 校驗(yàn)器 ,LocalValidatorFactoryBean是spring提供的一個(gè)校驗(yàn)接口-->
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
<!-- hibernate校驗(yàn)器 -->
<property name="providerClass" value="org.hibernate.validator.HibernateValidator" />
<!-- 指定校驗(yàn)使用的資源文件,在文件中配置校驗(yàn)錯(cuò)誤信息,如果不指定則默認(rèn)使用classpath下的ValidationMessages.properties -->
<property name="validationMessageSource" ref="messageSource" />
</bean>
<!-- 校驗(yàn)錯(cuò)誤信息配置文件 -->
<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" />
<!-- 對(duì)資源文件內(nèi)容緩存時(shí)間,單位秒 -->
<property name="cacheSeconds" value="120" />
</bean>
說明:配置的相關(guān)詳細(xì)信息在文件中已經(jīng)標(biāo)明。
2.2 將校驗(yàn)器注入到處理器適配器中
springmvc.xml
<mvc:annotation-driven conversion-service="conversionService" validator="validator"></mvc:annotation-driven>
說明:這種配置方式比較簡(jiǎn)單,如果我們的適配器和映射器是分開配置的,那么在配置校驗(yàn)器的時(shí)候就比較麻煩:
<!-- 自定義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中添加校驗(yàn)規(guī)則
Items.java
private Integer id;
//校驗(yàn)名稱:1到30字符,message就是校驗(yàn)出錯(cuò)的提示信息,
@Size(min=1, max=30, message="{items.name.length.error}")
private String name;
private Float price;
private String pic;
//非空校驗(yàn)
@NotNull(message="{items.createtime.isNull}")
private Date createtime;
private String detail;
說明:這里我們對(duì)名字和生產(chǎn)日期進(jìn)行了校驗(yàn)配置,當(dāng)然校驗(yàn)的出錯(cuò)信息我們肯定不能寫死,需要放在一個(gè)配置文件中。
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{
//獲取校驗(yàn)的錯(cuò)誤信息
if(bindingResult.hasErrors()){
//輸出錯(cuò)誤信息
List<ObjectError> allErrors = bindingResult.getAllErrors();
for(ObjectError error : allErrors){
//輸出錯(cuò)誤信息
System.out.println(error.getDefaultMessage());
}
model.addAttribute("allErrors", allErrors);//將錯(cuò)誤信息傳遞到頁面
return "items/editItems";//出錯(cuò)后回到修改頁面
}
itemsService.updateItems(id, itemsCustom);
return "forward:queryItems.action";
}
說明:在需要校驗(yàn)的pojo
前面添加@Validated
,在需要校驗(yàn)的pojo
后邊添加BindingResult
來接收檢驗(yàn)出錯(cuò)的信息。然后我們可以從BindingResult
獲得相關(guān)的校驗(yàn)錯(cuò)誤信息,當(dāng)然最后我們還需要將錯(cuò)誤信息返回到頁面中。
注意:@Validated
和BindingResult
必須是配對(duì)出現(xiàn)的,并且形參順序是固定的(一前一后)。
2.5 校驗(yàn)錯(cuò)誤信息在頁面中展示
editItems.jsp
<!-- 顯示錯(cuò)誤信息 -->
<c:if test="${allErrors != null}">
<c:forEach items="${allErrors}" var="error">
${error.defaultMessage }
</c:forEach>
</c:if>
說明:這里我們直接將錯(cuò)誤信息顯示在了頁面頂部。
三、分組校驗(yàn)(工程springmvc-mybatis05
)
3.1 需求
在pojo
中定義校驗(yàn)規(guī)則,但是pojo
是被多個(gè)Controller
所公用,當(dāng)不同的Controller
需要對(duì)同一個(gè)pojo
進(jìn)行校驗(yàn),但是每個(gè)Controller
方法需要不同的校驗(yàn)規(guī)則。
解決方法:定義多個(gè)校驗(yàn)分組(其實(shí)是一個(gè)接口),分組中定義了有哪些校驗(yàn)規(guī)則。每個(gè)Controller
方法使用不同的校驗(yàn)分組。
3.2 校驗(yàn)分組
我們定義兩個(gè)校驗(yàn)組,注意:校驗(yàn)組就是兩個(gè)接口,沒有任何方法,只是用來標(biāo)識(shí)不同的分組。
ValidationGroup1.java
package cn.itcast.ssm.controller.validation;
//一個(gè)校驗(yàn)分組
public interface ValidationGroup1 {
//接口中不需要定義任何方法,僅僅是對(duì)不同的校驗(yàn)規(guī)則進(jìn)行分組
//此分組只校驗(yàn)商品名稱的長(zhǎng)度
}
ValidationGroup2.java
package cn.itcast.ssm.controller.validation;
//一個(gè)校驗(yàn)分組
public interface ValidationGroup2 {
//此分組校驗(yàn)商品名稱長(zhǎng)度和生產(chǎn)日期非空
}
3.3 在校驗(yàn)的pojo中添加分組
Items.java
private Integer id;
//校驗(yàn)名稱:1到30字符,message就是校驗(yàn)出錯(cuò)的提示信息,groups標(biāo)識(shí)此校驗(yàn)屬于哪個(gè)分組,可以定義多個(gè)
@Size(min=1, max=30, message="{items.name.length.error}", groups={ValidationGroup1.class})
private String name;
private Float price;
private String pic;
//非空校驗(yàn)
@NotNull(message="{items.createtime.isNull}")
private Date createtime;
說明:可以看到我們將名字校驗(yàn)分在ValidationGroup1
這個(gè)組中,當(dāng)然我們可以添加多個(gè)分組,但是找了一下,沒找到如何為一個(gè)校驗(yàn)字段添加多個(gè)分組。這里說明一下,之后再解決。
3.4 Controller方法中使用分組
@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(Model model, HttpServletRequest request, Integer id,
@Validated(value={ValidationGroup1.class}) ItemsCustom itemsCustom, BindingResult bindingResult) throws Exception{
//獲取校驗(yàn)的錯(cuò)誤信息
if(bindingResult.hasErrors()){
//輸出錯(cuò)誤信息
List<ObjectError> allErrors = bindingResult.getAllErrors();
for(ObjectError error : allErrors){
//輸出錯(cuò)誤信息
System.out.println(error.getDefaultMessage());
}
model.addAttribute("allErrors", allErrors);//將錯(cuò)誤信息傳遞到頁面
return "items/editItems";//出錯(cuò)后回到修改頁面
}
itemsService.updateItems(id, itemsCustom);
return "forward:queryItems.action";
}
說明:這里我們可以看到在注解@Validated
中使用value
指定校驗(yàn)分組。當(dāng)然這里我們可以指定多個(gè)分組,如:@Validated(value={ValidGroup1.class,ValidGroup2.class })
最后:這里我們給出一些校驗(yàn)的注解:
注解 | 含義 |
---|---|
@Null |
被注釋的元素必須為 null
|
@NotNull |
被注釋的元素必須不為 null
|
@AssertTrue |
被注釋的元素必須為 true
|
@AssertFalse |
被注釋的元素必須為false
|
@Min(value) |
被注釋的元素必須是一個(gè)數(shù)字,其值必須大于等于指定的最小值 |
@Max(value) |
被注釋的元素必須是一個(gè)數(shù)字,其值必須小于等于指定的最大值 |
@DecimalMin(value) |
被注釋的元素必須是一個(gè)數(shù)字,其值必須大于等于指定的最小值 |
@DecimalMax(value) |
被注釋的元素必須是一個(gè)數(shù)字,其值必須小于等于指定的最大值 |
@Size(max=, min=) |
被注釋的元素的大小必須在指定的范圍內(nèi) |
@Digits (integer,fraction) |
被注釋的元素必須是一個(gè)數(shù)字,其值必須在可接受的范圍內(nèi) |
@Past |
被注釋的元素必須是一個(gè)過去的日期 |
@Future |
被注釋的元素必須是一個(gè)將來的日期 |
@Pattern(regex=,flag=) |
被注釋的元素必須符合指定的正則表達(dá)式 Hibernate Validator 附加的constraint
|
@NotBlank(message =) |
驗(yàn)證字符串非null ,且長(zhǎng)度必須大于0 |
@Email |
被注釋的元素必須是電子郵箱地址 |
@Length(min=,max=) |
被注釋的字符串的大小必須在指定的范圍內(nèi) |
@NotEmpty |
被注釋的字符串的必須非空 |
@Range(min=,max=,message=) |
被注釋的元素必須在合適的范圍內(nèi) |
待解決問題:如何為一個(gè)字段添加多個(gè)分組?