使用SpringMVC的@Validated注解验证

一、SpringMVC验证@Validated的使用

第一步：编写国际化消息资源文件

编写国际化消息资源ValidatedMessage.properties文件主要是用来显示错误的消息定制

 

[java] view plain copy

1. edit.username.null=用户名不能为空  
2. edit.password.size=密码最少{min}位，最长{max}位  
3. ......  

能够将edit.username.null与edit.password.size看为参数，在message中传递，具体请看第二步。

 

第二步：Bean实体类中加注解

首先介绍关于验证注解的类型种类

 

@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个未来的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	验证注解的元素值（日期类型）比当前时间早
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不一样于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email	验证注解的元素值是Email，也能够经过正则表达式和flag指定自定义的email格式

使用 这些注解很简单，只须要在实体类中的变量属性前面加上该注解便可。

[html] view plain copy

1. public class User {    
2.     private String id;   
3.     @NotEmpty(message = "{edit.username.null}")  
4.     private String username;  
5.     @Size(min=6 ,max= 20 ,message = "{edit.password.size}")  
6.     private String password;  
7.    ......  
8. }  

其中｛｝至关于占位符，将min、max参数传图，同时也将消息文件中定制的错误信息传入，固然也能够直接不使用国际化文件，可是推荐使用，方便统一与修改。

 

[html] view plain copy

1. public class User {    
2.     private String id;   
3.     @NotEmpty(message = "用户名不能为空")  
4.     private String username;  
5.     @Size(min=6 ,max= 20 ,message = "密码最少6位，最高20位")  
6.     private String password;  
7.    ......  
8. }  

 

 

第三步：Controller层的编写

Controller层的使用，很简单。须要在相应的方法传入的Bean参数前面增长注解@Validated，还有增长BindingResult参数便可，具体请看代码示例：

[html] view plain copy

1. @Controller    
2. public class UserController {    
3.     
4.     @RequestMapping("/save")    
5.     public String save(@Validated User user, BindingResult result) {    
6.         if(result.hasErrors()) {    
7.             return "error";    
8.         }    
9.         return "success";    
10.     }    
11. }  

 

第四步：在View层显示错误信息

这里就不作介绍了，实际项目中会封装好相应的javcscript等方法，只须要调用就能够返回页面提示给用户错误信息。
 

二、@Validated的分组特性

先在记录以前，介绍一下这样的场景：在对用户的账号密码进行编辑保存以及新增是两种不同的状况。

编辑修改->保存：只须要验证username与password是否符合条件便可，不须要验证id（由于在数据库中id已经存在）。

新增->保存：新增须要验证username与password是否符合条件，还要验证id。

这时候就用到groups分组分状况对Bean属性变量进行验证，也能够知足多验证。具体的须要一下两个步骤

第一步：建立分组接口类

分组接口类只是普通的接口类并无多大意义，只是用来标识这个属性哪一种状况下被验证，这相似于java.io.Serializable  
 

[html] view plain copy

1. public interface addUser{   
2. }   
3. public interface editUser{  
4. }  

 

第二步：Controller方法参数中增长xxx.class接口

在对新增的用户进行ID验证，增长@Validated({addUser.class})接口类用来表示新增的User.getId()须要验证。

[html] view plain copy

1. @Controller    
2. public class UserController {    
3.     
4.     @RequestMapping("/saveAdd")    
5.     public String saveAddUser(@Validated({addUser.class}) User user, BindingResult result) {    
6.         if(result.hasErrors()) {    
7.             return "error";    
8.         }    
9.         return "success";    
10.     }  

 

第三步：Bean中添加groups分组

在User实体类中添加groups分组@NotEmpty(groups={addUser.class})与UserController中@Validated({addUser.class})对应，说明在执行saveAddUser新增用户的状况下，才对新增的用户id进行验证。
 

 

[html] view plain copy

1. public class User {     
2.     //在分组addUser时，验证id不能为空，其余状况下不作验证  
3.     @NotEmpty(groups={addUser.class})  
4.     private String id;  
5.     @NotEmpty(message = "用户名不能为空")  
6.     private String username;  
7.     @Size(min=6 ,max= 20 ,message = "密码最少6位，最高20位")  
8.     private String password;  
9.    ......  
10. }  

以上三步就能够简单地完成分组验证，可是对分组验证补充一下三点：

第一是：不分配groups分组时，默认每次都须要验证。

第二是：经过groups分组能够对同一个变量进行多个验证，以下代码

[html] view plain copy

1. //对用户名进行两次不一样状况的验证。  
2. @NotEmpty(groups={First.class})  
3. @Size(min=1,max=10,groups={Second.class})  
4. public String username;   

第三是：默认的状况下，不一样的分组约束验证是无序的，可是在有些状况下验证的相互约束很重要（好比前一个组验证失败，后面的将再也不验证等状况），因此groups分组的验证也有先后验证顺序。使用@GroupSequence注解进行排序。

[html] view plain copy

1. /*  
2.  * 分组顺序接口类  
3.  */  
4. import javax.validation.GroupSequence;  
5. //分组序列先Frist再Second  
6. @GroupSequence({First.class,Second.class})  
7. public interface Group{  
8. }  
9.   
10. @Controller    
11. public class UserController {    
12.     
13.     @RequestMapping("/saveAdd")    
14.     public String saveAddUser(@Validated({Group.class}) User user, BindingResult result) {    
15.         if(result.hasErrors()) {    
16.             return "error";    
17.         }    
18.         return "success";    
19.     }