Java基于JSR303的注解校验及自定义校验

 

目录

 一、简单异常数据处理

 二、改进校验方法

三、测试

四、分组校验

 五、自定义校验规则

---

 一、简单异常数据处理

1.1、引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

1.2、我们想要对前台传递的品牌数据进行校验，其类定义如下：

package com.atguigu.gulimall.product.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import java.io.Serializable;
import java.util.Date;
import lombok.Data;
import org.hibernate.validator.constraints.URL;

import javax.validation.constraints.*;


/**
 * 品牌
 *
 * @author cy
 * @email 364328541@qq.com
 * @date 2022-10-17 11:51:55
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

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

}

1.3、编写一个测试controller,要想对BrandEntity实体类中的属性进行校验，我们不仅需要在实体类对应字段加上如下注解（假设只校验这四个字段）

• @NotNull：不能为null，但可以为empty
• @NotEmpty：不能为null，而且长度必须大于0
• @NotBlank：只能作用在String上，不能为null，而且调用trim()后，长度必须大于0
• 注意在使用@NotBlank等注解时，一定要和@valid一起使用，不然@NotBlank不起作用

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

@NotEmpty
@URL(message = "logo必须是一个合法的url地址")
private String logo;

@NotEmpty
@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母")
private String firstLetter;

@NotNull
@Min(value = 0,message = "排序必须大于等于0")
private Integer sort;

还需要在方法形参位置的实体对象前加@Valid注解，如下所示。

    @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand){
        brandService.save(brand);
        return R.ok();
    }

1.4、编写单个方法校验规则，修改controller，代码如下

@RequestMapping("/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();
    }

这样编写controller,只能处理单个请求，并且每个方法都需要在形参上加上 BindingResult result对象后还要编写相应的处理逻辑。不太实用，还对返回给前端的错误编码和错误信息没有规范化。因此我们可以尝试改进。

 二、改进校验方法

2.1、编写枚举类，对相应的错误编码和错误信息规范化

/**
 * 错误码和错误信息定义类
 * 1. 错误码定义规则为 5 为数字
 * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
 * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
 * 错误码列表：
 * 10: 通用
 * 001：参数格式校验
 * 11: 商品
 * 12: 订单
 * 13: 购物车
 * 14: 物流
 * @author cy
 * @create 2022-10-26 20:13
 */
public enum BizCodeEnum {

    UNKNOWN_EXCEPTION(10000,"系统未知异常"),
    VALID_EXCEPTION(10001,"参数格式检验失败");

    private Integer code;
    private String msg;

    BizCodeEnum(Integer code,String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

2.2、修改controller,移除形参中的BindingResult result对象

    @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand){
        brandService.save(brand);
        return R.ok();
    }

2.3、编写异常处理类

• 我们可以配合@RestControllerAdvice和@ExceptionHandler实现对异常数据的统一处理。
• @RestControllerAdvice是一个组合注解，由@ControllerAdvice、@ResponseBody组成，而@ControllerAdvice继承了@Component，因此@RestControllerAdvice本质上是个Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法。
• @ExceptionHandler：用于指定异常处理方法。当与@RestControllerAdvice配合使用时，用于全局处理控制器里的异常。
• 详细描述可参考下面的博主，写的很详细SpringBoot常用注解@RestControllerAdvice_user2025的博客-CSDN博客_restcontrolleradvice

package com.atguigu.gulimall.product.exception;

import com.atguigu.common.exception.BizCodeEnum;
import com.atguigu.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

/**
 * @author cy
 * @create 2022-10-26 19:57
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {

    @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(BizCodeEnum.VALID_EXCEPTION.getCode(),BizCodeEnum.VALID_EXCEPTION.getMsg()).put("data",errorMap);
    }

    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable) {
        return R.error(BizCodeEnum.UNKNOWN_EXCEPTION.getCode(), BizCodeEnum.UNKNOWN_EXCEPTION.getMsg());
    }
}

三、测试

3.1 使用postman发送post请求测试

四、分组校验

当我们需要对某些字段进行校验的时候，它可能有不同的校验规则。举个简单的例子：新增品牌时，品牌id不需要携带，由后台自动生成，但修改品牌时，必须要求携带品牌id。对于上述情况，我们需要对品牌id进行分组校验，具体校验方法如下：

4.1、新增校验分组

         如上所示此处我们只需要对每个分组编写一个接口，并不需要编写实现类。

4.2、修改品牌实体类中的brandId的校验规则

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

         如上所示，我们需要在校验规则后面加上分组信息，如groups = {UpdateGroup.class}，即指定该字段在那种条件下需要校验，那种条件下不需要校验。一个校验规则可以同时属于多个校验分组，如下所示：

@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
private String name;

4.3、修改controller

@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
    brandService.save(brand);
    return R.ok();
}

        我们需要将@Valid注解改为@Validated注解，因为@Validated每天groups属性，没办法分组校验，而@Validated注解有，如上所示。

 4.4、使用postman测试

        如上所示，测试通过，但我们发现，没有加上校验分组的校验规则失效了。分组校验下，默认没有指定分组的校验注解@NotBlank，在分组校验情况下不生效，只会在@Validated注解条件下生效。

        我们需要对每个校验规则加上校验分组，假设只校验如下三个字段。

@NotBlank(groups = AddGroup.class)
@URL(message = "logo必须是一个合法的url地址",groups = {AddGroup.class,UpdateGroup.class})
private String logo;

@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
private String name;

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

从测试结果可以看出，logo字段校验生效。

 五、自定义校验规则

5.1、新增校验规则

        我们想要对显示状态进行校验，校验规则是，只能让其传入0或1。

@ListValue(values={0,1})
private Integer showStatus;

5.2、编写自定义校验注解@ListValue

package com.atguigu.common.valid;

import javax.validation.Constraint;
import javax.validation.Payload;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @author cy
 * @create 2022-10-27 10:43
 */
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

    String message() default "{com.atguigu.common.valid.ListValue.message}";

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

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

    int[] values() default { };
}

5.3、编写一个自定义的校验器

package com.atguigu.common.valid;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * @author cy
 * @create 2022-10-27 10:52
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set = new HashSet<>();

    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] values = constraintAnnotation.values();
        for (int value : values) {
            set.add(value);
        }
    }

    /**
     * 判断校验是否成功
     * @param value 需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

5.4、关联自定义的校验器和自定义的校验注解

@Constraint(validatedBy = {ListValueConstraintValidator.class})可以指定多个不同的校验器，适配不同类型的校验。

 5.5、自定义校验信息（可以使用默认）

（1）在resources下新建一个ValidationMessages.properties，添加自定义消息

（2）修改自定义注解中的message

String message() default "{com.atguigu.common.valid.ListValue.message}";

5.6、测试