SpringMVC 使用验证框架 Bean Validation（上）

SpringMVC 使用验证框架 Bean Validation（上）

2016年04月29日 00:03:41 阅读数：34134 标签： spring mvc 更多

个人分类： Java开发

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/catoop/article/details/51278675

对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的，这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证。 SpringMVC 自身对数据在服务端的校验(Hibernate Validator)有一个比较好的支持，它能将我们提交到服务端的数据按照我们事先的约定进行数据有效性验证，对于不合格的数据信息 SpringMVC 会把它保存在错误对象中(Errors接口的子类)，这些错误信息我们也可以通过 SpringMVC 提供的标签(form:errors)在前端JSP页面上进行展示。或者使用拦截器 after 方法对处理错误信息进行处理后传递给页面(我们使用JSON请求的时候就需要这样做)。

本文来介绍，如何在 SpringMVC 中进行 Validator 的使用。

一、添加POM依赖

        <!-- Hibernate Validator -->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>

• 1
• 2
• 3
• 4
• 5
• 6

二、配置要验证的实体

public class ValidatorTest {

    // message 直接提供错误信息
    @NotNull(message = "username 不能为空")
    // message 使用 {} 代表错误内容，从 resources 目录下的 ValidationMessages.properties 文件中读取
    @Pattern(regexp = "[a-zA-Z0-9_]{5,10}", message = "{user.username.illegal}") 
    private String username;

    @Size(min = 5, max = 10, message = "{password.length.illegal}")
    private String password;

    // 省略 get\set   

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14

ValidationMessages.properties 文件内容：

user.username.illegal=用户名格式不正确
password.length.illegal=密码[${validatedValue}]长度必须为{min}到{max}个字符

其中${validatedValue} 用来获取预校验属性的值。
{min} 和 {max} 用来读取 @Size 注解中对应的属性值。
你还可以像 ${max > 1 ? '大于1' : '小于等于1'} 这样使用el表达式。
另外我们还可以拿到一个java.util.Formatter类型的formatter变量进行格式化：
${formatter.format("%04d", min)}  

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

如果EL表达式不起作用，可以添加如下依赖尝试，如果没有问题请忽略。

        <dependency>
            <groupId>javax.el</groupId>
            <artifactId>javax.el-api</artifactId>
            <version>2.2.4</version>
            <scope>provided</scope>
        </dependency>

• 1
• 2
• 3
• 4
• 5
• 6

内置的验证约束注解 
内置的验证约束注解如下表所示（摘自hibernate validator reference）：

对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的，这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证。 SpringMVC 自身对数据在服务端的校验(Hibernate Validator)有一个比较好的支持，它能将我们提交到服务端的数据按照我们事先的约定进行数据有效性验证，对于不合格的数据信息 SpringMVC 会把它保存在错误对象中(Errors接口的子类)，这些错误信息我们也可以通过 SpringMVC 提供的标签(form:errors)在前端JSP页面上进行展示。或者使用拦截器 after 方法对处理错误信息进行处理后传递给页面(我们使用JSON请求的时候就需要这样做)。 本文来介绍，如何在 SpringMVC 中进行 Validator 的使用。 一、添加POM依赖 <!-- Hibernate Validator --> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> </dependency> 1 2 3 4 5 6 二、配置要验证的实体 public class ValidatorTest { // message 直接提供错误信息 @NotNull(message = "username 不能为空") // message 使用 {} 代表错误内容，从 resources 目录下的 ValidationMessages.properties 文件中读取 @Pattern(regexp = "[a-zA-Z0-9_]{5,10}", message = "{user.username.illegal}") private String username; @Size(min = 5, max = 10, message = "{password.length.illegal}") private String password; // 省略 get\set } 1 2 3 4 5 6 7 8 9 10 11 12 13 14 ValidationMessages.properties 文件内容： user.username.illegal=用户名格式不正确 password.length.illegal=密码[${validatedValue}]长度必须为{min}到{max}个字符 其中${validatedValue} 用来获取预校验属性的值。 {min} 和 {max} 用来读取 @Size 注解中对应的属性值。 你还可以像 ${max > 1 ? '大于1' : '小于等于1'} 这样使用el表达式。 另外我们还可以拿到一个java.util.Formatter类型的formatter变量进行格式化： ${formatter.format("%04d", min)} 1 2 3 4 5 6 7 8 如果EL表达式不起作用，可以添加如下依赖尝试，如果没有问题请忽略。 <dependency> <groupId>javax.el</groupId> <artifactId>javax.el-api</artifactId> <version>2.2.4</version> <scope>provided</scope> </dependency> 1 2 3 4 5 6 内置的验证约束注解  内置的验证约束注解如下表所示（摘自hibernate validator reference）： 验证注解 验证的数据类型 说明 @AssertFalse Boolean,boolean 验证注解的元素值是false @AssertTrue Boolean,boolean 验证注解的元素值是true @NotNull 任意类型 验证注解的元素值不是null @Null 任意类型 验证注解的元素值是null @MIN(value=值) BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型 验证注解的元素值大于等于@Min指定的value值 @MAX(value=值) 和@Min要求一样 验证注解的元素值小于等于@Max指定的value值 @DecimalMin(value=值) 和@Min要求一样 验证注解的元素值大于等于@ DecimalMin指定的value值 @DecimalMax(value=值) 和@Min要求一样 验证注解的元素值小于等于@ DecimalMax指定的value值 @Digits(integer=整数位数, fraction=小数位数) 和@Min要求一样 验证注解的元素值的整数位数和小数位数上限 @Size(min=下限, max=上限) 字符串、Collection、Map、数组等 验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小 @Past java.util.Date,java.util.Calendar;Joda Time类库的日期类型 验证注解的元素值（日期类型）比当前时间早 @Future 与@Past要求一样 验证注解的元素值（日期类型）比当前时间晚 @NotBlank CharSequence子类型 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格 @Length(min=下限, max=上限) CharSequence子类型 验证注解的元素值长度在min和max区间内 @NotEmpty CharSequence子类型、Collection、Map、数组 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0） @Range(min=最小值, max=最大值) BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型 验证注解的元素值在最小值和最大值之间 @Email(regexp=正则表达式,flag=标志的模式) CharSequence子类型（如String） 验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式 @Pattern(regexp=正则表达式,flag=标志的模式) String，任何CharSequence的子类型 验证注解的元素值与指定的正则表达式匹配 @Valid 任何非原子类型 指定递归验证关联的对象；如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证 三、Controller 实体验证与视图错误信息的展示 JSP 页面： 错误信息使用 form:errors 展示，这个标签，必须放在 form:form 中使用。 <%@ page language="java" pageEncoding="UTF-8"%> <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>Java验证框架测试</title> </head> <body> <form:form method="post" modelAttribute="testModel" action="${pageContext.request.contextPath }/validator/test3"> <h1><form:errors path="username" /></h1><!-- path的值可以为 * ，表示显示所有错误 --> <h1><form:errors path="password" /></h1> <form:input path="username" /><br/> <form:input path="password" /><br/> <input type="submit" value="提交"/> </form:form> </body> </html> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 对应的 Controller 的方法： @Controller @RequestMapping("/validator") public class ValidatorController { /** * 响应到JSP页面 * * @param test * @param result * 这里的BindingResult必须紧挨着@Valid参数的，即必须紧挨着需要校验的参数， * 这就意味着我们有多少个@Valid参数就需要有多少个对应的Errors参数，它们是一一对应的。 * @return * @author SHANHY * @create 2016年4月14日 */ @RequestMapping("/test3") public String test3(@Valid @ModelAttribute("testModel") ValidatorTest test, BindingResult result, Model model){ model.addAttribute("test", test); if(result.hasErrors()) return "validator1"; return "validator2"; } } 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 后面文章将接着介绍：  四、Controller 普通参数验证与视图错误信息的展示  五、JSON 请求响应错误信息  六、错误信息的配置文件  七、错误信息中使用EL表达式  八、一个手工验证的工具类

三、Controller 实体验证与视图错误信息的展示

JSP 页面：

错误信息使用 form:errors 展示，这个标签，必须放在 form:form 中使用。

<%@ page language="java" pageEncoding="UTF-8"%>
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>Java验证框架测试</title>
  </head>

  <body>
    <form:form method="post" modelAttribute="testModel" action="${pageContext.request.contextPath }/validator/test3">
        <h1><form:errors path="username" /></h1><!-- path的值可以为 * ，表示显示所有错误 -->
        <h1><form:errors path="password" /></h1>
        <form:input path="username" /><br/>
        <form:input path="password" /><br/>
        <input type="submit" value="提交"/>
    </form:form>
  </body>
</html>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18

对应的 Controller 的方法：

@Controller
@RequestMapping("/validator")
public class ValidatorController {

    /**
     * 响应到JSP页面
     * 
     * @param test
     * @param result 
     *      这里的BindingResult必须紧挨着@Valid参数的，即必须紧挨着需要校验的参数，
     *      这就意味着我们有多少个@Valid参数就需要有多少个对应的Errors参数，它们是一一对应的。
     * @return
     * @author SHANHY
     * @create  2016年4月14日
     */
    @RequestMapping("/test3")
    public String test3(@Valid @ModelAttribute("testModel") ValidatorTest test, 
            BindingResult result, Model model){
        model.addAttribute("test", test);
        if(result.hasErrors())
            return "validator1";
        return "validator2";
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24

---

后面文章将接着介绍： 
四、Controller 普通参数验证与视图错误信息的展示 
五、JSON 请求响应错误信息 
六、错误信息的配置文件 
七、错误信息中使用EL表达式 
八、一个手工验证的工具类