目录
1. JSR303
JSR303是Java为Bean数据合法性校验提供给的标准框架,已经包含在 JavaEE6.0中,JSR303通过在Bean 属性中标注类似 @NotNull @Max 等标准的注解指定校验规则,并通过标准的验证接口对 Bean进行验证。
2. JSR303中含有的注解
@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(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator 附加的注解
@NotBlank(message =) 验证字符串非null,且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
注:HIbernate Validator是JSR303的一个参考实现,除了支持所有标准的校验注解外,另外HIbernate Validator还有JSR-380的实现
3. spring中使用JSR303进行服务端校验
3.1 导入依赖包
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>
3.2 添加验证规则
比如名称一般是字符串,那么使用notblank,而不是notnull
3.3 执行校验
在请求处理方法中,使用@Validated或@Valid注解要验证的对象,并根据BindingResult判断校验是否通过, 另外,验证参数后必须紧跟BindingResult参数,否则spring会在校验不通过时直接抛出异常。
需要验证就直接吧@Validated或@Valid放在参数中
错误信息:BindingResult,必须写在@Validated或@Valid后面,不分开
注:@Valid和@Validated的区别
两者的作用是一样的,但@Validated功能更丰富,有分组功能。
3.4 错误信息的展示
注意:两个path要相同
第一种展示方式,每个属性分别展示:
第二种方式:
4. 分组验证
学生ID号由数据库自增生成,在新增学生时不需要要传入,但在修改学生信息时需要通过ID号进行修改,所以需要传达ID号,再在这时就需要分组验证了。
4.1 定义分组验证规则
注意:如下图,如果果定义两个方法,并且两个都需要用到书名sname不为空,那么可以用groups方法将两个方法用“{}”括起来
4.2 验证时通过参数指定验证规则
增加时需要id不为空的条件,加入在@Vali。。。参数中加入对应的方法ADD()
4.3 验证信息的显示
5.1 增加spring配置
<!-- 转换器,将返回消息转换为json -->
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<property name="messageConverters">
<list>
<ref bean="mappingJackson2HttpMessageConverter"/>
</list>
</property>
</bean>
<!-- 处理中文编码,(spring通过该配置自动设置响应头)-->
<bean id="mappingJackson2HttpMessageConverter"
class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<!--处理中文乱码以及避免IE执行AJAX时,返回JSON出现下载文件-->
<property name="supportedMediaTypes">
<list>
<value>text/html;charset=UTF-8</value>
<value>text/json;charset=UTF-8</value>
<value>application/json;charset=UTF-8</value>
</list>
</property>
</bean>
注:spring为简化开发提供了丰富的组件,在使用时需要将组件配置到spring中,并为这些组件提供合适的参数。
5.2 Controller
通过:http://localhost:8080/rest/loadStudent?sid=6请求,可以查到返回的json数据。 (sid查询条件按自己的实际参数数据填写)
5.3 格式化返回数据
在前后端分离模式的开发中,提供给前端使用的数据(或提供给第三方系统)通常需要按双方协商定义的格式返回,以方便解析。一般有两种处理方式:1)将用户Map组织格式化返回的数据,2)定义一个放回数据的实体来格式化返回的数据。
定义数据返回格式:
输入http://localhost:8080/rest/loadStudent?sid=6测试返回的数据。(按自己测试数据输入条件)
转换JSON时常用的注解: 忽略:JsonIgnore, 取别名@JsonProperty("xxx"), 指定转换的日期格式@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss"), 指定日期格式时还可以指定时区,如:@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
说明:GMT 就是格林威治标准时间的英文缩写(Greenwich Mean Time 格林尼治标准时间),是世界标准时间,gmt+8 是格林威治时间+8小时,中国所在时区就是gmt+8
5.4 Restfull接口验证失败处理