使用BindingResult 自定義錯誤資訊

2021-10-23 22:00:43

BindingResult 自定義錯誤資訊

前提概要

在Spring MVC和FreeMarker整合的專案中，採用JSR-303驗證框架，通過註解的方式進行資料驗證

基礎框架

MVC：Spring MVC 3
檢視：FreeMarker
驗證：Hibernate-validator實現

組態檔和Java程式碼的修改

在Spring MVC組態檔中新增設定

新增以下mvc的註解驅動設定，一切變成「自動化」

<mvc:annotation-driven />

在JavaBean中新增資料校驗的註解

其中@Length、@email就是Hibernate-validator中的資料校驗註解，還可以用javax.validation中的註解，比如@NotNull

public class SystemUser {  
    @Length(min = 5, max = 20, message = "使用者名稱長度必須位於5到20之間")  
    private String userName;   
    @Email(message = "比如輸入正確的郵箱")  
    private String email;  
}

在Controller方法中指定需要進行校驗

首先，要在需要進行校驗的Bean前面加上@Valid註解，告訴SpringMVC框架這個Bean需要進行校驗；

同時，還要在需要校驗的Bean前面加上@modelattribute註解，從而將Bean暴露給檢視，並且指定名字，這有兩個作用，第一是顯示校驗錯誤需要使用這個名字，第二個是返回原來的頁面以後，前面輸入的所有值還要顯示出來；

其次，每個需要校驗的Bean後面緊跟一個BindingResult，SpringMVC框架會將校驗結果儲存在它裡面，通過hasErrors方法可以判斷是否有校驗錯誤；

最後，當返回到原頁面以後，SpringMVC框架還會將所有校驗錯誤資訊儲存在上下文中，供頁面上取得校驗錯誤，Spring提供了一套JSP自定義標籤。

@RequestMapping(value = "/create.html", method = RequestMethod.POST)  
public String doCreateUser(  
        @Valid @ModelAttribute("userDetail") SystemUser user,  
        BindingResult bindingResult,  
        HttpServletRequest request) {  
    // 如果有校驗錯誤，返回新增使用者的頁面  
    if (bindingResult.hasErrors()) {  
        return "/user/create";  
    }        
    this.userService.createUser(user);  
    return "/user/list.html";  
}

進行自定義校驗

如果需要新增自定義校驗，比如驗證使用者名稱是否已經被使用了，那麼簡單的註解自然無能為力，需要自己編碼實現，如果校驗失敗，可以手動將自定義校驗錯誤新增到BindingResult中。

@RequestMapping(value = "/user/create.html", method = RequestMethod.POST)  
public String doCreateUser(  
        @Valid @ModelAttribute("userDetail") SystemUser user,  
        BindingResult bindingResult,  
        HttpServletRequest request) {  
    // 如果有資料校驗錯誤，返回新增使用者的頁面  
    if (bindingResult.hasErrors()) {  
        return "/user/create";  
    }    
    boolean isUserNameExist = this.userService.checkUserByUserName(user.getUserName());  
    // 如果使用者名稱已存在，返回新增使用者的頁面  
    if (isUserNameExist) {  
        // 向BindingResult新增使用者已存在的校驗錯誤  
        bindingResult.rejectValue("userName", "該使用者名稱已存在", "該使用者名稱已存在");  
        return "/user/create";  
    }        
    this.userService.createUser(user);  
    return "/user/list.html";  
}

在JSP頁面上顯示校驗錯誤資訊

返回頁面以後，SpringMVC框架將所有校驗錯誤資訊都放在了上下文中，可以自己去取出來，但是那樣非常麻煩，不過沒關係，Spring提供了一套自定義標籤，可以方便的顯示校驗錯誤資訊。

頁面頭部需要匯入Spring的自定義標籤庫

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>

需要一次性顯示全部校驗錯誤

（commandName的值就是@modelattribute註解中指定的值）

<form:form commandName="userDetail"> 
<form:errors path="*" cssStyle="color:red"></form:errors> 
</form:form>

需要在對應輸入框的後面顯示單個校驗錯誤

（通過path指定顯示那個具體的校驗錯誤，userDetail正是@modelattribute註解中指定的值，而點號後面則是指定顯示Bean中哪個屬性的校驗錯誤）

<input type="text" name="userName" value="${userDetail.userName}" > 
<form:errors path="userDetail.userName" cssStyle="color:red"></form:errors> 
<input type="text" name="email" value="${userDetail.email}"> 
<form:errors path="userDetail.email" cssStyle="color:red"></form:errors>

BindingResult錯誤返回顯示失敗

作為一個初學者經常犯低階錯誤，特別是沒有老師的情況下。絆了一整天，不過找到原因了

如果redirect跳轉回造成引數丟失

此時可以設定返回引數為Object

@RequestMapping(value = "/save", method = RequestMethod.POST)
public Object test(HttpServletRequest request, Model model, @Validated User user, BindingResult bindingResult)
throws Exception {
if (bindingResult.hasErrors()) {
return "user/save";
}
user.setVersion(0);
return new ModelAndView("redirect:/user/list");
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。