JSR303参数校验+全局异常处理
系统在登录的时候做了一个参数校验，也就是说每一个方法的开头都要去做一个校验，那么有没有更简洁的方法呢？那就是使用JSR 303 校验。
JSR 303 用于对Java Bean 中的字段的值进行验证,使得验证逻辑从业务代码中脱离出来。是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。
1.引入依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
2.用法：
在需要验证的参数前面打上标签注解@Valid，那么此注解就会自动对该Bean 进行参数校验。具体校验规则在该Bean内部实现。本项目是对登陆时候，利用到了参数校验。
public class LoginVo {
private String mobile;
private String password;
@NotNull
@IsMobile
public String getMobile() {
return mobile;
}
public void setMobile(String mobile) {
this.mobile = mobile;
}
@NotNull
@Length(min=32)//限定密码的长度
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
好处：可以直接使用@NotNull、@Length(min=32)等注解进行验证，避免重复的校验代码，只需在传入的参数上打上注解就可以进行参数校验，避免代码冗余。
3.自定义一个@IsMobile验证器：
新建一个注解IsMobile，并且引入相应的规则
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { IsMobileValidator.class })//继承校验器
public @interface IsMobile {
boolean required() default true;
String message() default "手机号码格式有误!";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
}
注意：只有注解系统是不会知道的，需要做一些处理。因为IsMobile里面需要一个@Constraint(validatedBy = { IsMobileValidator.class })，即IsMobileValidator。继承一个校验器。
新建一个IsMobileValidator类，需要继承ConstraintValidator校验器
public class IsMobileValidator implements ConstraintValidator<IsMobile,String>{
private boolean required=false;
public void initialize(IsMobile constraintAnnotation) {
required=constraintAnnotation.required();
}
public boolean isValid(String value, ConstraintValidatorContext context) {
if(required) {//查看值是否是必须的
return ValidatorUtil.isMobile(value);
}else {
if(StringUtils.isEmpty(value)) {//required
return true;
}else {
return ValidatorUtil.isMobile(value);
}
}
}
}
分析：首先会去找initialize初始化方法，在初始化的时候可以拿到IsMobile注解，然后查看值是否为必须的，如果是必须的，那么isValid会进行验证逻辑。
自定义的手机验证逻辑工具类ValidatorUtil
public class ValidatorUtil {
private static final Pattern mobile_pattern=Pattern.compile("1\\d{10}");//1开头，然后10个数字，那么正确的手机号
//验证手机号格式
public static boolean isMobile(String src) {
if(StringUtils.isEmpty(src)) {
return false;
}
Matcher m=mobile_pattern.matcher(src);
return m.matches();
}
}
全局异常处理
当定义了JSR303校验器后，校验不通过都会产生一个BindException( org.springframework.validation.BindException)和一大串错误信息（其中就包括校验的处理信息）。若要对异常处理，我们可以定义一个全局异常处理的拦截器。
好处：可以实现对项目中所有产生的异常进行拦截，在同一个类中实现统一处理。避免异常漏处理的情况。
步骤：
新建GlobalExceptionHandler类
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
//拦截什么异常
@ExceptionHandler(value=Exception.class)//拦截所有的异常
public Result<String> exceptionHandler(HttpServletRequest request,Exception e){
e.printStackTrace();
if(e instanceof GlobalException) {
GlobalException ex=(GlobalException) e;
CodeMsg cm=ex.getCm();
return Result.error(cm);
}
if(e instanceof BindException) {//是绑定异常的情况
//强转
BindException ex=(BindException) e;
//获取错误信息
List<ObjectError> errors=ex.getAllErrors();
ObjectError error=errors.get(0);
String msg=error.getDefaultMessage();
return Result.error(CodeMsg.BIND_ERROR.fillArgs(msg));
}else {//不是绑定异常的情况
return Result.error(CodeMsg.SERVER_ERROR);
}
}
}
注意：
@ControllerAdvice
@ControllerAdvice是一个@Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法，会对所有@RequestMapping方法进行检查，拦截。并进行异常处理。
@ExceptionHandler
标注要被拦截的异常，value=Exception.class代表拦截所有的异常，
@ResponseBody
为了方便输出，使得这个GlobalExceptionHandler类里面的方法跟我们Controller类一样是输出的信息，返回值Result类型，可以携带信息。当参数校验不通过的时候，输出也是Result（CodeMsg）,传给前端用于前端显示获取处理。
定义一个全局异常GlobalException，出现异常就可以直接抛这个异常即可。GlobalException()继承Runtime类，重写构造函数，传入CodeMsg 。
/**
* 全局异常处理
*
*/
public class GlobalException extends RuntimeException{
private static final long serialVersionUID = 1L;
private CodeMsg cm;
public GlobalException(CodeMsg cm){
super(cm.toString());
this.cm=cm;
}
public CodeMsg getCm() {
return cm;
}
public void setCm(CodeMsg cm) {
this.cm = cm;
}
}
全局异常处理场景：先检查异常类型，若是我们业务异常，返回即可。业务中发现异常直接抛出我们自定义的异常即可。
public boolean login(HttpServletResponse response, LoginVo loginVo) {
if (loginVo == null )
throw new GlobalException(CodeMsg.SERVER_ERROR);
String mobile = loginVo.getMobile();
String password = loginVo.getPassword();
//判断手机号 是否能查到对象
if(!ValidatorUtil.isMobile(mobile)) {//手机号验证不通过 false
throw new GlobalException(CodeMsg.MOBILE_ERROR);
}
MiaoshaUser miaoshaUser = getById(Long.valueOf(mobile));
if (miaoshaUser == null){
throw new GlobalException(CodeMsg.MIAOSHA_ERROR);
}
return Result.success(true);
.
网友评论