validation好用的Java数据校验工具

LB_bei

已于 2024-05-17 16:59:24 修改

阅读量550

点赞数 4

分类专栏： skill 文章标签： java 前端服务器

于 2024-05-17 14:26:54 首次发布

本文链接：https://blog.csdn.net/LB_bei/article/details/139003243

版权

skill 专栏收录该内容

42 篇文章 1 订阅

订阅专栏

1.概述

Validation 是一种检查机制，用来验证数据的有效性和完整性。其目的是确保数据满足特定的条件或规则，从而防止无效或恶意数据进入系统。

2.使用

环境：spring boot3

2.1 导入依赖

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

2.2 添加注解

首先要在controller上添加 @Validated 开启验证，然后如果是传入的参数验证可以直接在参数前加验证注解；

如果是传入的对象，则需要在对象前加 @Validated，然后在实体类中某个需要验证的字段上添加验证注解；

@Validated
@Tag(name = "用户相关接口")
public class UserController {

    public Result updateUser(@RequestBody @Validated User user) {}

    public ResponseResult updateUserAvatar(@RequestParam @URL String avatar) {}
}

public class User {
    @NotEmpty
    @Size(max = 10,min = 1)
    private String nickname;
    @Email
    private String email;
}

3.分组校验

某个实体类如果参与多个方法的校验，就需要将校验条件分组

@Data
public class Category {

    @TableId(value = "id", type = IdType.AUTO)
    @NotNull(groups = Update.class)
    private Integer id;//主键ID

    @NotEmpty(groups = {Update.class,Add.class})
    private String categoryName;//分类名称

    @NotEmpty
    private String categoryAlias;//分类别名
    
    public interface Add extends Default {

    }
    public interface Update extends Default {

    }
}

如果字段不指定分组，则归属于默认分组，需要该字段的分组需要继承Default

public Result add(@RequestBody @Validated(Category.Add.class) Category category){}

public Result update(@RequestBody @Validated(Category.Update.class) Category category){}

4.自定义验证注解

有的时候提供的注解满足不了验证需求，我们可以自己自定义注解

举例：

import com.luobei.validation.StateValication;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;

/**
 * @author : luobei
 * @date : 2024/5/17 15:58
 */
@Documented                                         //在生成文档时包含这个注解
@Constraint(validatedBy = {StateValication.class})  //指定提供校验规则的类
@Target({ElementType.FIELD})                        //定义注解的应用目标,这里注解针对类的属性
@Retention(RetentionPolicy.RUNTIME)                 //注解会在运行时可用
public @interface State {
    //校验失败的后的信息
    String message() default "state参数的值只能是已发布或者草稿";
    //指定分组
    Class<?>[] groups() default {};
    //负载
    Class<? extends Payload>[] payload() default {};
}

定义验证规则：

import com.luobei.annotation.State;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

/**
 * @author : luobei
 * @date : 2024/5/17 16:48
 * @return: 返回false校验不通过，反之亦然
 */
public class StateValication implements ConstraintValidator<State,String> {

    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        //提供校验规则
        if(value == null){
            return false;
        }
        if(value.equals("已发布")||value.equals("草稿")){
            return true;
        }
        return false;
    }
}