一、使用

1.1 字段注解

可以使用@NotEmpty、@NotNull等存在于javax.validation.constraints包下的校验注解，参照对应的校验规则，选择合适的注解使用。

/**
 * 品牌名
 */
 @NotBlank(message = "品牌名必须提交")
 private String name;

1.2 默认的校验提示信息

存在于ValidationMessages_zh_CN.properties文件中，根据不同的校验注解有不同的默认提示信息，我们可以在对应注解使用时，使用其message属性指定其对应的合适提示信息。

@NotBlank(message = "品牌名必须提交")

1.3 开启校验

在实体接收参数的位置使用@Valid注解来开启参数校验。如下：

/**
* 保存
*/
@RequestMapping("/save")
//@RequiresPermissions("product:brand:save")
public R save(@Valid @RequestBody BrandEntity brand){
  brandService.save(brand);
  return R.ok();
}

通过接口调用，可以看到对应的校验注解已经生效：

{
    "timestamp": "2022-01-15T11:59:03.537+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotNull.brandEntity.sort",
                "NotNull.sort",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "brandEntity.sort",
                        "sort"
                    ],
                    "arguments": null,
                    "defaultMessage": "sort",
                    "code": "sort"
                }
            ],
            "defaultMessage": "不能为null",
            "objectName": "brandEntity",
            "field": "sort",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        },
        {
            "codes": [
                "NotBlank.brandEntity.name",
                "NotBlank.name",
                "NotBlank.java.lang.String",
                "NotBlank"
            ],
            "arguments": [
                {
                    "codes": [
                        "brandEntity.name",
                        "name"
                    ],
                    "arguments": null,
                    "defaultMessage": "name",
                    "code": "name"
                }
            ],
            "defaultMessage": "品牌名必须提交",
            "objectName": "brandEntity",
            "field": "name",
            "rejectedValue": "",
            "bindingFailure": false,
            "code": "NotBlank"
        },
        {
            "codes": [
                "NotEmpty.brandEntity.logo",
                "NotEmpty.logo",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "brandEntity.logo",
                        "logo"
                    ],
                    "arguments": null,
                    "defaultMessage": "logo",
                    "code": "logo"
                }
            ],
            "defaultMessage": "不能为空",
            "objectName": "brandEntity",
            "field": "logo",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        },
        {
            "codes": [
                "NotEmpty.brandEntity.firstLetter",
                "NotEmpty.firstLetter",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "brandEntity.firstLetter",
                        "firstLetter"
                    ],
                    "arguments": null,
                    "defaultMessage": "firstLetter",
                    "code": "firstLetter"
                }
            ],
            "defaultMessage": "不能为空",
            "objectName": "brandEntity",
            "field": "firstLetter",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        }
    ],
    "message": "Validation failed for object='brandEntity'. Error count: 4",
    "path": "/product/brand/save"
}

但是返回的提示信息并没有按照我们预先规定好的返回数据格式返回，所以需要对返回结果进行封装。

1.4 校验结果封装

在入参的位置，加一个参数BindingResult，可以在参数校验时，将校验结果接收，

并可调用其hasErrors()方法判断其是否存在不合法的参数校验结果，
还可调用其getFieldErrors()获取出现不合法参数的字段结果集合FieldError
- 通过对校验出的字段结果进行遍历，
  - 调用其getDefaultMessage()方法获取错误提示信息
  - 调用其getField()方法获取出现不合法参数的字段名

/**
     * 保存
     */
@RequestMapping("/save")
//@RequiresPermissions("product:brand:save")
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
    if (result.hasErrors()) {
        Map<String, String> map = new HashMap<>();
        // 获取校验的错误结果
        result.getFieldErrors().forEach(
            item -> {
              // 获取到对应错误的提示信息
              String message = item.getDefaultMessage();
              // 获取到对应错误的属性名字
              String field = item.getField();
              map.put(field, message);
            }
        );
        return R.error(400, "提交的数据不合法").put("data", map);
    } else {
        brandService.save(brand);
        return R.ok();
    }
}

再次调用此接口，可以看到封装后的返回结果：

{
    "msg": "提交的数据不合法",
    "code": 400,
    "data": {
        "name": "品牌名必须提交",
        "logo": "不能为空",
        "sort": "不能为null",
        "firstLetter": "不能为空"
    }
}

二、统一异常处理降低侵入

可以通过统一的异常处理类，来减少代码的重复编写以及降低代码侵入。

/**
 * 统一异常处理
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.maomaochong.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {
    /**
     * 处理参数不合法异常
     * @param e
     * @return
     */
    @ExceptionHandler(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(
                item -> {
                    errorMap.put(item.getField(), item.getDefaultMessage());
                }
        );
        return R.error(400, "数据校验出现问题").put("data", errorMap);
    }
}

三、使用分组校验

我们可以借助于校验注解的groups注解，对注解进行分组，根据不同的场景使用不同的分组来做校验，让校验注解更加灵活。

3.1 创建分组接口

要使用分组校验功能，需要先创建对应分组的接口，作为分组的标识。只需要创建接口不需要其他额外的操作。

/**
 * 参数分组校验标识 新增
 */
public interface AddGroup {
}

3.2 给校验注解指定分组

在对应的校验注解上使用其groups属性，传入对应分组的接口class名即可实现对接口的分组。一个注解可以同时属于多个分组，只需要在此属性中传入对应多个分组的class即可。

/**
     * 品牌id
     */
@NotNull(message = "修改时必须指定id", groups = {UpdateGroup.class})
@Null(message = "新增不能指定id", groups = AddGroup.class)
@TableId
private Long brandId;

3.3 指定当前使用分组

我们需要在使用的位置，使用新的开启校验的注解@Validated，并在此注解的value属性中指定分组接口标识。

/**
     * 保存
     */
@RequestMapping("/save")
//@RequiresPermissions("product:brand:save")
public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand){
    ...
}
/**
     * 修改
     */
@RequestMapping("/update")
//@RequiresPermissions("product:brand:update")
public R update(@Validated(UpdateGroup.class) @RequestBody BrandEntity brand){
    brandService.updateById(brand);
    return R.ok();
}

可以看到，当新增时若携带了品牌id属性，则会触发校验：

{
    "msg": "参数格式校验失败",
    "code": 10001,
    "data": {
        "brandId": "新增不能指定id"
    }
}

当修改时若未携带品牌id属性，也会触发校验：

{
    "msg": "参数格式校验失败",
    "code": 10001,
    "data": {
        "brandId": "修改时必须指定id"
    }
}

注意：

实体中没有加分组的属性，在指定了分组校验后不会生效，只会在不指定分组的情况下才会生效。

四、自定义校验

4.1 编写自定义校验注解

需要遵循JSR303规范，必须至少包含message()、groups()、payload()三部分。

创建自定义注解@ListValue：

/**
 * 自定义校验注解
 */
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class })  // 指定自定义校验器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })   // 指定可使用位置
@Retention(RUNTIME)     // 可以在运行时获取到
public @interface ListValue {
    /**
     * 指定校验失败的提示信息
     *      默认在 ValidationMessages_zh_CN.properties 文件中
     * @return
     */
    String message() default "{com.maomaochong.common.valid.ListValue.message}";
    /**
     * 指定分组信息
     * @return
     */
    Class<?>[] groups() default { };
    /**
     * 负载信息
     * @return
     */
    Class<? extends Payload>[] payload() default { };
    /**
     * 可接受的值
     * @return
     */
    int[] vals() default {};
}

4.2 编写自定义校验器

自定义的校验器需要实现ConstraintValidator<A extends Annotation, T>接口，并指定对应泛型：

泛型一：指定对应关联的自定义注解

泛型二：指定支持的处理目标类型

/**
* 自定义校验器
*/
public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {
private Set<Integer> set = new HashSet<>();
/**
* 初始化方法
* @param constraintAnnotation
*/
@Override
public void initialize(ListValue constraintAnnotation) {
   // 获取允许的值
   int[] vals = constraintAnnotation.vals();
   // 加入集合
   for (int val : vals) {
       set.add(val);
   }
}
/**
* 判断是否校验成功
* @param value
* @param context
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
   return set.contains(value);
}
}

4.3 关联校验器与自定义注解

在自定义注解中，使用@Constraint(validatedBy = { })来关联自定义注解的校验器。

@Constraint(validatedBy = { ListValueConstraintValidator.class })

注意：

我们可以通过指定多个不同的校验器，来实现对不同类型数据的校验的适配

4.4 使用

  /**
   * 显示状态[0-不显示；1-显示]
   */
  @ListValue(vals = {0, 1}, groups = {AddGroup.class})
  private Integer showStatus;

学习记录

JSR303校验