使用自定义验证器校验 Spring Boot 请求体字符串

本文介绍了如何在 Spring Boot 应用中，针对直接接收字符串类型的请求体，应用自定义验证器进行数据校验。通过示例代码，详细展示了自定义注解、验证器以及如何在 Controller 中正确使用 @Valid 注解，实现对请求体字符串的有效性验证。

在 Spring Boot 应用开发中，我们经常需要对请求体中的数据进行校验，以保证数据的合法性和安全性。通常情况下，我们会使用 JSR-303 提供的标准注解，例如 @NotNull、@Size 等，来对 POJO 对象的属性进行校验。但有时，我们可能需要直接接收字符串类型的请求体，例如 JSON 字符串，并对其进行自定义的校验。本文将介绍如何实现这一需求。

1. 创建自定义注解

首先，我们需要创建一个自定义注解，用于标识需要进行校验的字符串。

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

import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target({ ElementType.PARAMETER })
@Retention(RUNTIME)
@Constraint(validatedBy = { JsonSyntaxValidator.class })
@Documented
public @interface MyValidator {

    String message() default "{Token is not in Json syntax}";

    Class[] groups() default {};

    Class[] payload() default {};

}

• @Target({ ElementType.PARAMETER }): 指定注解可以应用的目标类型，这里是方法参数。
• @Retention(RUNTIME): 指定注解的保留策略，这里是运行时保留。
• @Constraint(validatedBy = { JsonSyntaxValidator.class }): 指定处理该注解的验证器类。
• message(): 定义验证失败时的默认消息。
• groups(): 定义分组，用于分组验证。
• payload(): 定义负载，用于传递验证信息。

2. 创建自定义验证器

接下来，我们需要创建一个自定义验证器，用于实现具体的校验逻辑。

import com.google.gson.JsonParser;
import com.google.gson.JsonSyntaxException;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class JsonSyntaxValidator implements ConstraintValidator {

    @Override
    public void initialize(MyValidator constraintAnnotation) {

    }

    /**
     * It returns true if the Google Pay or Apple Pay token is in Json format.
     */
    @Override
    public boolean isValid(String token, ConstraintValidatorContext constraintValidatorContext) {

        boolean isValid = true;

        try {
            JsonParser.parseString(token);
        } catch (JsonSyntaxException e) {
            isValid = false;
        }
        return isValid;
    }
}

• ConstraintValidator: 指定验证器处理的注解类型和数据类型。
• initialize(MyValidator constraintAnnotation): 用于初始化验证器，可以获取注解中的属性值。
• isValid(String token, ConstraintValidatorContext constraintValidatorContext): 实现具体的校验逻辑，返回 true 表示验证通过，false 表示验证失败。

3. 在 Controller 中使用

最后，我们需要在 Controller 中使用自定义注解，并启用验证功能。

FineVoice

FineVoice是一种AI数字语音解决方案，可以帮助用户增强声音，并配有实时变声器

下载

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;

@RestController
public class MyController {

    @RequestMapping(value = "/endpoint", method = { RequestMethod.POST })
    @ResponseBody
    public ResponseEntity authorize(@Valid @RequestBody String token) {

        // logic
        return ResponseEntity.ok("Success");
    }
}

关键点：

• 使用 @RequestBody 注解接收请求体中的字符串。
• 使用 @Valid 注解启用验证功能。注意这里是@Valid而不是自定义的@MyValidator。

重要提示: Spring Boot 默认情况下不会对 @RequestBody 中的简单类型（如 String）进行验证。需要显式地使用 @Valid 注解来触发验证。

4. 注意事项

• 确保你的 Spring Boot 项目已经引入了 spring-boot-starter-validation 依赖。
• 如果验证失败，Spring Boot 会抛出 MethodArgumentNotValidException 异常。你需要配置全局异常处理器来处理该异常，并返回合适的错误信息。

5. 总结

通过以上步骤，我们可以实现对 Spring Boot 请求体字符串的自定义验证。这种方法可以灵活地应对各种复杂的校验需求，提高应用的健壮性和安全性。记住，关键在于正确使用 @Valid 注解来触发验证过程。