参数校验
代码中存在大量的参数校验逻辑,会使代码看起来又多又乱,大大降低代码可读性
@Valid 及相关注解
注解
@
Valid
的主要作用是用于参数效验,在
api
接口方法的参数前添加
@
Valid
注解,会自动开启对参数的校验的功能
此时
api
接口方法的参数只能是对象类型的参数,可以编写业务实体类专门用于参数校验
具体对实体对象的各个属性做什么校验,由业务实体类中成员变量上的注解决定
pom
.xml
中引入
SpringBoot
的
相关依赖
<!-- @Valid 校验依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
编写注册业务实体类
新建so(实体类)包
创建对应的实体类
@NotBlank(message = "用户名不能为空")
private String username;
@NotBlank
@Size(min = 6,message = "密码不能少于6个字符")
private String password;
@NotBlank
@Size(min = 6,message = "确认密码不能少于6个字符")
private String checkPassword;
@NotBlank(message = "用户名不能为空")
private String username;
@NotBlank
@Size(min = 6,message = "密码不能少于6个字符")
private String password;
校验各个字段
实体类中的属性上加相关注解
注解 说明
@NotBlank 限制必须非空字符串
@NotNull 限制必须不为null
@Max(value) 限制最大值
@Min(value) 限制最小值
@Size(max, min) 限制字符长度必须在min和max之间
@AssertTrue 限制必须为True
@AssertFalse 限制必须为False
全局异常处理类
@
Valid
校验不合法时会抛出
MethodArgumentNotValidException
异常,编写一个全局异常处理类,对抛出的异常进行处理
package com.example.mall.common;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.List;
@RestControllerAdvice //全局控制器通知,会拦截所有来自控制器的异常
public class GloballExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public ApiResponse paraExceptionHandler(MethodArgumentNotValidException e){
List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
String errorMessage="";
for (FieldError fieldError:fieldErrors) {
errorMessage += fieldError.getDefaultMessage()+",";
}
return new ApiResponse(false,errorMessage);
}
}
注解
注解注解注解