SpringMVC和FreeMarker整合中使用註解方式的後臺數據校驗

前提概要

本文主題：

在Spring MVC和FreeMarker整合的項目中，採用JSR-303驗證框架，通過註解的方式進行數據驗證

 

基礎框架：

MVC：Spring MVC 3

視圖：FreeMarker

驗證：Hibernate-validator實現

 

需要JAR包：

0、Spring MVC和FreeMarker所需jar包

1、org.hibernate.validator-4.1.0.GA.jar

2、javax.validation-1.0.0.GA.jar

 

 

配置文件和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>

 

 

在FreeMarker視圖上面顯示校驗錯誤

如果視圖使用的是FreeMarker，Spring同樣提供了一套“自定義標籤庫”，在FreeMarker中叫做自定義宏，使我們可以方便的顯示出校驗錯誤信息。

 

所有首先，需要導入Spring專門爲FreeMarker提供的宏指令文件

<#import "spring.ftl" as spring />

 

然後就可以在每個輸入框後面顯示單個校驗錯誤了

（bind後面的值與JSP中顯示校驗錯誤時的path是一致的）

<input type="text" name="userName" value="${(userDetail.userName)!}" />
<#if userDetail??>
	<@spring.bind "userDetail.userName" />
	<@spring.showErrors "<br>"/>
</#if>

<input type="text" name="email" value="${(userDetail.email)!}" />
<#if userDetail??>
	<@spring.bind "userDetail.email" />
	<@spring.showErrors "<br>"/>
</#if>

 

如何在FreeMarker模版文件中顯示單個的校驗錯誤信息？

<@spring.bind "userDetail.email" /> ：是綁定到具體哪一個字段的校驗結果，

<@spring.showErrors "<br>"/>         ：則顯示校驗錯誤信息

 

在整合SpringMVC和FreeMarker搭建基礎框架的過程中，基本順風順水，如今各種腳手架到處都是，拿幾個過來參照即可。唯一花了點精力研究的就是——如何在FreeMarker模版文件中顯示單個的校驗錯誤信息。針對這個問題，在網上找了不少時間，都沒有找到合適的方法，最後還是在國外的技術論壇上看到這個方法。這纔是寫下這篇博客的動力所在，希望對您有所幫助。

 

 

寫在後面的話

如今Web系統都有前臺JS校驗，比如使用jQuery的validate框架就非常方便，所以上述在頁面上顯示校驗錯誤信息的工作其實不是必須的。有了前臺JS校驗就能保證正常用戶體驗沒有問題了，但是不能防止非正常用戶繞過JS校驗的惡意請求，所以後臺校驗還是要做的。我們只需要在Controller方法裏面判斷有校驗錯誤的時候直接返回到一個錯誤頁面就行了，那樣就能保證所有請求數據都會經過校驗，不管是經過了前臺JS校驗合格的數據，還是有人通過工具繞過JS校驗的惡意數據，都難逃法眼。