@valid分组校验，手动触发valid校验

吴巴格

已于 2023-06-17 14:41:17 修改

阅读量4.7k

点赞数 3

分类专栏： springboot 文章标签： java apache 开发语言

于 2023-06-17 14:16:08 首次发布

本文链接：https://blog.youkuaiyun.com/lzq2357639195/article/details/131259458

版权

springboot 专栏收录该内容

12 篇文章

订阅专栏

业务场景：同一个接口，不同的操作的时候，校验的字段是不同的。比如更改状态，对于请假申请审批和撤销，校验的字段不同的时候。
但是呢，常规的通过@valid的注解是无法满足的（请求的时候参数拦截，触发校验规则）。而我的业务场景必须进行手动触发@valid校验

废话不多说，下面直接展示思路与核心相关代码

1.设计思路

本质来说，常规@Valid不满足需求的原因就是：
1.同一个接口，根据type字段来进行触发不同的分组字段校验；
2.手动触发valid分组校验。
补充：我所说的常规@valid是指@Validated(value = {People.Student.class})，代码如下：

    /**
     * <p>@Description: 请求拦截-根据分组进行参数校验 </p >
     * <p>@param [people]</p >
     * <p>@return com.lzq.learn.domain.CommonResult</p >
     * <p>@throws </p >
     * <p>@date 14:37 14:37</p >
     */
    @PostMapping("validByGroup")
    public CommonResult validByGroup(@RequestBody @Validated(value = {People.Student.class}) People people) {
        System.out.println("People 参数：" + people);
        CommonResult commonResult = CommonResult.success(people);
        return commonResult;
    }

2.完整代码展示

2.1 controller代码

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.StrUtil;
import com.lzq.learn.domain.CommonResult;
import com.lzq.learn.domain.People;
import com.lzq.learn.domain.User;
import org.apache.poi.ss.formula.functions.T;
import org.springframework.beans.factory.annotation.Autowired;
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.validation.*;
import javax.validation.groups.Default;
import java.util.List;
import java.util.Set;

@RestController
@RequestMapping("valid")
public class TestValidController {


    @Autowired
    private Validator validator;

    /**
     * <p>@Description: 测试手动触发valid分组校验</p >
     * <p>@param [userList]</p >
     * <p>@return com.lzq.learn.domain.CommonResult</p >
     * <p>@throws </p >
     * <p>@date 15:21 15:21</p >
     */
    @PostMapping("validByHand")
    public CommonResult validByHand(@RequestBody People people) {
        System.out.println("people  参数：" + people);
        String validResult = "";
        List<Class> groupList = CollUtil.newArrayList(Default.class);
        if (StrUtil.equals("student", people.getType())) {
            groupList.add(People.Student.class);
        }
        if (StrUtil.equals("teacher", people.getType())) {
            groupList.add(People.Teacher.class);
        }
        Class[] groupArray = groupList.toArray(new Class[groupList.size()]);
        // 写法1：使用ValidatorFactory 获取Validator对象
        Set<ConstraintViolation<People>> violations = Validation.buildDefaultValidatorFactory().getValidator().validate(people, groupArray);
        // 写法2：从springboot上下文 获取Validator对象
        // Set<ConstraintViolation<People>> violations = validator.validate(people, groupArray);
        validResult = getResultFromValidate(violations);
        CommonResult commonResult = CommonResult.success(validResult);
        return commonResult;
    }


    /**
     * <p>@Description: 对于valid校验结果进行转换结果</p >
     * <p>@param </p >
     * <p>@return </p >
     * <p>@throws </p >
     * <p>@date 13:43 13:43</p >
     */
    public static <T> String getResultFromValidate(Set<ConstraintViolation<T>> violations) {
        if (CollUtil.isEmpty(violations)) {
            return "pass";
        }
        StringBuilder sb = new StringBuilder();
        for (ConstraintViolation<T> violation : violations) {
            sb.append(violation.getPropertyPath()).append(": ").append(violation.getMessage()).append("\n");
        }
        return sb.toString();
    }
    
}

注意：我们需要手动触发，则在controller的接口中，不能加上@valid(或@validated)注解，不然又会走请求拦截，根本走不到我们的controller代码中！

2.2 实体类People代码


import lombok.*;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.io.Serializable;

/**
 * @author x
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class People implements Serializable {

    /**     自定义校验分组        **/
    public interface Student{}
    public interface Teacher{}

    private Long id;

    @NotNull(message = "年龄不能为空")
    private Integer age;

    @NotBlank(message = "个人名称不能为空")
    private String myName;

    @NotBlank(message = "学生名称不能为空", groups = Student.class)
    private String studentName;

    @NotBlank(message = "教师名称不能为空", groups = Teacher.class)
    private String teacherName;

    // dto 字段
    private String type;
}