Validator 使用总结

摘要:祝大家元旦快乐!在日常开发中,前台对参数校验后,为了避免用户直接使用http工具直接向后台发起不合法请求,后台往往也需要校验,本文将要介绍的是使用Validator对数据进行校验。

正文:

介绍

首先说下大家常用的hibernate-validator,它是对JSR-303/JSR-349标准的实现,然后spring为了给开发者提供便捷集成了 hibernate-validator,默认在springmvc模块。

依赖

本文所介绍皆在springboot应用的基础上,首先加上web模块:

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

可以查看其子依赖,发现web模块默认使用了hibernate-validator:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>

对实体类添加校验

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
public class AgentTrustor implements Serializable,UniqueVerifiableVO {

private static final long serialVersionUID = 4095871718305603749L;

/**
* 主键ID
*/
@Id
@ApiModelProperty(value="主键ID", required = true)
private Integer fid;

/**
* 代理人代码
*/
@Length(min = 3,message = "代理人代码位数至少三位")
@Column(name = "ftrustor_id")
@ApiModelProperty(value="代理人代码", required = true)
private String ftrustorId;
/**
* 联系人邮箱
*/
@Email(message = "邮箱格式错误")
@Column(name = "femail")
@ApiModelProperty(value="联系人邮箱", required = true)
private String femail;
}

通过注释名即可推断出校验的内容,message用作校验失败时的提示信息。

对Rest层添加校验

1
2
3
4
5
6
7
@ApiOperation(value="新增", notes="")
@PostMapping(value = "")
//@Transactional(rollbackFor=Exception.class)
public ObjectRestResponse<AgentTrustor> add(@RequestBody @Validated AgentTrustor agentTrustor) throws BaseException{
agentTrustorBiz.bizInsertSelective(agentTrustor);
return new ObjectRestResponse<AgentTrustor>().rel(true);
}

统一异常的处理

经过对校验异常的debug发现,该异常为MethodArgumentNotValidException

MethodArgumentNotValidException

可以看到该异常对象的结构,同样我们可以根据其结构解析出想要的结果:

1
2
3
4
5
6
7
8
9
10
11
12
13
@ExceptionHandler(MethodArgumentNotValidException.class)
public BaseResponse validExceptionHandler(HttpServletResponse response, MethodArgumentNotValidException ex) {
BindingResult bindingResult = ex.getBindingResult();
StringBuffer stringBuffer = new StringBuffer();
if(bindingResult.hasErrors()){
for (FieldError fieldError : bindingResult.getFieldErrors()) {
//该格式仅仅作为response展示和log作用,前端应自己做校验
stringBuffer.append(fieldError.getObjectName() + "--" + fieldError.getDefaultMessage() + " ");
}
}
logger.error(stringBuffer.toString());
return new BaseResponse(HttpStatus.BAD_REQUEST.value(),stringBuffer.toString());
}

上面代码是统一异常处理中的一部分,主要是用来处理参数校验产生的MethodArgumentNotValidException异常。

分组校验

当我们遇到不同场景需要有不同的校验规则时候,我们可以使用分组校验。如:一个请求只校验id,一个请求只校验email:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
public class AgentTrustor implements Serializable,UniqueVerifiableVO {

private static final long serialVersionUID = 4095871718305603749L;

/**
* 主键ID
*/
@Id
@ApiModelProperty(value="主键ID", required = true)
private Integer fid;

/**
* 代理人代码
*/
@Length(min = 3,message = "代理人代码位数至少三位",groups = {ID.class})
@Column(name = "ftrustor_id")
@ApiModelProperty(value="代理人代码", required = true)
private String ftrustorId;
/**
* 联系人邮箱
*/
@Email(message = "邮箱格式错误",groups = {EMAIL.class})
@Column(name = "femail")
@ApiModelProperty(value="联系人邮箱", required = true)
private String femail;

public interface ID{};

public interface EMAIL{};
}

根据需要在@Validated属性中指定需要校验的分组名,可以指定1到多个。指定到的分组名会全部进行校验,不指定的不校验

1
2
3
4
5
6
7
@ApiOperation(value="新增", notes="")
@PostMapping(value = "")
//@Transactional(rollbackFor=Exception.class)
public ObjectRestResponse<AgentTrustor> add(@RequestBody @Validated(AgentTrustor.ID.class) AgentTrustor agentTrustor) throws BaseException{
agentTrustorBiz.bizInsertSelective(agentTrustor);
return new ObjectRestResponse<AgentTrustor>().rel(true);
}

API

JSR提供的校验注解

1
2
3
4
5
6
7
8
9
10
11
12
13
@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提供的校验注解

1
2
3
4
5
@NotBlank(message =)   验证字符串非null,且长度必须大于0    
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内