Spring MVC中使用 hibernate-validtor进行服务端验证

谁践踏了优雅 2022-06-07 03:42 90阅读 0赞

## 搭好Spring MVC的基本框架,并且可以成功运行起来 ##

> …此步骤省略

## 引入依赖包 ##

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

## 在Spring MVC驱动配置中加上hibernate-validator ##

<mvc:annotation-driven validator="validator"></mvc:annotation-driven>
    
     
    <bean id="validator"
       class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
        
        
    </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][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>

![运行效果展示][SouthEast]

## 摘录 ##

Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。  
在日常开发中，Hibernate Validator经常用来验证bean的字段，基于注解，方便快捷高效。  
1. Bean Validation 中内置的 constraint

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th align="center">作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Valid</td> 
   <td align="center">被注释的元素是一个对象，需要检查此对象的所有字段值</td> 
  </tr> 
  <tr> 
   <td>@Null</td> 
   <td align="center">被注释的元素必须为 null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td align="center">被注释的元素必须不为 null</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td align="center">被注释的元素必须为 true</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td align="center">被注释的元素必须为 false</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td align="center">被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td align="center">被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value)</td> 
   <td align="center">被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value)</td> 
   <td align="center">被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@Size(max, min)</td> 
   <td align="center">被注释的元素的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td>@Digits (integer, fraction)</td> 
   <td align="center">被注释的元素必须是一个数字，其值必须在可接受的范围内</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td align="center">被注释的元素必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td align="center">被注释的元素必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td>@Pattern(value)</td> 
   <td align="center">被注释的元素必须符合指定的正则表达式</td> 
  </tr> 
 </tbody> 
</table>

1.  Hibernate Validator 附加的 constraint

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th align="center">作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Email</td> 
   <td align="center">被注释的元素必须是电子邮箱地址</td> 
  </tr> 
  <tr> 
   <td>@Length(min=, max=)</td> 
   <td align="center">被注释的字符串的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td align="center">被注释的字符串的必须非空</td> 
  </tr> 
  <tr> 
   <td>@Range(min=, max=)</td> 
   <td align="center">被注释的元素必须在合适的范围内</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td align="center">被注释的字符串的必须非空</td> 
  </tr> 
  <tr> 
   <td>@URL(protocol=,host=, port=, regexp=, flags=)</td> 
   <td align="center">被注释的字符串必须是一个有效的url</td> 
  </tr> 
  <tr> 
   <td>@CreditCardNumber</td> 
   <td align="center">被注释的字符串必须通过Luhn校验算法，银行卡，信用卡等号码一般都用Luhn计算合法性</td> 
  </tr> 
  <tr> 
   <td>@ScriptAssert(lang=, script=, alias=)</td> 
   <td align="center">要有Java Scripting API 即JSR 223</td> 
  </tr> 
  <tr> 
   <td>@SafeHtml(whitelistType=, additionalTags=)</td> 
   <td align="center">classpath中要有jsoup包</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td align="center">任何对象的value不能为null</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td align="center">集合对象的元素不为0，即集合不为空，也可以用于字符串不为null</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td align="center">只能用于字符串不为null，并且字符串trim()以后length要大于0</td> 
  </tr> 
 </tbody> 
</table>

[http_www.springframework.org_tags_form]: http://www.springframework.org/tags/form
[SouthEast]: /images/20220607/0bee9fc64dfb46a7b9f406e37fb65f24.png