Hibernate-Validator参数校验
在开发中后台接口经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等，写这些与业务逻辑关系不大主要有以下两方面缺点：
- 验证代码繁琐，重复劳动
- 方法内代码显得冗长
使用步骤
- 引入该功能核心依赖
- 添加 Hibernate-Validator 依赖，如果使用了springboot，则不需要引入任何依赖，因为spring-boot-starter-web包中已经包含Hibernate-Validator 依赖
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>
- 在类的属性上加上对应的验证注解
public class TestDto {
@NotBlank(message = "姓名不能为空")
private String name;
...
}
- Post方法中应用，需要注解 @RequestBody @Valid
/**
* 测试校验框架返回结果格式
*/
@PostMapping(value = "/validator")
public String testValidator(@RequestBody @Valid TestDto testDto){
return "校验成功...";
}
- 利于postman调用接口测试，入参和出参如下
//入参
{
"name":""
}
// 返回结果
{
"timestamp": "2019-02-01T09:03:16.350+0000",
"status": 400,
"error": "Bad Request",
"errors": [
{
"codes": [
"NotBlank.testDto.name",
"NotBlank.name",
"NotBlank.java.lang.String",
"NotBlank"
],
"arguments": [
{
"codes": [
"testDto.name",
"name"
],
"arguments": null,
"defaultMessage": "name",
"code": "name"
}
],
"defaultMessage": "姓名不能为空",
"objectName": "testDto",
"field": "name",
"rejectedValue": "",
"bindingFailure": false,
"code": "NotBlank"
}
],
"message": "Validation failed for object='testDto'. Error count: 1",
"path": "/test/validator"
}
若想使用Get请求，需要在类上加入注解@Validated，然后再加入其它对应注解，代码如下：
@RestController
@RequestMapping("/test")
@Validated
public class TestController {
/**
* 测试校验框架返回结果格式
*/
@GetMapping(value = "/validator2")
public String testValidator2(@NotBlank(message = "姓名不能为空") String name){
return "校验成功...";
}
}
使用spring中的@ControllerAdvice优雅的返回异常信息
相信对于这种返回格式每个开发都无法忍受，怎么办？ 既然它统一返回这种样式，那就解析它吧，aop环绕，拦截器等都可以，这里使用另外一种方式，spring自带的全局异常处理机制，具体如下
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
/**
* 参数校验统一异常处理
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public ResponseEntity handleBindException(MethodArgumentNotValidException ex) {
FieldError fieldError = ex.getBindingResult().getFieldError();
log.warn("参数校验异常:{}({})", fieldError.getDefaultMessage(),fieldError.getField());
return ResponseEntity
.ok(Response.fail(211,
fieldError.getDefaultMessage(),
fieldError.getDefaultMessage()));
}
}
重新调用无参的接口后，返回结果：
{
"code": 211,
"message": "姓名不能为空",
"detail": "姓名不能为空",
"data": null
}
常用校验注解
| 注解 | 释义 |
|---|---|
| @Nul | 被注释的元素必须为 null |
| @NotNull | 被注释的元素必须不为 null |
| @AssertTrue | 被注释的元素必须为 true |
| @AssertFalse | 被注释的元素必须为 false |
| @Min(value) | 被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
| @Max(value) | 被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
| @DecimalMin(value) | 被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
| @DecimalMax(value) | 被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
| @Size(max, min) | 被注释的元素的大小必须在指定的范围内，元素必须为集合，代表集合个数 |
| @Digits (integer, fraction) | 被注释的元素必须是一个数字，其值必须在可接受的范围内 |
| @Past | 被注释的元素必须是一个过去的日期 |
| @Future | 被注释的元素必须是一个将来的日期 |
| 被注释的元素必须是电子邮箱地址 | |
| @Length(min=, max=) | 被注释的字符串的大小必须在指定的范围内，必须为数组或者字符串，若微数组则表示为数组长度，字符串则表示为字符串长度 |
| @NotEmpty | 被注释的字符串的必须非空 |
| @Range(min=, max=) | 被注释的元素必须在合适的范围内 |
| @NotBlank | 被注释的字符串的必须非空 |
| @Pattern(regexp = ) | 正则表达式校验 |
| @Valid | 对象级联校验,即校验对象中对象的属性 |
