秒杀商城系统 JSR303 全局异常处理 （七）

JSR303参数校验

https://blog.csdn.net/u014029255/article/details/55518598

为什么选择jsr303

• 参数校验是我们程序开发中必不可少的过程。用户在前端页面上填写表单时，前端js程序会校验参数的合法性，当数据到了后端，为了防止恶意操作，保持程序的健壮性，后端同样需要对数据进行校验。后端参数校验最简单的做法是直接在业务方法里面进行判断，当判断成功之后再继续往下执行。但这样带给我们的是代码的耦合，冗余。当我们多个地方需要校验时，我们就需要在每一个地方调用校验程序,导致代码很冗余，且不美观。

• 那么如何优雅的对参数进行校验呢？JSR303就是为了解决这个问题出现的

总结：选择jsr303就是为了优雅。如何让代码优雅，就是将验证逻辑从业务代码中脱离出来，后面代码实现部分会看到

JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面，就可以在需要校验的时候进行校验了。注解如下：

 @NotNull                 注解元素必须是非空

 @Null                      注解元素必须是空

 @Digits                    验证数字构成是否合法

 @Future                   验证是否在当前系统时间之后

 @Past                       验证是否在当前系统时间之前

 @Max                      验证值是否小于等于最大指定整数值

 @Min                       验证值是否大于等于最小指定整数值

 @Pattern                  验证字符串是否匹配指定的正则表达式

 @Size                      验证元素大小是否在指定范围内

 @DecimalMax   验证值是否小于等于最大指定小数值

 @DecimalMin    验证值是否大于等于最小指定小数值

 @AssertTrue             被注释的元素必须为true

 @AssertFalse     被注释的元素必须为false

 @Email                    被注释的元素必须是电子邮箱地址

 @Length                   被注释的字符串的大小必须在指定的范围内

 @NotEmpty              被注释的字符串的必须非空

 @Range                    被注释的元素必须在合适的范围内

具体代码实现

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//是否翻译到Javadoc
	@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 Result<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);
    }