day09-2-验证以及国际化

验证以及国际化

1.概述

（1）概述

• 对于输入的数据（比如表单数据），进行必要的验证，并给出相应的提示信息
  
• 对于验证表单数据，SpringMVC 提供了很多使用的注解，这些注解由 JSR 303验证框架提供。
  

（2）JSR 303 验证框架

• JSR 303 是 Java 为 Bean 数据合法性校验提供的标准框架，它已经包含在 JavaEE 中
  
• JSR 303 通过在 Bean 属性上标注类似于 @NotNull、@Max 等标注的注解指定校验规则，并通过标准的验证接口对 Bean 进行验证
  
• JSR 303 提供的基本验证注解有：
  

注解功能说明@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)被注释的元素必须符合指定的正则表达式（3）Hibernate Validator 扩展注解

• Hibernate Validator 和 Hibernate 没有关系，只是 JSR 303 实现的一个扩展
  
• Hibernate Validator 是 JSR 303的一个参考实现，除支持所有标准的校验注解外，它还支持以下的扩展注解：
  

注解功能说明@Email被注释的元素必须是电子邮件地址@Length被注释的字符串的大小必须在指定的范围内@NotEmpty被注释的字符串必须非空@Range被注释的元素必须在合适的范围内2.应用实例

需求说明

指定表单的数据格式，后端在接收到数据后，能够对数据进行校验，并给不符合格式的数据返回提示信息，显示在前端页面
2.1代码实现

（1）引入验证和国际化相关的jar包
（2）Monster.java，属性添加注解以验证格式

1. package com.li.web.datavalid.entity;
3. import org.hibernate.validator.constraints.Email;
4. import org.hibernate.validator.constraints.NotEmpty;
5. import org.hibernate.validator.constraints.Range;
6. import org.springframework.format.annotation.DateTimeFormat;
7. import org.springframework.format.annotation.NumberFormat;
9. import java.util.Date;
11. /**
12. * @author 李
13. * @version 1.0
14. */
15. public class Monster {
16.     @NotEmpty
17.     private Integer id;
19.     @Email
20.     private String email;
22.     //表示接收到的age的值必须在1-100之间
23.     @Range(min = 1, max = 100)
24.     private Integer age;
26.     //Asserts that the annotated string, collection,
27.     // map or array is not {@code null} or empty.
28.     @NotEmpty
29.     private String name;
31.     @DateTimeFormat(pattern = "yyyy-MM-dd")
32.     private Date birthday;
34.     @NumberFormat(pattern = "###,###.##")
35.     private Float salary;
37.     public Monster() {
38.     }
40.     public Monster(Integer id, String email, Integer age, String name, Date birthday, Float salary) {
41. <bean
42.       id="messageSource">
43.    
44.     <property name="basename" value="i18n"/>
45. </bean>this.id = id;
46. <bean
47.       id="messageSource">
48.    
49.     <property name="basename" value="i18n"/>
50. </bean>this.email = email;
51. <bean
52.       id="messageSource">
53.    
54.     <property name="basename" value="i18n"/>
55. </bean>this.age = age;
56. <bean
57.       id="messageSource">
58.    
59.     <property name="basename" value="i18n"/>
60. </bean>this.name = name;
61. <bean
62.       id="messageSource">
63.    
64.     <property name="basename" value="i18n"/>
65. </bean>this.birthday = birthday;
66. <bean
67.       id="messageSource">
68.    
69.     <property name="basename" value="i18n"/>
70. </bean>this.salary = salary;
71.     }
73.     public Integer getId() {
74. <bean
75.       id="messageSource">
76.    
77.     <property name="basename" value="i18n"/>
78. </bean>return id;
79.     }
81.     public Date getBirthday() {
82. <bean
83.       id="messageSource">
84.    
85.     <property name="basename" value="i18n"/>
86. </bean>return birthday;
87.     }
89.     public void setBirthday(Date birthday) {
90. <bean
91.       id="messageSource">
92.    
93.     <property name="basename" value="i18n"/>
94. </bean>this.birthday = birthday;
95.     }
97.     public Float getSalary() {
98. <bean
99.       id="messageSource">
100.    
101.     <property name="basename" value="i18n"/>
102. </bean>return salary;
103.     }
105.     public void setSalary(Float salary) {
106. <bean
107.       id="messageSource">
108.    
109.     <property name="basename" value="i18n"/>
110. </bean>this.salary = salary;
111.     }
113.     public void setId(Integer id) {
114. <bean
115.       id="messageSource">
116.    
117.     <property name="basename" value="i18n"/>
118. </bean>this.id = id;
119.     }
121.     public String getEmail() {
122. <bean
123.       id="messageSource">
124.    
125.     <property name="basename" value="i18n"/>
126. </bean>return email;
127.     }
129.     public void setEmail(String email) {
130. <bean
131.       id="messageSource">
132.    
133.     <property name="basename" value="i18n"/>
134. </bean>this.email = email;
135.     }
137.     public Integer getAge() {
138. <bean
139.       id="messageSource">
140.    
141.     <property name="basename" value="i18n"/>
142. </bean>return age;
143.     }
145.     public void setAge(Integer age) {
146. <bean
147.       id="messageSource">
148.    
149.     <property name="basename" value="i18n"/>
150. </bean>this.age = age;
151.     }
153.     public String getName() {
154. <bean
155.       id="messageSource">
156.    
157.     <property name="basename" value="i18n"/>
158. </bean>return name;
159.     }
161.     public void setName(String name) {
162. <bean
163.       id="messageSource">
164.    
165.     <property name="basename" value="i18n"/>
166. </bean>this.name = name;
167.     }
169.     @Override
170.     public String toString() {
171. <bean
172.       id="messageSource">
173.    
174.     <property name="basename" value="i18n"/>
175. </bean>return "Monster{" +
176. <bean
177.       id="messageSource">
178.    
179.     <property name="basename" value="i18n"/>
180. </bean><bean
181.       id="messageSource">
182.    
183.     <property name="basename" value="i18n"/>
184. </bean>"id=" + id +
185. <bean
186.       id="messageSource">
187.    
188.     <property name="basename" value="i18n"/>
189. </bean><bean
190.       id="messageSource">
191.    
192.     <property name="basename" value="i18n"/>
193. </bean>", email='" + email + '\'' +
194. <bean
195.       id="messageSource">
196.    
197.     <property name="basename" value="i18n"/>
198. </bean><bean
199.       id="messageSource">
200.    
201.     <property name="basename" value="i18n"/>
202. </bean>", age=" + age +
203. <bean
204.       id="messageSource">
205.    
206.     <property name="basename" value="i18n"/>
207. </bean><bean
208.       id="messageSource">
209.    
210.     <property name="basename" value="i18n"/>
211. </bean>", name='" + name + '\'' +
212. <bean
213.       id="messageSource">
214.    
215.     <property name="basename" value="i18n"/>
216. </bean><bean
217.       id="messageSource">
218.    
219.     <property name="basename" value="i18n"/>
220. </bean>", birthday=" + birthday +
221. <bean
222.       id="messageSource">
223.    
224.     <property name="basename" value="i18n"/>
225. </bean><bean
226.       id="messageSource">
227.    
228.     <property name="basename" value="i18n"/>
229. </bean>", salary=" + salary +
230. <bean
231.       id="messageSource">
232.    
233.     <property name="basename" value="i18n"/>
234. </bean><bean
235.       id="messageSource">
236.    
237.     <property name="basename" value="i18n"/>
238. </bean>'}';
239.     }
240. }

复制代码

（3）MonsterHandler.java

1. package com.li.web.datavalid;
3. import com.li.web.datavalid.entity.Monster;
4. import org.springframework.context.annotation.Scope;
5. import org.springframework.stereotype.Controller;
6. import org.springframework.validation.Errors;
7. import org.springframework.validation.ObjectError;
8. import org.springframework.web.bind.annotation.RequestMapping;
9. import org.springframework.web.bind.annotation.RequestMethod;
11. import javax.validation.Valid;
12. import java.util.Map;
14. /**
15. * @author 李
16. * @version 1.0
17. */
18. @Controller
19. @Scope(value = "prototype")
20. public class MonsterHandler {
21.     /**
22.      * 1.SpringMVC可以将提交的数据，按照参数名和形参对象的属性名匹配，
23.      * 然后直接封装到对象中[模型数据]
24.      * 2.@Valid Monster monster 表示对monster接收的数据进行校验
25.      * 3.校验的发生的时机：在SpringMVC底层反射调用目标方法时，会接收到http请求接收到的数据，
26.      * 然后根据注解来进行验证。在验证过程中，如果出现了错误，就把错误信息填充到errors和 map中
27.      * @param monster
28.      * @param errors  表示如果校验出现了错误，会将校验的错误信息保存到errors中
29.      * @param map     map不但会保存monster对象，如果校验出现错误，也会将校验的错误信息放到map中
30.      * @return
31.      */
32.     @RequestMapping(value = "/save", method = RequestMethod.POST)
33.     public String save(@Valid Monster monster, Errors errors, Map<String, Object> map) {
34. <bean
35.       id="messageSource">
36.    
37.     <property name="basename" value="i18n"/>
38. </bean>System.out.println("----monster----" + monster);
39. <bean
40.       id="messageSource">
41.    
42.     <property name="basename" value="i18n"/>
43. </bean>//为了查看验证的情况，输出map和errors
44. <bean
45.       id="messageSource">
46.    
47.     <property name="basename" value="i18n"/>
48. </bean>System.out.println("=======map=======");
49. <bean
50.       id="messageSource">
51.    
52.     <property name="basename" value="i18n"/>
53. </bean>for (Map.Entry<String, Object> entry : map.entrySet()) {
54. <bean
55.       id="messageSource">
56.    
57.     <property name="basename" value="i18n"/>
58. </bean>    System.out.println("key=" + entry.getKey() +
59. <bean
60.       id="messageSource">
61.    
62.     <property name="basename" value="i18n"/>
63. </bean><bean
64.       id="messageSource">
65.    
66.     <property name="basename" value="i18n"/>
67. </bean>    " value=" + entry.getValue());
68. <bean
69.       id="messageSource">
70.    
71.     <property name="basename" value="i18n"/>
72. </bean>    System.out.println("--------");
73. <bean
74.       id="messageSource">
75.    
76.     <property name="basename" value="i18n"/>
77. </bean>}
78. <bean
79.       id="messageSource">
80.    
81.     <property name="basename" value="i18n"/>
82. </bean>System.out.println("=======errors=======");
83. <bean
84.       id="messageSource">
85.    
86.     <property name="basename" value="i18n"/>
87. </bean>for (ObjectError error : errors.getAllErrors()) {
88. <bean
89.       id="messageSource">
90.    
91.     <property name="basename" value="i18n"/>
92. </bean>    System.out.println("error="+error);
93. <bean
94.       id="messageSource">
95.    
96.     <property name="basename" value="i18n"/>
97. </bean>}
98.    
99. <bean
100.       id="messageSource">
101.    
102.     <property name="basename" value="i18n"/>
103. </bean>return "datavalid/success";
104.     }
105. }

复制代码

（4）monster_addUI.jsp：

1. <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
2. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
3. <html>
4. <head>
5.     <title>添加妖怪</title>
6. </head>
7. <body>
8. <h3>添加妖怪</h3>
9. <form:form action="save" method="post" modelAttribute="monster">
10.     妖怪id：<form:input path="id"/><br/><br/>
11.     妖怪名字：<form:input path="name"/><br/><br/>
12.     妖怪年龄：<form:input path="age"/><br/><br/>
13.     妖怪生日：<form:input path="birthday"/> 要求以"yyyy-MM-dd"的格式<br/><br/>
14.     妖怪工资：<form:input path="salary"/> 要求以"###,###.##"的格式<br/><br/>
15.     电子邮件：<form:input path="email"/><br/><br/>
16.     <input type="submit" value="添加妖怪"/>
17. </form:form>
18. </body>
19. </html>

复制代码

（5）测试
提交的数据：年龄这里故意填写不符合格式的数据（1-100）
后台输出了默认的错误信息：

1. ----monster----Monster{id=1, email='king@sohu.com', age=999, name='king', birthday=Tue Jan 01 00:00:00 CST 1924, salary=1267.22}
2. =======map=======
3. key=monster value=Monster{id=1, email='king@sohu.com', age=999, name='king', birthday=Tue Jan 01 00:00:00 CST 1924, salary=1267.22}
4. --------
5. key=org.springframework.validation.BindingResult.monster value=org.springframework.validation.BeanPropertyBindingResult: 1 errors
6. Field error in object 'monster' on field 'age': rejected value [999]; codes [Range.monster.age,Range.age,Range.java.lang.Integer,Range]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [monster.age,age]; arguments []; default message [age],100,1]; default message [需要在1和100之间]
7. --------
8. =======errors=======
9. error=Field error in object 'monster' on field 'age': rejected value [999]; codes [Range.monster.age,Range.age,Range.java.lang.Integer,Range]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [monster.age,age]; arguments []; default message [age],100,1]; default message [需要在1和100之间]

复制代码

（6）自定义错误信息：配置 springDispatcherServlet-servlet.xml

1. <bean
2.       id="messageSource">
3.    
4.     <property name="basename" value="i18n"/>
5. </bean>

复制代码

（7）在src 目录下创建国际化文件 i18n.properties

中文要使用 unicode 编码处理

1. NotEmpty.monster.name=\u7528\u6237\u540d\u4e0d\u80fd\u4e3a\u7a7a
2. typeMismatch.monster.age=\u5e74\u9f84\u8981\u6c42\u5728\u0031\u002d\u0031\u0035\u0030\u4e4b\u95f4
3. typeMismatch.monster.birthday=\u751f\u65e5\u683c\u5f0f\u4e0d\u6b63\u786e
4. typeMismatch.monster.salary=\u85aa\u6c34\u683c\u5f0f\u4e0d\u6b63\u786e

复制代码

（8）修改 monster_addUI.jsp 的 form ，回显错误信息

1. <form:form action="save" method="post" modelAttribute="monster">
2.     妖怪id：<form:input path="id"/><form:errors path="id"/><br/><br/>
3.     妖怪名字：<form:input path="name"/><form:errors path="name"/><br/><br/>
4.     妖怪年龄：<form:input path="age"/><form:errors path="age"/><br/><br/>
5.     妖怪生日：<form:input path="birthday"/><form:errors path="birthday"/>
6.     要求以"yyyy-MM-dd"的格式<br/><br/>
7.     妖怪工资：<form:input path="salary"/><form:errors path="salary"/>
8.     要求以"###,###.##"的格式<br/><br/>
9.     电子邮件：<form:input path="email"/><form:errors path="email"/><br/><br/>
10.     <input type="submit" value="添加妖怪"/>
11. </form:form>

复制代码

（9）再次进行测试

没有在properties文件中配置的提示，将会按照默认的错误信息回显

2.2细节说明和注意事项

• 在需要验证的 Javabean/POJO 的字段上添加相应的验证注解
  
• 目标方法上，在 Javabean/POJO 类型的参数前，添加 @Valid 注解以告知 SpringMVC 该 Bean 是需要验证的
  
• 在 @Valid 注解之后，添加一个 Errors 或 BindingResult 类型的参数，可以获取到验证的错误信息
  

  校验的发生的时机：SpringMVC 底层反射调用目标方法前，会接收到 http 请求接收到的数据，然后根据验证注解来进行验证。在验证过程中，如果出现了错误，就把错误信息填充到 errors，map 等参数中
  

  
  
• 需要使用  标签来显示错误信息，该标签需要写在  标签内生效
  
• 自定义错误消息的国际化文件 i18n.properties，如果是中文需要使用 unicode 编码处理。
  格式为：验证规则.表单modelAttribute值.属性名=错误提示信息
  
  
• 注意@NotNull 和 @NotEmpty 的区别
  @NotEmpty：
  1. Asserts that the annotated string, collection, map or array is not {@code null} or empty.

  复制代码
  @NotNull：
  1. The annotated element must not be {@code null}. Accepts any type.

  复制代码
  如果是字符串验证空，建议使用 @NotEmpty
  
• SpringMVC 验证时，同一个属性，会根据不同的验证错误，返回不同的错误信息
  

3.注解的结合使用


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！