Java —— 自定义JSR303校验

最新推荐文章于 2024-03-08 21:24:55 发布

原创最新推荐文章于 2024-03-08 21:24:55 发布 · 809 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java 专栏收录该内容

130 篇文章

订阅专栏

本文介绍了如何在Java应用中利用JSR303进行接口参数校验，并展示了如何自定义校验方法以验证cron表达式的合法性。首先，引入了Spring Boot的validation依赖，然后通过创建自定义Validator实现cron校验逻辑。接着，定义了自定义注解`CronValue`用于标记需要校验的字段。最后，通过全局异常处理器处理校验失败的情况。这样，便能有效地扩展JSR303的校验功能，实现对复杂业务场景的支持。

JSR303

JSR303技术，JSR-303 是JAVA EE 6 中的一项子规范，常用于接口入参合法性的校验。使用方式可参考

Java —— 实体属性入参非空校验https://blog.youkuaiyun.com/xue_xiaofei/article/details/118303844?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522165078097716782246489271%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=165078097716782246489271&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_ecpm_v1~rank_v31_ecpm-5-118303844.article_score_rank_blog&utm_term=notnull&spm=1018.2226.3001.4450

但我们注意到valid提供的校验方法有限，如果我们想自定义校验方法应该如何处理呢？接下来就以校验cron合法性为例，进行详细说明。

添加依赖

建议使用spring下的依赖，而非javax, 版本使用当前spring版本即可。

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
                <version>${spring-boot.version}</version>
            </dependency>

自定义Validator进行cron合法性校验

核心校验逻辑。

public class CronValueConstraintValidator implements ConstraintValidator<CronValue,String> {

    @Override
    public void initialize(CronValue constraintAnnotation) {
    }

    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (!StringUtils.isEmpty(s)) {
            return CronExpression.isValidExpression(s);
        }
        return true;
    }
}

自定义cron校验注解

自定义注解。

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {CronValueConstraintValidator.class})
public @interface CronValue {
    String message() default "cron表达式不合法";

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

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

    int [] vals() default {};
}

全局异常捕捉

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public void handlerMethodArgument(HttpServletRequest request, HttpServletResponse response, MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        String msg = fieldErrors.get(0).getDefaultMessage();
        log.error("校验失败，信息为{}", msg);
    }