JSR303参数校验实践

参数校验主要是对前台传参的合法性监测，下面就来了解Java中参数校验的一些知识

简单的参数校验

要想实现一个简单的参数校验很简单：

1. 给需要校验的字段加上相应的规范注解
2. 有需要可以自定义message信息
3. 在校验时加上@Valid注解在需要校验的Bean前
4. 可以给校验的Bean后面紧跟一个BindingResult就可以获取到校验结果

如下为校验注解

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;


	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌id")
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank
	@URL(message = "logo必须是一个合法的url地址")
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
//	@Pattern()
	@NotNull
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(groups={AddGroup.class})
	@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母")
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull
	private Integer sort;
}

进行校验

    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
        if (result.hasErrors()){
            Map<String, String> map = new HashMap<>();
            //1.获取校验错误信息
            result.getFieldErrors().forEach((item) -> {
                // 获取信息和属性
                String message = item.getDefaultMessage();
                String field = item.getField();
                map.put(field, message);
            });
            return R.error(400, "提交数据不合法").put("data", map);
        }
		brandService.save(brand);
        return R.ok();
    }

这样虽然是可行的，但是复用性未免太差了而且对于不同的操作对于Bean的条件属性也是不同的，比如在新增功能中，因为id使用的自增主键，因此我们不希望用户传入值，但在更新，删除，查找的时候有需要带上主键，这个需求使用简单的参数校验是无法解决的。

参数校验进阶

针对于上面几种情况，可以采取分组校验，比如可以创建一个新增组和更新组，对于不同的组进行不同的校验操作，这样就可以完成这个需求。

分组校验

实现分组校验可以分为下面几个步骤：

1. 根据需求创建几个分组
2. 在Bean中添加校验规则时后面跟上相应的分组
3. 使用Validated校验时加上分组

注意：如果使用了分组校验，但有些需要校验的注解没有加上分组信息，那么这些校验注解就会失效

创建分组，直接创建新的接口用于标识
增加组

public interface AddGroup {
}

更新组，需要传入其他字段

public interface UpdateGroup {
}

更新状态组，只需要传入状态和id就行

public interface UpdateStatusGroup {
}

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;


	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌id",groups = {UpdateGroup.class})
	@Null(message = "新增不能指定id",groups = {AddGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(groups = {AddGroup.class})
	@URL(message = "logo必须是一个合法的url地址",groups={AddGroup.class,UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(groups={AddGroup.class})
	@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups={AddGroup.class,UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(groups={AddGroup.class})
	private Integer sort;
}

这样就成功的使用了分组校验，也能解决上面的问题了，但是javax提供的这些校验注解并不能满足我们的需求，比如sort字段必须是一个大于0的数字，showStatus必须是0或者1，因此这就需要我们进行自定义校验注解

自定义校验注解

自定义校验注解步骤分为下面几步：

1. 编写一个自定义注解
2. 给自定义注解里面加上合适的校验器

新建一个注解为ListValue就是取值规范，里面属性有groups，payload还有自己规定的范围数组vals

@Documented
// validatedBy里是校验器
@Constraint(
        validatedBy = {ListValueConstraintValidator.class}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {
    String message() default "{com.wrial.common.valid.ListValue.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    // 表示校验值的范围
    int[] vals() default {};

}

自定义校验器，实现ConstraintValidator实现内部方法，对需要校验的字段进行判断是否合法

//第一个泛型是表示给那个注解，第二个是对什么类型字段的校验
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {


    private Set<Integer> set = new HashSet<>();
    @Override
    public void initialize(ListValue constraintAnnotation) {
        // 拿出所有合法值放入set
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    /**
     *
     * @param integer 需要进行校验的值
     * @param constraintValidatorContext 上下文信息
     * @return
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(integer);
    }
}

对于校验属性的修改，也可以在classpath下创建properties文件进行修改（默认扫描）

这样就基本可以完成平时开发中的校验问题了，但是每次都在controller中获取校验绑定信息，这样会影响代码的直观程度，因此还需要对此进行优化，需要加上全局异常处理

全局异常处理

使用RestControllerAdvice注解来完成，因为参数校验错误会报MethodArgumentNotValidException异常，因此先对此异常进行拦截，下面再是全局异常，在这里面对异常信息进行处理，提高了代码的复用性

/**
 * 集中处理所有异常
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.wrial.mall.product.controller")
public class MallExceptionControllerAdvice {


    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e){
        log.error("数据校验出现问题{}，异常类型：{}",e.getMessage(),e.getClass());
        BindingResult bindingResult = e.getBindingResult();

        Map<String,String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError)->{
            errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
    }

    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){

        log.error("错误：",throwable);
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }


}

有了全局异常处理，controller代码就可以精简为下面代码

    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) throws Exception {

        brandService.save(brand);
        return R.ok();
    }

这样就可以很完美的实现校验功能了！