Spring MVC中使用 hibernate-validtor進行服務端驗證

爆裂碼手發表於2017-10-09
SpringMVC服務端

搭好Spring MVC的基本框架,並且可以成功執行起來

…此步驟省略

引入依賴包

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.4.1.Final</version>
</dependency>

在Spring MVC驅動配置中加上hibernate-validator

<!-- Enables the Spring MVC @Controller programming model -->
<mvc:annotation-driven validator="validator"></mvc:annotation-driven>

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

import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotEmpty;
public class UserVO {
    @NotEmpty(message = "使用者名稱不能為空")
    private String userName;
    @Length(min=3, max=15,message = "密碼長度不對")
    private String userPassword;

   //setters and getters …
}

在Controller中進行校驗,並且返回繫結引數異常情況

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import top.yuyufeng.sample.web.vo.UserValidVO;

import javax.validation.Valid;

@Controller
public class LoginValidController {

    private static UserValidVO userValidVO = new UserValidVO();

    /**
     * 跳轉到登入介面
     *
     * @return
     */
    @RequestMapping(value = "/login-valid", method = RequestMethod.GET)
    public String toLogin(Model model) {
        model.addAttribute("userValidVO", userValidVO); //必須新增 不然Spring form標籤會報錯
        return "login-valid";
    }

    @RequestMapping(value = "/doValidLogin", method = RequestMethod.POST)
    public String userLogin(@Valid UserValidVO userValidVO, BindingResult br, Model model) {
        if (!br.hasErrors()) {
            model.addAttribute("loginValid", "success");
        }
        return "login-valid";
    }

}

前端頁面表單,和異常展示(使用http://www.springframework.org/tags/form標籤)

<%--
  Created by IntelliJ IDEA.
  User: yuyufeng
  Date: 2017/9/28
  Time: 9:18
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>
<html>
<head>
    <title>login</title>
    <%@ include file="include/head.jsp" %>
    <style>
        .error-area {
            color: red;
        }
    </style>
</head>
<body>
<hr/>
<%--Spring form 表單--%>
<form:form id="my-form" method="post" modelAttribute="userValidVO" action="/doValidLogin">
    使用者登入
    <table>
        <tr>
            <td><form:label path="userName">使用者名稱:</form:label></td>
            <td><form:input path="userName"/></td>
            <td><form:errors path="userName" cssClass="error-area"/></td>
        </tr>
        <tr>
            <td><form:label path="userPassword">密碼:</form:label></td>
            <td><form:input path="userPassword"/></td>
            <td><form:errors path="userPassword" cssClass="error-area"/></td>
        </tr>
        <tr>
            <td>
                <button type="submit">立即登入</button>
            </td>
            <td>
                <button type="reset">重置</button>
            </td>
        </tr>
        <tr>
            <td><c:out value="${loginValid}"></c:out></td>
        </tr>
    </table>
</form:form>

</body>
</html>

執行效果展示

摘錄

Hibernate Validator 是 Bean Validation 的參考實現 。Hibernate Validator 提供了 JSR 303 規範中所有內建 constraint 的實現，除此之外還有一些附加的 constraint。
在日常開發中，Hibernate Validator經常用來驗證bean的欄位，基於註解，方便快捷高效。
1. Bean Validation 中內建的 constraint

註解 作用
@Valid 被註釋的元素是一個物件，需要檢查此物件的所有欄位值
@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(value) 被註釋的元素必須符合指定的正規表示式
  1. Hibernate Validator 附加的 constraint
註解 作用
@Email 被註釋的元素必須是電子郵箱地址
@Length(min=, max=) 被註釋的字串的大小必須在指定的範圍內
@NotEmpty 被註釋的字串的必須非空
@Range(min=, max=) 被註釋的元素必須在合適的範圍內
@NotBlank 被註釋的字串的必須非空
@URL(protocol=,host=, port=, regexp=, flags=) 被註釋的字串必須是一個有效的url
@CreditCardNumber 被註釋的字串必須通過Luhn校驗演算法，銀行卡，信用卡等號碼一般都用Luhn計算合法性
@ScriptAssert(lang=, script=, alias=) 要有Java Scripting API 即JSR 223
@SafeHtml(whitelistType=, additionalTags=) classpath中要有jsoup包
@NotNull 任何物件的value不能為null
@NotEmpty 集合物件的元素不為0，即集合不為空，也可以用於字串不為null
@NotBlank 只能用於字串不為null，並且字串trim()以後length要大於0

相關文章