自定义注解校验
前面的文章中,我们都是采用validate机制自带的条件注解来进行参数校验,
比如@Min、@NotNull…等等,
这些的确可以帮我们省去一部分的参数校验,可惜还有一部分的业务校验规则并不是如这般简单的,
比如前端传了一个日期过来,业务规则要求这个日期必须至少提前10天。
这样的校验规则就无法使用validate自带的条件注解来进行校验了,此时就需要我们自定义校验注解来实现校验规则。
现在,我们一起来看看自定义注解校验的用法;
首先定义一个校验注解
@Target({ElementType.FIELD})
// 可以用来修饰注解,是注解的注解,称为元注解,其他信息可参考:https://blog.csdn.net/qq_30326609/article/details/112360631
@Retention(RetentionPolicy.RUNTIME)
@Documented
// 指定自定义的校验规则处理器
@Constraint(validatedBy = {MyDateValidHandler.class})
public @interface MyDateValid {
String message() default "日期校验失败";
Class<?>[] groups() default {};
// 预加载,该属性必须要有,否则触发校验机制时会报错
Class<? extends Payload>[] payload() default {};
}
自定义校验规则处理器
@Slf4j
public class MyDateValidHandler implements javax.validation.ConstraintValidator<MyDateValid, Date> {
@Override
public void initialize(MyDateValid constraintAnnotation) {
// 初始化方法
}
@Override
public boolean isValid(Date date, ConstraintValidatorContext constraintValidatorContext) {
if(date == null){
return true;
}
double diffDays = (1.0 * System.currentTimeMillis() - date.getTime()) / (3600000 * 24);
return diffDays >= 10;
}
}
测试
@PostMapping("/dataTypeValidTest")
public DataTypeValidDTO dataTypeValidTest(@RequestBody @Validated DataTypeValidDTO dto){
return dto;
}
编程式校验
前面的例子中,都是通过@validated或@Valid注解来触发的,而且都是在controller层面进行校验,那假如我们想要在service层面进行校验呢,想要手动触发校验呢,应该要怎么做呢?
下面我们一起来看看编程式校验,它可以使我们在其他地方进行手动触发校验,实现步骤很简单,仅需要一个工具类即可,如下所示:
@Slf4j
@Component
public class ValidUtil<T> {
@Autowired
private javax.validation.Validator globalValidator;
public String valid(T t){
Set<ConstraintViolation<T>> validateRes = globalValidator.validate(t);
if(CollectionUtils.isEmpty(validateRes)){
return "";
}
StringBuilder errorMsg = new StringBuilder();
errorMsg.append("校验失败:");
for(ConstraintViolation<T> validateResTmp : validateRes){
errorMsg.append(validateResTmp.getMessage()).append(";");
}
return errorMsg.toString();
}
}
测试代码如下:
@Autowired
private HelloService helloService;
@PostMapping("/userInvokeValidTest")
public DataTypeValidDTO userInvokeValidTest(@RequestBody DataTypeValidDTO dto){
return helloService.userInvokeValidTest(dto);
}
@Service
@Slf4j
public class HelloService {
@Autowired
private ValidUtil validUtil;
public DataTypeValidDTO userInvokeValidTest(DataTypeValidDTO dto){
dto.setValidMsg(validUtil.valid(dto));
return dto;
}
}
好了,到这里涉及到的@Validated和@Valid注解校验机制的常用方式就讲完了,感谢大家的聆听,拜拜
示例源代码:https://download.csdn.net/download/weixin_43846505/87982259