Spring-Validated：让参数校验变得简单高效

2023-11-06 05:40:36

在开发应用程序时，确保输入数据的正确性是至关重要的。错误的数据可能导致程序故障，甚至造成安全漏洞。因此，实现有效的参数校验是必不可少的一环。Spring-Validated提供了一个简单而强大的解决方案来处理这些问题。它利用了Java内置的标准注解机制，使得开发者能够轻松地对传入参数进行校验。

为什么要使用Spring-Validated？

易于集成：只需几行代码就可以启动。
强大的社区支持：活跃的开源项目意味着大量资源和帮助。
扩展性好：可以自定义注解，满足不同需求。
简单易用：利用标准Java注解机制，学习成本低。

如何开始使用Spring-Validated

添加依赖项

在Maven或Gradle项目的pom.xml或build.gradle文件中添加以下依赖：

<!-- Maven -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

// Gradle
implementation 'org.springframework.boot:spring-boot-starter-validation'

创建一个简单的实体类

使用@NotNull, @Size, 等注解来定义校验规则：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;

    @Size(min=6, max=15, message="密码长度应在6到15个字符之间")
    private String password;

    // Getters and Setters
}

实现控制器中的校验

在Spring MVC中，只需使用@Valid注解来触发参数校验：

import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @PostMapping("/register")
    public String registerUser(@RequestBody @Valid User user, BindingResult result) {
        if (result.hasErrors()) {
            // 打印错误信息或返回特定的响应码给客户端
            return "参数校验失败";
        }
        // 用户注册逻辑...
        return "注册成功";
    }
}

自定义注解

如果标准注解无法满足需求，可以自定义新的注解。例如：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Constraint(validatedBy = MyValidator.class)
@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface MyValidation {
    String message() default "不符合条件";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

自定义验证器：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class MyValidator implements ConstraintValidator<MyValidation, String> {

    @Override
    public void initialize(MyValidation constraintAnnotation) {
        // 初始化代码
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 实现校验逻辑
        return value.matches("^[a-zA-Z0-9]*import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class MyValidator implements ConstraintValidator<MyValidation, String> {

    @Override
    public void initialize(MyValidation constraintAnnotation) {
        // 初始化代码
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 实现校验逻辑
        return value.matches("^[a-zA-Z0-9]*$");
    }
}
quot;);
    }
}