使用DefaultGroupSequenceProvider实现多字段联合校验

背景

一个beanA大概下面这样，需要根据字段a做查询逻辑，得到的值来判断是否需要对后面的字段进行校验

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class BeanA{
    
    private String a;

    private String b;

    private String c;

    private String d;
}

首先我用正常的validator方式先对这个bean进行了改造，如下

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class BeanA {

    private String a;

    @NotNull(message = "字段b不能为空")
    private String b;

    @NotNull(groups = ValidateAGroup.class, message = "字段c不能为空")
    private String c;

    @NotNull(groups = ValidateBGroup.class, message = "字段d不能为空")
    private String d;

    public interface ValidateAGroup {
    }

    public interface ValidateBGroup {
    }
}

但是这样我只能预先设定需要校验哪个组，不能根据字段a的值进行不同的校验

解决方案

        在网上搜索到可以使用DefaultGroupSequenceProvider来实现多字段联合校验，具体如下

0.先贴一下所有的import

import com.google.common.collect.Lists;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.group.GroupSequenceProvider;
import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;

import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

1.首先实现一个DefaultGroupSequenceProvider的实现类

    /**
     * 校验分组处理器
     */
    public static class BeanASequenceProvider implements DefaultGroupSequenceProvider<BeanA> {

        @Override
        public List<Class<?>> getValidationGroups(BeanA bean) {
            ArrayList<Class<?>> defaultGroupSequence = Lists.newArrayList(BeanA.class); //这里增加默认处理器是必须的
            if (Objects.nonNull(bean)) {  //这里的判空也是必要的
                //这里可以自定义规则想要加哪些组进行校验
                if (Objects.equals(bean.a, "校验ValidateAGroup")) {
                    defaultGroupSequence.add(ValidateAGroup.class);
                }
                if (Objects.equals(bean.a, "校验ValidateBGroup")) {
                    defaultGroupSequence.add(ValidateBGroup.class);
                }
            }
            return defaultGroupSequence;
        }
    }

2.在需要校验的Bean上添加注解

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@GroupSequenceProvider(BeanASequenceProvider.class)
public class BeanA {

    private String a;

    @NotNull(message = "字段b不能为空")
    private String b;

    @NotNull(groups = ValidateAGroup.class, message = "字段c不能为空")
    private String c;

    @NotNull(groups = ValidateBGroup.class, message = "字段d不能为空")
    private String d;

    public interface ValidateAGroup {
    }

    public interface ValidateBGroup {
    }
}

3.校验

import javax.validation.ConstraintViolation;
import javax.validation.Validation;


    public void test() {

        BeanA beanA = new BeanA();
        //把参数设置上

        Set<ConstraintViolation<VideoValidateBean>> validateResults = Validation.buildDefaultValidatorFactory().getValidator().validate(beanA);
        //这个结果就是校验的结果，如果校验都通过了就是空的
    }

过程大概是这样，最后这个bean如下

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@GroupSequenceProvider(BeanASequenceProvider.class)
public class BeanA {

    private String a;

    @NotNull(message = "字段b不能为空")
    private String b;

    @NotNull(groups = ValidateAGroup.class, message = "字段c不能为空")
    private String c;

    @NotNull(groups = ValidateBGroup.class, message = "字段d不能为空")
    private String d;

    public interface ValidateAGroup {
    }

    public interface ValidateBGroup {
    }

    /**
     * 校验分组处理器
     */
    public static class BeanASequenceProvider implements DefaultGroupSequenceProvider<BeanA> {

        @Override
        public List<Class<?>> getValidationGroups(BeanA bean) {
            ArrayList<Class<?>> defaultGroupSequence = Lists.newArrayList(BeanA.class); //这里增加默认处理器是必须的
            if (Objects.nonNull(bean)) {  //这里的判空也是必要的
                //这里可以自定义规则想要加哪些组进行校验
                if (Objects.equals(bean.a, "校验ValidateAGroup")) {
                    defaultGroupSequence.add(ValidateAGroup.class);
                }
                if (Objects.equals(bean.a, "校验ValidateBGroup")) {
                    defaultGroupSequence.add(ValidateBGroup.class);
                }
            }
            return defaultGroupSequence;
        }
    }
}

这样就做到了多字段的联合校验，这种方式支持级联校验，自定义校验等。validator的基础使用我就不写了，下面的参考文章里有。

参考文章

1.validator的常用注解

2.validator的常规使用

3.validator的深入了解

4.多字段联合校验逻辑的解决办法

5.多字段联合校验demo