SpringBoot 实现分组校验

实现的需求是：
当enabled字段为true时，则校验某些字段，否则不校验

效果图
开启时校验

关闭时，不校验

实现步骤

引入依赖

   <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-validationartifactId>
            <version>2.7.1version>
        dependency>

1·定义分组
我这里将分组（WhenEnabledIsOn）直接定义在实体类中

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import org.hibernate.validator.group.GroupSequenceProvider;
import org.jfjy.ecctv.core.jtr.web.api.validation.CustomSequenceProvider;


import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.io.Serializable;

/**
 * 白名单配置对象
 */
@GroupSequenceProvider(value = CustomSequenceProvider.class)
@TableName("whitelist_config")
@Data
public class WhitelistConfig implements Serializable {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    @NotNull(message = "id不能为空。")
    private Integer id;
    
    @ApiModelProperty("是否开启白名单功能；0-关闭；1-开启")
    @NotNull(message = "是否开启白名单功能不能为空。")
    private Integer enabled;

    /**
     * 非白名单客户端持续连接次数
     */
    @ApiModelProperty("非白名单客户端持续连接次数")
    @NotNull(message = "是否开启白名单功能不能为空。" , groups = {WhenEnabledIsOn.class})
    private Integer accessLimitTimes;
    
    /**
     * 白名单开启的分组
     */
    public interface WhenEnabledIsOn {

    }

}

2·定义 自定义分组校验类

import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
import WhitelistConfig;

import java.util.ArrayList;
import java.util.List;

/**
 * 自定义分组校验
 * @author zhout
 */
public class CustomSequenceProvider implements DefaultGroupSequenceProvider<WhitelistConfig> {

    //自定义校验

    @Override
    public List<Class<?>> getValidationGroups(WhitelistConfig whitelistConfig) {
        List<Class<?>> defaultGroupSequence = new ArrayList<>();
        //必须将被校验对象添加到默认分组校验列表中
        defaultGroupSequence.add(WhitelistConfig.class);
        if (whitelistConfig == null) {
            return defaultGroupSequence;
        }
        //根据是否开启白名单功能 决定是否添加特定分组
        Integer enabled = whitelistConfig.getEnabled();
        if (whitelistConfig != null){
            if(1 == enabled) {
                defaultGroupSequence.add(WhitelistConfig.WhenEnabledIsOn.class);
            }
        }
        return defaultGroupSequence;
    }
}

3`为接口方法入参标记 @Validated注解

 	@ApiOperation(value = "编辑指定白名单IP")
    @PutMapping("")
    public void remove(@RequestBody @Validated Whitelist whitelist)  {
        ...
    }

扩展
Service层使用Validated
如果定义了service接口和实现，并且想让校验在Service方法上生效，则需要在以下3处地方增加注解：

1. Service接口类
2. Service接口方法
3. Service接口入参

比如：
Service接口

@Validated
public interface IBlacklistService extends IService<Blacklist> {

    @Validated({BlacklistGroups.Add.class})
    boolean addBlacklist(@Valid Blacklist blacklist) throws Exception;
}

至于Service实现类则一个校验注解都不用加即可生效，所以controller层的校验注解这时就可以删除了。

结束