目录
1.Hibernate-Validator 简介
2 项目中为什么要用校验框架
3. 添加依赖
4.在实体类上添加对应注解
5. POST方法中应用
@RequestBody 和 @RequestParam区别
6. GET方法中应用
7.利用PostMan调用接口
8.定义优雅的返回信息
8.1 定义全局异常处理
8.2 定义校验失败返回模板
8.3 测试
9.常用注解
10.Hibernate-Validator校验模式
普通模式
快速失败返回模式
开启快速失败返回模式
全局异常处理
11.对象级联校验
Student
User
hibernate-validator是Hibernate项目中的一个数据校验框架，它能够将数据校验从业务代码中脱离出来，增加代码可读性，同时也让数据校验变得更加方便、简单。
官网地址:
http://hibernate.org/validator/documentation
Java程序开发中，当你要处理一个程序的业务逻辑时，请求参数的数据校验是必须要处理的。当请求参数格式不正确的时候，需要程序监测到，并且返回对应的错误提示，以此来达到数据校验的目的。对于前后端分离开发过程中，数据校验还需要返回对应的状态码和错误提示信息。
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>
如果使用了springboot，则不需要引用任何依赖，因为spring-boot-starter-web包中已经包含了Hibernate-Validator 依赖。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@NotBlank(message = "用户名不能为空")
private String name;
@NotBlank(message = "邮箱不能为空")
private String email;
}
@RestController
public class StudentController {
@RequestMapping(value = "/addStudent",method = RequestMethod.POST)
public String addStudent(@Valid @RequestBody Student student){
System.out.println("student = [" + student + "]");
return "ok";
}POST请求必须要加@Valid
@RequestBody获取的是请求体里面的数据,一般是前端传给后端的JSON字符串。
@RequestParam 接收的是url里面的查询参数(比如xxxxxxx?name=admin)
以上面代码为例，如果去掉@RequestBody那student的属性就会从查询参数获取。
下面以PostMan演示以上两个注解在调用时的区别
如果方法上面添加@RequestParam注解，应该这样传递传递参数。
如果方法上面添加@RequestBody 注解，应该这样传递传递参数。
@RestController
@Validated
public class StudentController {
@RequestMapping(value = "/addStudent1",method = RequestMethod.GET)
public String addStudent1(@NotBlank(message = "name不能为空") String name){
System.out.println("name = [" + name + "]");
return "ok addStudent1";
}
}
Get请求需要在类上添加@Validated
看到这个结果发现我们添加的校验框架起作用了，响应信息中存在了"邮箱不能为空"的信息，但是前端用户一般只关心一个校验结果和校验失败信息，现在返回的这个信息太多了很难让人接受。所以我们需要定义统一的效验失败后返回的格式，这个格式中只包含状态码和失败原因。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public ResultEntity handleBindException(MethodArgumentNotValidException ex) {
FieldError fieldError = ex.getBindingResult().getFieldError();
// 记录日志。。。
return ResultEntity.faill(211,fieldError.getDefaultMessage(),null);
}
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResultEntity<T> {
private Integer code;
private String message;
private T data;
public static <T> ResultEntity<T> faill(Integer code,String msg,T t){
return new ResultEntity<T>(code,msg,t);
}
}
| 注解 | 说明 |
|---|---|
| @Nul | 被注释的元素必须为 null |
| @NotNull | 被注释的元素必须不为 null |
| @AssertTrue | 被注释的元素必须为 true |
| @AssertFalse | 被注释的元素必须为 false |
| @Min(value) | 被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
| @Max(value) | 被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
| @DecimalMin(value) | 被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
| @DecimalMax(value) | 被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
| @Size(max, min) | 被注释的元素的大小必须在指定的范围内，元素必须为集合，代表集合个数 |
| @Pattern(regexp = ) | 正则表达式校验 |
| @Digits (integer, fraction) | 被注释的元素必须是一个数字，其值必须在可接受的范围内 |
| @Past | 被注释的元素必须是一个过去的日期 |
| @Future | 被注释的元素必须是一个将来的日期 |
| 被注释的元素必须是电子邮箱地址 | |
| @Length(min=, max=) | 被注释的字符串的大小必须在指定的范围内，必须为数组或者字符串，若微数组则表示为数组长度，字符串则表示为字符串长度 |
| @NotEmpty | 被注释的字符串的必须非空 |
| @Range(min=, max=) | 被注释的元素必须在合适的范围内 |
| @NotBlank | 被注释的字符串的必须非空 |
| @URI | 字符串是否是一个有效的URL |
注意
校验完所有的属性，然后返回所有的验证失败信息，默认是这个模式
只要有一个失败就立马返回
@Configuration
public class HibernateValidatorConfiguration {
@Bean
public Validator validator(){
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
.configure()
// true 快速失败返回模式 false 普通模式
.addProperty( "hibernate.validator.fail_fast", "true" )
.buildValidatorFactory();
Validator validator = validatorFactory.getValidator();
return validator;
}
}
测试验证不通过就会抛出 ConstraintViolationException异常,和之前普通模式下抛出的异常不一样，所以为了格式统一我还需要自定义的异常处理。
// 开启快速失败返回模式，GET请求校验不通过会抛出如下异常，在这对它处理
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public ResultEntity handle(ValidationException exception) {
if (exception instanceof ConstraintViolationException) {
ConstraintViolationException exs = (ConstraintViolationException) exception;
Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();
for (ConstraintViolation<?> item : violations) {
System.out.println(item.getMessage());
return ResultEntity.faill(212, item.getMessage(), null);
}
}
return ResultEntity.faill(212, "abc", null);
}
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@NotBlank(message = "用户名不能为空")
private String name;
@Max(150)
@Min(10)
@NotNull(message = "年龄不能为空")
private Integer age;
@Email
private String email;
@NotNull(message = "user不能为空")
@Valid
private User user;
}
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Integer id;
@NotNull(message = "user对象中的username不能为空")
private String username;
}