Spring MVC介绍之Validation JSR303规范

在前后端分离如此盛行的今天，普遍使用 Json 进行数据交互，为了保证数据的完整与有效性，我们一般会在前端提交数据前进行一次数据校验，但这并不能完全保证数据的可靠，部分别有用心的人可能会绕过前端校验，直接通过浏览器控制台(F12)或一些抓包工具(charles/fildder)获取我们的接口，并手动拼接一些非法参数。为了避免这种情况的发生，就不得不在后台再进行一次请求数据校验。

后端参数校验最简单的做法是直接在业务方法里面进行判断，当判断成功之后再继续往下执行。但这样带给我们的是代码的耦合，冗余。当我们多个地方需要校验时，我们就需要在每一个地方调用校验程序,导致代码很冗余，且不美观。

例如:

if(StringUtils.isEmpty(password)){
    return Result.error(CodeMsg.MOBILE_ERROR);
}
if(StringUtils.isEmpty(moblie)){
    return Result.error(CodeMsg.MOBILE_EMPTY);
}
if (!ValidatorUtil.isMobile(moblie)){
    return Result.error(CodeMsg.MOBILE_ERROR);
}

以前我们的构思是这样的

JSR 303 原生的校验规则

z注解	作用
@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	限制必须是一个过去的日期
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间

JSR-303的校验是基于注解的，它内部已经定义好了一系列的限制注解，我们只需要把这些注解标记在需要验证的实体类的属性上或是其对应的get方法上。来看以下一个需要验证的实体类的代码：

public class LoginVo {
   @NotNull
   @IsMobile
   private String mobile;
 
   @NotNull
   @Length(min=32)
}

除了JSR-303原生支持的限制类型之外我们还可以定义自己的限制类型,看出这里自定义了一个 @IsMobile,定义自己的限制类型首先我们得定义一个该种限制类型的注解，而且该注解需要使用@Constraint标注。那么我们可以这样定义：

@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注解，使用@Constraint注解标注表明我们定义了一个用于限制的注解。@Constraint注解的validatedBy属性用于指定我们定义的当前限制类型需要被哪个ConstraintValidator进行校验。在上面代码中我们指定了Money限制类型的校验类是MoneyValidator。

另外需要注意的是我们在定义自己的限制类型的注解时有三个属性是必须定义的，如上面代码所示的message、groups和payload属性。

在定义了限制类型IsMobile之后，接下来就是定义我们的限制类型校验类IsMobileValidator了。限制类型校验类必须实现接口javax.validation.ConstraintValidator，并实现它的initialize和isValid方法。我们先来看一下IsMobileValidator的代码示例：

import  javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import org.apache.commons.lang3.StringUtils;

import com.imooc.miaosha.util.ValidatorUtil;

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)) {
            return true;
         }else {
            return ValidatorUtil.isMobile(value);
         }
      }
   }
}

从上面代码中我们可以看到ConstraintValidator是使用了泛型的。它一共需要指定两种类型，第一个类型是对应的initialize方法的参数类型，第二个类型是对应的isValid方法的第一个参数类型。从上面的两个方法我们可以看出isValid方法是用于进行校验的,所以在Controller中,使用 @Valid注解,看下代码示例:

@RequestMapping("/do_login")
@ResponseBody
public Result<Boolean> doLogin(HttpServletResponse response, @Valid LoginVo loginVo) {
   log.info(loginVo.toString());
   //登录
   userService.login(response, loginVo);
   return Result.success(true);
}

做下测试:

至此,分享到此结束