spring boot3.0自定义校验注解：文章状态校验示例

文章目录

• [Spring Boot 自定义校验注解：状态校验示例](#Spring Boot 自定义校验注解：状态校验示例)
• [一、创建 `@State` 注解](#一、创建 @State 注解)
• • 步骤：
  • • [1. 创建自定义注解：](#1. 创建自定义注解：)
    • [2. 实现校验逻辑：](#2. 实现校验逻辑：)
• [二、 实现自定义校验](#二、 实现自定义校验)
• • 步骤:
  • • [1. 在实体类中使用自定义校验注解 `@State`：](#1. 在实体类中使用自定义校验注解 @State：)
    • [2. 添加 `@State` 注解：](#2. 添加 @State 注解：)
• 总结
• • 主要步骤回顾：
  • 优势

Spring Boot 自定义校验注解：状态校验示例

本文详细介绍如何在 Spring Boot 中自定义校验注解，并以状态校验为例进行讲解，力求简洁明了，易于理解和实践。

• 在实际应用中，标准的注解校验可能无法满足所有需求，尤其是在处理一些特殊的校验场景时。例如，可能需要根据业务逻辑对字段进行复杂的组合校验，或是在运行时动态决定校验规则。在这种情况下，使用现有的注解校验就显得力不从心。因此，我们可以通过自定义校验注解，来实现更灵活和精确的校验逻辑。这不仅能够提高代码的可读性和可维护性，还能使我们的应用更好地应对各种复杂的业务需求。

---

下面是对"创建State注解"部分的创建以及教学

---

一、创建 @State 注解

在现有的 Spring Boot 项目中，我们可能需要实现一些业务特定的校验逻辑，例如，确保一个字段的状态值满足特定条件。为此，我们可以创建一个自定义的 State 注解。这个注解将用于标识某个字段的状态，并通过自定义的校验逻辑来确保其值的合法性和有效性。

步骤：

1. 创建自定义注解：

在项目的合适位置（如 com.example.validation 包下），新建一个 State 注解类。该注解可以接收多个参数，例如允许的状态值。

package com.YJZE.anno;

import com.YJZE.validation.StateValidation;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;

import java.lang.annotation.*;

@Documented//元注解
@Target( ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {StateValidation.class})
public @interface State {
    String message() default "state参数只能是草稿或者已发布";

    Class<?>[] groups() default {};
    //负载 获取到State注解的附加信息
    Class<? extends Payload>[] payload() default {};
}

2. 实现校验逻辑：

创建一个名为 StateValidator 的类， 实现 ConstraintValidator<State, String> 接口。在这个类中定义具体的校验逻辑，以验证字段的值是否在允许的状态值中。

package com.YJZE.validation;

import com.YJZE.anno.State;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

public class StateValidation implements ConstraintValidator<State,String> {
    /**
     *
     * @param s
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if(s == null){
            return false;
        }
        if(s.equals("已发布") || s.equals("草稿")){
            return true;
        }
        return false;
    }
}

二、 实现自定义校验

步骤:

1. 在实体类中使用自定义校验注解 @State：

在我们的实体类中，通常需要对某些字段添加约束，以确保它们的值符合业务逻辑的要求。为了应用我们刚刚创建的 @State 自定义注解，我们需要在需要进行状态校验的字段上添加此注解。

2. 添加 @State 注解：

在对应字段的声明上面添加 @State 注解，指定合法的状态值。例如，假设我们有一个 Article 实体类，其中有一个 status 字段，表示文章的状态：

import com.YJZE.anno.State;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import lombok.Data;
import org.hibernate.validator.constraints.URL;

import java.time.LocalDateTime;

@Data
public class Article {
    private Integer id;//主键ID
    @URL
    private String coverImg;//封面图像
    @State
    private String state;//发布状态 已发布|草稿
    @NotNull
    private Integer categoryId;//文章分类id
    private Integer createUser;//创建人ID
    private LocalDateTime createTime;//创建时间
    private LocalDateTime updateTime;//更新时间
}

总结

在本教程中，我们深入探讨了如何在 Spring Boot 中创建和实现自定义校验注解。通过自定义的 @State 注解，我们能够根据具体的业务需求对字段状态进行灵活而精确的校验。这种方法不仅提升了代码的可读性和可维护性，还使得校验逻辑更加清晰明了。

主要步骤回顾：

1. 创建自定义注解 ：我们首先定义了 @State 注解，并使用 @Constraint 注解来标记其为校验注解。此外，借助自定义的验证器 StateValidation，实现了具体的校验逻辑。

2. 实现校验逻辑 ：通过实现 ConstraintValidator 接口，定义了有效的状态值（如 "已发布" 和 "草稿"），并在 isValid 方法中实现了相应的校验机制，以确保字段值合法。

3. 应用自定义校验 ：在实体类中，我们将自定义注解应用于需要进行状态校验的字段。例如，在 Article 类中，对 state 字段使用了 @State 注解，从而保证其值符合预定义规则。

优势

• 灵活性：可根据具体业务需求灵活自定义校验逻辑，满足复杂场景的需要。
• 可读性：通过注解清晰表达校验意图，减少冗余的样板代码，增强代码的可理解性。
• 可维护性：集中化的校验逻辑便于后续的修改和扩展，提高了代码的可维护性。

通过学习和实践自定义校验注解，将能够更有效地应对应用程序的复杂需求，提升整体代码质量，并在复杂的业务场景中展现出更强的竞争力。希望这个示例能够对你的项目有所帮助，如需深入了解，欢迎评论区随时提问！

注意：

• 如有错误请告知
• 如有侵权请带着截图发邮件
• 邮箱 [email protected]