springmvc學習筆記(14)-springmvc校驗

springmvc學習筆記(14)-springmvc校驗

標籤： springmvc

---

[TOC]

---

本文主要介紹springmvc校驗，包括環境準備，校驗器配置，pojo張添加校驗規則，捕獲和顯示檢驗錯誤信息以及分組校驗簡單示例。

校驗理解

項目中，一般使用較可能是前端的校驗，好比頁面中js校驗。對於安全要求較高點建議在服務端進行校驗。

服務端校驗：

• 控制層conroller：校驗頁面請求的參數的合法性。在服務端控制層conroller校驗，不區分客戶端類型（瀏覽器、手機客戶端、遠程調用）
• 業務層service（使用較多）：主要校驗關鍵業務參數，僅限於service接口中使用的參數。
• 持久層dao：通常是不校驗的。

springmvc校驗需求

springmvc使用hibernate的校驗框架validation(和hibernate沒有任何關係)。

校驗思路：

頁面提交請求的參數，請求到controller方法中，使用validation進行校驗。若是校驗出錯，將錯誤信息展現到頁面。

具體需求：

商品修改，添加校驗（校驗商品名稱長度，生產日期的非空校驗），若是校驗出錯，在商品修改頁面顯示錯誤信息。

環境準備

咱們須要三個jar包：

• hibernate-validator.jar
• jboss-logging.jar
• validation-api.jar

這裏咱們添加maven依賴

<!-- hibernate 校驗 -->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.2.4.Final</version>
</dependency>

查看maven依賴樹

[INFO] \- org.hibernate:hibernate-validator:jar:5.2.4.Final:compile
[INFO]    +- javax.validation:validation-api:jar:1.1.0.Final:compile
[INFO]    +- org.jboss.logging:jboss-logging:jar:3.2.1.Final:compile
[INFO]    \- com.fasterxml:classmate:jar:1.1.0:compile

能夠看到，另外兩個jar包被hibernate-validator依賴，因此不用再額外添加了。

配置校驗器

• 在springmvc.xml中添加

<!-- 校驗器 -->
<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>

• 校驗器注入處處理器適配器中

<mvc:annotation-driven conversion-service="conversionService"
                       validator="validator">
</mvc:annotation-driven>

• 在CustomValidationMessages.properties配置校驗錯誤信息：

#添加校驗的錯誤提示信息
items.name.length.error=請輸入1到30個字符的商品名稱
items.createtime.isNUll=請輸入商品的生產日期

在pojo中添加校驗規則

在ItemsCustom.java中添加校驗規則：

public class Items {
    private Integer id;
    //校驗名稱在1到30字符中間
    //message是提示校驗出錯顯示的信息
    //groups：此校驗屬於哪一個分組，groups能夠定義多個分組
    @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;

捕獲和顯示校驗錯誤信息

@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(
        Model model,
        HttpServletRequest request,
        Integer id,
        @Validated ItemsCustom itemsCustom,
        BindingResult bindingResult)throws Exception {

• 在controller中將錯誤信息傳到頁面便可

//獲取校驗錯誤信息
if(bindingResult.hasErrors()){
    // 輸出錯誤信息
    List<ObjectError> allErrors = bindingResult.getAllErrors();

    for (ObjectError objectError :allErrors){
        // 輸出錯誤信息
        System.out.println(objectError.getDefaultMessage());
    }
    // 將錯誤信息傳到頁面
    model.addAttribute("allErrors", allErrors);

    //能夠直接使用model將提交pojo回顯到頁面
    model.addAttribute("items", itemsCustom);

    // 出錯從新到商品修改頁面
    return "items/editItems";
}

• 頁面顯示錯誤信息：

<!-- 顯示錯誤信息 -->
<c:if test="${allErrors!=null }">
	<c:forEach items="${allErrors }" var="error">
		${ error.defaultMessage}<br/>
	</c:forEach>
</c:if>

分組校驗

• 需求：
  • 在pojo中定義校驗規則，而pojo是被多個controller所共用，當不一樣的controller方法對同一個pojo進行校驗，可是每一個controller方法須要不一樣的校驗
• 解決方法：
  • 定義多個校驗分組（實際上是一個java接口），分組中定義有哪些規則
  • 每一個controller方法使用不一樣的校驗分組

1.校驗分組

public interface ValidGroup1 {
	//接口中不須要定義任何方法，僅是對不一樣的校驗規則進行分組
	//此分組只校驗商品名稱長度

}

2.在校驗規則中添加分組

//校驗名稱在1到30字符中間
//message是提示校驗出錯顯示的信息
//groups：此校驗屬於哪一個分組，groups能夠定義多個分組
@Size(min=1,max=30,message="{items.name.length.error}",groups = {ValidGroup1.class})
private String name;

3.在controller方法使用指定分組的校驗

// value={ValidGroup1.class}指定使用ValidGroup1分組的校驗
@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(
        Model model,
        HttpServletRequest request,
        Integer id,
        @Validated(value = ValidGroup1.class)ItemsCustom itemsCustom,
        BindingResult bindingResult)throws Exception {

---

做者@brianway更多文章：我的網站 | CSDN | oschina