接口校验，人人有责，避免500万数据再吐血

后端

2023-02-27 18:12:14

使用自定义注解在 Java 中增强接口输入验证

背景

处理大量数据时，确保接口稳定性和性能至关重要。本文重点介绍了使用 Java 中的自定义注解对输入参数进行验证，以防止大规模数据导入导致的超时失败。

自定义注解：输入验证的利器

自定义注解是一种元注解，可用于在编译时检查和验证代码的特定方面。通过使用自定义注解，我们可以轻松地对输入参数执行类型检查、范围检查、格式检查等，以确保其有效性和合法性。

校验输入参数的具体步骤

1. 定义自定义注解类

创建自定义注解类，其中包含要验证的字段及其验证规则。例如，我们可以创建一个名为 @NotBlank 的注解来检查字符串字段是否为空或包含空白。

2. 用自定义注解标注输入参数

在需要校验的输入参数前添加自定义注解。例如：@NotBlank String name。

3. 编写验证逻辑

在自定义注解类中，编写验证逻辑以检查输入参数是否符合验证规则。例如，在 @NotBlank 注解中，我们可以编写逻辑来验证字符串字段是否为空或包含空白。

4. 执行验证

在接口代码中执行验证，以确保输入参数满足所有验证规则。例如，我们可以使用 Spring 框架的 @Validated 注解或其他验证框架/工具。

示例代码

// 定义自定义注解
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotBlank {
    String message() default "Field cannot be empty or blank";
}

// 用自定义注解标注输入参数
public class User {
    @NotBlank
    private String name;

    // 省略其他代码
}

// 执行验证
public class UserController {
    @PostMapping("/save")
    public void save(@RequestBody @Validated User user) {
        // 省略其他代码
    }
}