使用注解进行数据校验，简洁高效且更具表达性

后端

2023-11-19 06:53:45

在软件开发中，数据校验是非常重要的一个环节，它可以确保数据的准确性和完整性，从而避免应用程序出现错误。传统的做法是使用硬编码的方式来实现数据校验，但是这种方法存在很多问题，比如代码冗余、难以维护和扩展等。

为了解决这些问题，Java引入了注解的概念。注解是一种元数据，它可以被附加到类、方法、字段和参数上，用于提供额外信息。我们可以使用注解来实现数据校验，这样可以使代码更加简洁、易读和可维护。

注解可以有多种用法，根据其作用不同，常用的注解主要有以下几大类：

元注解：用来注解其他注解的注解。
类/接口注解：用来注解类的注解。
方法注解：用来注解方法的注解。
字段注解：用来注解字段的注解。
参数注解：用来注解方法参数的注解。

其中，数据校验注解是参数注解的一种，它可以被附加到方法的参数上，用于校验参数的值是否合法。

Java内置了一些常用的数据校验注解，包括：

@NotNull：校验参数是否为null。
@NotEmpty：校验参数是否为null或空字符串。
@NotBlank：校验参数是否为null、空字符串或空白字符串。
@Size：校验参数的长度是否在指定范围内。
@Email：校验参数是否为合法的邮箱地址。
@Pattern：校验参数是否匹配指定的正则表达式。

我们也可以自定义注解来实现数据校验。自定义注解的语法如下：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface MyDataValidation {

    String message() default "参数校验失败";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

其中，@Retention(RetentionPolicy.RUNTIME)表示该注解将在运行时保留，@Target(ElementType.PARAMETER)表示该注解只能被用于方法参数，message()方法用于指定校验失败时的提示信息，groups()方法用于指定该注解所属的验证组，payload()方法用于指定该注解携带的数据。

下面我们来看一个使用自定义注解实现数据校验的例子：

public class UserController {

    @PostMapping("/register")
    public void register(@RequestBody @MyDataValidation User user) {
        // 校验参数
        if (user.getUsername() == null || user.getUsername().isEmpty()) {
            throw new IllegalArgumentException("用户名不能为空");
        }
        if (user.getPassword() == null || user.getPassword().isEmpty()) {
            throw new IllegalArgumentException("密码不能为空");
        }

        // 保存用户
        userService.save(user);
    }
}