数据验证
SpringMVC 也提供了验证参数的机制。一方面,它可以支持JSR-303 注解验证, 在默认
的情况下Spring Boot 会引入关于Hibernate Validator 机制来支持JSR-303 验证规范;另外一方面, 因
为业务会比较复杂,所以需要自定义验证规则
1.JSR-303验证
JSR- 303 验证主要是通过注解的方式进行的
package com.example.springboot.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.*;
import java.util.Date;
@Data
public class ValidatorPojo {
//非空判断
@NotNull(message = "id不能为空")
private Long id;
@Future(message = "需要一个将来日期")
//@Past 只能是过去日期
@DateTimeFormat(pattern = "yyyy-MM-dd")
@NotNull
private Date date;
@NotNull
@DecimalMin(value = "0.1")
@DecimalMax(value = "10000.00")
private Double doubleValue;
@NotNull
@Min(value = 1,message = "最小值为1")
@Max(value = 88,message = "最大值为88")
private Integer integer;
@Range(min=1,max = 888,message = "范围为1至888")
private Long range;
@Email(message = "邮箱格式错误")
private String email;
@Size(min = 20,max = 30,message = "字符串长度要求20到30之间")
private String size;
}
POJO 中的属性带着各种各样验证注解,并且代码己经在注释中说明其作用, JSR-303 验证就是
通过这些注解来执行验证的
为了测试需要编写一个html , 然后使用JSON 的数据请求发送这个对象
给控制器
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>主页</title>
<script src="../js/jquery-1.8.0.min.js"></script>
<script>
$(function () {
var pojo = {
id:null,
date:'2019-04-30',
doubleValue:999999.09,
integer:100,
range:1000,
email:'email',
size:'adv1212'
}
$.ajax({
url:'/user/validate',
type:'POST',
//此处需要告知传递参数类型为JSON , 不能缺少
contentType:'application/json',
//将JSON 转化为字符串传递
data:JSON.stringify(pojo),
success:function(result){
console.log(result)
}
})
})
</script>
</head>
<body>
</body>
</html>
这样,打开这个页面时, 它就会通过Ajax 请求到对应的方法,然后提供注解来进行验证。为了
打开这个页面并且提供后台验证, 在Controller 中新增方法用来响应这个页面发出的Ajax 请求
@RequestMapping("/validate")
@ResponseBody
public Map validate(@Valid @RequestBody ValidatorPojo vp, Errors errors){
Map map = new HashMap();
//获取错误列表
List<ObjectError> oes = errors.getAllErrors();
for(ObjectError oe:oes){
String key = null;
String msg = null;
//字段错误
if(oe instanceof FieldError){
FieldError fe = (FieldError)oe;
key = fe.getField();
}else{
//非字段错误
key = oe.getObjectName();
}
msg = oe.getDefaultMessage();
map.put(key,msg);
}
return map;
}
代码中使用@RequestBody 代表着接收一个JSON 参数, 这样Spring 就会获取页面通过Ajax 提交
的JSON 请求体,然后@Valid 注解则表示启动验证机制, 这样Spring 就会启用JSR-303 验证机制进行
验证。它会自动地将最后的验证结果放入Errors 对象中, 这样就可以从中得到相关验证过后的信息。
浏览器中输入 localhost:8082/page/index.html
2.自定义参数验证
自定义参数验证需实现Validator接口
package com.example.springboot.component;
import com.example.springboot.entity.Dog;
import org.springframework.util.StringUtils;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;
public class DogValidator implements Validator {
@Override
public boolean supports(Class<?> aClass) {
return aClass.equals(Dog.class);
}
@Override
public void validate(Object o, Errors errors) {
if(o==null){
errors.rejectValue("",null,"用户不能为空");
return;
}
Dog dog = (Dog)o;
if(StringUtils.isEmpty(dog.getName())){
errors.rejectValue("name",null,"用户名不能为空");
}
}
}
有了这个验证器, Spring 还不会自动启用它,因为还没有绑定给WebDataBinder 机制。在Spring
MVC 中提供了一个注解@InitBinder , 它的作用是在执行控制器方法前,处理器会先执行表
@ lnitBinder 标注的方法。这时可以将WebDataBinder 对象作为参数传递到方法中,通过这层关系得
到WebDataBinder 对象,这个对象有一个setValidator 方法, 它可以绑定自定义的验证器,这样就可
以在获取参数之后,通过自定义的验证器去验证参数, 只是WebDataBinder 除了可以绑定验证器外,
还可以进行参数的自定义,例如,不使用@ DateTimeFormat 获取日期参数。
@InitBinder
public void initBinder(WebDataBinder binder){
//绑定验证器
binder.setValidator(new DogValidator());
//定义日期参数格式,参数不再注解@DateTimeFormat , boolean 参数表示是否允许为空
binder.registerCustomEditor(Date.class,
new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"),false));
}
@GetMapping("/validator")
@ResponseBody
public Map validator(@Valid Dog dog,Errors errors,Date date){
Map map = new HashMap();
//获取错误列表
map.put("dog",dog);
map.put("date",date);
List<ObjectError> oes = errors.getAllErrors();
for(ObjectError oe:oes){
String key = null;
String msg = null;
//字段错误
if(oe instanceof FieldError){
FieldError fe = (FieldError)oe;
key = fe.getField();
}else{
//非字段错误
key = oe.getObjectName();
}
msg = oe.getDefaultMessage();
map.put(key,msg);
}
return map;
}
浏览器输入 http://localhost:8082/user/validator?dog=-james&date=2018-12-13
返回结果
{"date":"2018-12-12T16:00:00.000+0000","name":"用户名不能为空","dog":{"name":"","owner":"james"}}