Spring validation参数校验之自定义校验规则及编程式校验等进阶篇

JingAi_jia917

已于 2024-04-22 15:27:02 修改

阅读量1.9k

点赞数 34

文章标签： spring java 后端

于 2024-04-02 10:19:40 首次发布

本文链接：https://blog.csdn.net/JingAi_jia917/article/details/137255142

版权

Spring validation参数校验系列

1、Spring validation参数校验基本使用

2、Spring validation参数校验之自定义校验规则及编程式校验等进阶篇

3、【源码】Spring validation参数校验原理解析之Controller控制器参数校验中@RequestBody参数校验实现原理

 4、【源码】Spring validation参数校验原理解析之Controller控制器参数校验中@ModelAttribute及实体类参数校验实现原理

 5、【源码】Spring validation参数校验原理解析之基本类型参数及Service层方法参数校验实现原理

 6、【源码】Spring validation校验的核心类ValidatorImpl、MetaDataProvider和AnnotationMetaDataProvider源码分析

 7、Spring validation参数校验高级篇之跨参数校验Cross-Parameter及分组序列校验@GroupSequenceProvider、@GroupSequence

8、【源码】Spring validation参数校验之跨参数校验Cross-Parameter原理分析

9、【源码】Spring validation参数校验之分组序列校验@GroupSequenceProvider、@GroupSequence的实现原理

前言

限于篇幅，在上一篇Spring validation参数校验基本使用-CSDN博客只介绍了Spring validation的基本使用。然而有些时候，自带的校验规则并无法完全满足业务的需求，例如：性别只能男或女、数据类型只能特定的几种类型等。针对这种场景，Spring validation提供了自定义校验规则。

自定义校验规则

以下以性别为例分享如何自定义校验规则。

1、定义性别枚举

1.1 BaseEnum.java

package com.jingai.validation.custom;

public interface BaseEnum {
    String getCode();
    String getDisplay();
}

1.2 GenderEnum.java

package com.jingai.validation.custom;

public enum GenderEnum implements BaseEnum {

    male("1", "男"),
    female("0", "女");

    private String code;
    private String display;

    private GenderEnum(String code, String display) {
        this.code = code;
        this.display = display;
    }

    @Override
    public String getCode() {
        return this.code;
    }

    @Override
    public String getDisplay() {
        return this.display;
    }
}

2 、自定义枚举类型的校验规则

package com.jingai.validation.custom;

import org.springframework.util.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * 验证给定的String值是否满足InEnum注解中的约束
 */
public class InEnumValidator implements ConstraintValidator<InEnum, String> {

    private Class<? extends BaseEnum> enumType;

    /**
     * 初始化方法可以获得该校验器对应的注解，从而获取注解中的信息。在校验方法调用前会调用
     */
    @Override
    public void initialize(InEnum constraintAnnotation) {
        enumType = constraintAnnotation.enumType();
    }

    /**
     * 校验。成功返回true，失败返回false
     */
    @Override
    public boolean isValid(String str, ConstraintValidatorContext constraintValidatorContext) {
        if(!StringUtils.hasText(str)) {
            return true;
        }
        if(enumType == null || !enumType.isEnum()) {
            return false;
        }
        for (BaseEnum e :enumType.getEnumConstants()){
            if(e.getCode().equals(str)) {
                return true;
            }
        }
        return false;
    }
}

3、自定义校验规则注解

package com.jingai.validation.custom;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解，判断是否值在指定的枚举中
 */
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
// 标记由哪个类来执行校验逻辑，该类需要实现ConstraintValidator接口
@Constraint(validatedBy = InEnumValidator.class)
public @interface InEnum {
    /**
     * 枚举类型
     */
    Class<? extends BaseEnum> enumType();

    String message() default "值不在枚举类型中";

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

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

}

4、在参数中添加自定义的@InEnum注解。

package com.jingai.validation.vo;

import com.jingai.validation.custom.GenderEnum;
import com.jingai.validation.custom.InEnum;
import com.jingai.validation.groups.UserValidatedGroup;
import lombok.Data;

import javax.validation.constraints.*;

@Data
public class UserVo {

    @NotNull(message = "用户id不能为null", groups = {UserValidatedGroup.Query.class, UserValidatedGroup.Update.class})
    @Min(value = 1, message = "用户id无效")
    private Integer id;

    @NotBlank(message = "用户名称不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String name;

    @NotBlank(message = "性别不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @InEnum(enumType = GenderEnum.class, message = "性别不在枚举范围中", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String gender;

    @NotNull(message = "年龄不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Min(value = 18, message = "年龄必须大于18岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Max(value = 200, message = "年龄必须小于200岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private Integer age;

    @NotBlank(message = "手机号码不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Pattern(regexp = "^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手机号码格式错误")
    private String phone;
}

5、在Controller的方法中，开启数据校验功能。

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("adduser")
    public Map<String, Object> add(@RequestBody @Validated(value = UserValidatedGroup.Create.class) UserVo user) {
        // 省略其他代码
        return ResponseUtil.success();
    }

}

访问adduser，效果如下：

集合校验

在某些场景下，需要使用集合接收前端传递的参数，并对集合中的每个对象都进行参数校验。但如果只是用List接收并不会进行校验。针对这种场景，可以自定义一个List，代码如下：

1、自定义一个List

package com.jingai.validation.custom;

import lombok.experimental.Delegate;

import javax.validation.Valid;
import java.util.ArrayList;
import java.util.List;

public class ValidList<T> implements List<T> {

    @Delegate
    @Valid
    public List<T> list = new ArrayList<>();

}

@Delegate为Lombok的注解，简单理解就是该类拥有该属性的所有方法，这样类实现了List接口，便无需重写接口的方法。当调用该类的方法时，实际执行的是该属性的对应方法。

2、在Controller中使用自定义的集合接收数据

    @RequestMapping("addusers")
    public Map<String, Object> addUsers(@RequestBody @Validated(value = UserValidatedGroup.Create.class) ValidList<UserVo> list) {
        int rs = userService.saveBatch(list);
        return ResponseUtil.success(rs);
    }

访问接口后，效果如下：

校验失败时，抛NotReadablePropertyException异常，而在该异常中，没有明细信息，无法有效的进行提示。为了更清晰的提示，可以通过编程式校验进行改进。

编程式校验

Spring-validation除了支持注解方式校验以外，还支持编程式注解。以上面集合校验为例：

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

@RestController
public class UserController {

    @Resource
    private Validator validator;

    @RequestMapping("addusers2")
    public Map<String, Object> addUsers2(@RequestBody List<UserVo> list) {
        for (UserVo user : list) {
            Set<ConstraintViolation<UserVo>> validate = validator.validate(user, UserValidatedGroup.Create.class);
            // 通过校验，validate为空，否则validate包含未通过的校验项
            if(!validate.isEmpty()) {
                throw new ConstraintViolationException(validate);
            }
        }
        return ResponseUtil.success();
    }

}

参数还是通过普通的List进行接收，返回变量List集合中的信息，逐个进行编码校验，当校验失败时，抛ConstraintViolationException异常。

访问接口，效果如下：

自定义通用的校验

使用编程式校验对代码侵入性比较强，可以通过AOP进行优化。下面以List集合校验为例，其他类型的校验也可以采用相似的处理方式。

1、自定义注解

package com.jingai.validation.custom;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestListValidated {
    // 校验组
    Class<?>[] value() default {};
}

2、自定义Aspect，拦截方法添加@RequestListValidated的方法，遍历方法的参数，找出List类型的参数并遍历集合中的对象，进行参数校验，如果校验失败，抛出异常。

package com.jingai.validation.custom;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import java.util.List;
import java.util.Set;

/**
 * 请求参数中包含List集合对象的参数校验
 */
@Aspect
@Component
public class RequestListValidAspect {

    @Resource
    private Validator validator;

    @Before("@annotation(RequestListValidated)")
    public void beforeMethod(JoinPoint joinPoint) {
        MethodSignature methodSignature = (MethodSignature)joinPoint.getSignature();
        RequestListValidated declaredAnnotation = methodSignature.getMethod().getDeclaredAnnotation(RequestListValidated.class);
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if(arg == null)
                continue;
            if(arg instanceof List && ((List<?>)arg).size() > 0) {
                List<?> list = (List<?>)arg;
                for(int i = 0 ; i < list.size() ; i ++) {
                    Set<? extends ConstraintViolation<?>> validate = validator.validate(list.get(i), declaredAnnotation.value());
                    if(!validate.isEmpty()) {
                        throw new ConstraintViolationException(validate);
                    }
                }
            }
        }
    }


}

3、在需要校验的类中添加@RequestListValidated注解

    @RequestListValidated(value = UserValidatedGroup.Create.class)
    @RequestMapping("addusers3")
    public Map<String, Object> addUsers3(@RequestBody List<UserVo> list) {
        // 省略其他代码
        return ResponseUtil.success();
    }

访问addusers3接口时，效果如下：

总结

本次分享的Spring validation进阶篇就到这边，相信看《Spring validation参数校验系列》文章，对Spring validation会有一个完整全新的了解，后面的文章会带大家从源码的角度分析Spring validation实现的原理。也推荐大家在项目中使用。

如果大家有更优雅的处理方式，欢迎在评论区一起交流探讨下吧。

如果有需要源码的，可以在评论区留下邮箱，看到后第一时间回复。

JingAi_jia917

关注

34
点赞
踩
36

收藏

觉得还不错? 一键收藏
1
评论
Spring validation参数校验之自定义校验规则及编程式校验等进阶篇

本篇介绍Spring validation参数校验自定义校验规则、集合校验以及编程式校验，在此基础上，结合AOP封装了List集合对象校验。
复制链接

扫一扫