SpringValidation自定义注解以及分组校验

水深无声 2024-02-05 20:47 14阅读 0赞

> SpringValidation的参数校验使用可参考：[【SpringMVC应用篇】Spring Validation 参数校验-CSDN博客][SpringMVC_Spring Validation _-CSDN]

**目录**

1. 引入依赖

2. 自定义注解校验

2.1 创建Validation类

2.2 创建注解对象

2.3 使用注解

3. 分组校验

3.1 实体类内部定义接口

3.2 在参数上指定分组

--------------------

**1. 引入依赖**

<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-validation</artifactId>
       <version>3.2.0</version>
    </dependency>

## 2. 自定义注解校验 ##

> 使用场景：已有的注解不能满足所有的校验需求，特殊的情况需要自定义校验(自定义校验注解)。 实现自定义注解可以通过模仿，SpringValidation提供的其他注解进行改写。

举例说明：

我有一个实体类，其中一个参数**state**需要接收到前端数据后进行校验（要求该参数只能是 已发布 或者 草稿）。而SpringValidation提供的注解无法满足我的需求，此时便需要自定义注解。

### 2.1 创建Validation类 ###

> **注意：**该类需要实现 **ConstraintValidator**接口，并实现 **isValid( )**方法。方法内即是校验规则， 我这里只是提供参考。请自行根据业务需求更改。

import jakarta.validation.ConstraintValidator;
    import jakarta.validation.ConstraintValidatorContext;
    
    /**
     * ConstraintValidator<State, String>前一个代表需要校验的注解，后一个代表校验类型
     */
    public class Validation implements ConstraintValidator<State, String> {
        /**
         *
         * @param value 将来要校验的数据
         * @param constraintValidatorContext
         * @return
         */
        @Override
        public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
            //校验规则
            if (value == null) {
                return false;
            }
            if (value.equals("已发布") || value.equals("草稿")) {
                return true;
            }
            return false;
        }
    }

### 2.2 创建注解对象 ###

> 注解名称，请根据自己业务需求更改。

import jakarta.validation.Constraint;
    import jakarta.validation.Payload;
    
    import java.lang.annotation.*;
    
    @Documented //元注解，代表可在文档显示
    @Constraint(
            validatedBy = {Validation.class} //指定提供校验规则的类,该类需要自己指定
    )
    //元注解，代表注解适用的对象（方法、字段、注解、类、属性）
    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME) //元注解，代表注解的作用范围
    public @interface State {
        //报错提示
        String message() default "state参数只能是已发布或者草稿";
    
        Class<?>[] groups() default {};
    
        Class<? extends Payload>[] payload() default {};
    }

### 2.3 使用注解 ###

找到对应的实体类，在需要校验的参数上添加该注解即可。例如我这里需要对state进行校验。

![e4b2be4319d040b780a0988c619a4c0d.png][]

## 3. 分组校验 ##

**分组校验**是指把校验项进行归类分组，在完成不同的功能的时候，校验指定组中的校验项。

分组校验常用于增加和修改操作时对数据的校验。

> 分组校验的 **流程：**
> 
> **1.**定义分组
> 
> **2.**定义校验项时指定归属的分组
> 
> **3.**校验时指定要校验的分组

### ![11d4508b4c0041ada45753f586064d5a.png][] ###

### 3.1 实体类内部定义接口 ###

![93506c74d94c4379a97e359cda8c0404.png][]

### 3.2 在参数上指定分组 ###

![3d5107d9fe9f4d5d99b3ba15f278d022.png][]

**3.3 给@Validated注解赋值**

![e41d3d3fa2144d4e9f615178bd1acf26.png][]

> **注意：** 如果**在方法上对参数进行校验，需要在类上添加@Validated注解**。如果在**实体类中对成员遍历进行校验，需要在使用到这个类的接口方法中添加@Validated注解**。

**最后最后！！！各位看官觉得有用就收藏、点赞、评论一下吧。我看到问题后，我会第一时间回复的！**

[SpringMVC_Spring Validation _-CSDN]: https://blog.csdn.net/qq_45297578/article/details/119249148?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522170391903216800222846027%2522%252C%2522scm%2522%253A%252220140713.130102334..%2522%257D&request_id=170391903216800222846027&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~all~sobaiduend~default-2-119249148-null-null.142%5Ev99%5Epc_search_result_base7&utm_term=SpringValidation&spm=1018.2226.3001.4187
[e4b2be4319d040b780a0988c619a4c0d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/3a5e4640385c43babd920fd348b09e33.png
[11d4508b4c0041ada45753f586064d5a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/5c4610014f314872b1422ebc24747aa2.png
[93506c74d94c4379a97e359cda8c0404.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/e7d35125e668425fa89dbaf5a167acdc.png
[3d5107d9fe9f4d5d99b3ba15f278d022.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/78d156644cfc4e7588b01c683c35e1d7.png
[e41d3d3fa2144d4e9f615178bd1acf26.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/2b48877f16064c0f8e0460f2cb543cd0.png