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

在 Spring Boot 应用中，我们经常需要对接收到的请求数据进行验证，以确保数据的有效性和安全性。当请求体是一个简单的字符串时，如何使用自定义验证器进行验证呢？本文将详细介绍如何实现这一功能，并通过示例代码演示具体步骤。

首先，我们需要创建一个自定义注解，用于标记需要验证的字符串参数。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

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

@Target({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 {};

}

在这个注解中，@Constraint(validatedBy = { JsonSyntaxValidator.class }) 指定了使用 JsonSyntaxValidator 类来验证带有 @MyValidator 注解的参数。

接下来，我们需要创建 JsonSyntaxValidator 类，实现 ConstraintValidator 接口。

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) {
        // 可以根据需要进行初始化操作
    }

    @Override
    public boolean isValid(String token, ConstraintValidatorContext constraintValidatorContext) {
        if (token == null || token.isEmpty()) {
            return true; // 允许空字符串，或者根据需要返回 false
        }

        try {
            Jso
nParser.parseString(token);
            return true;
        } catch (JsonSyntaxException e) {
            return false;
        }
    }
}

JsonSyntaxValidator 实现了 isValid 方法，该方法用于验证字符串是否为有效的 JSON 格式。这里使用了 Google Gson 库的 JsonParser 来尝试解析字符串，如果解析成功，则认为字符串是有效的 JSON 格式，否则不是。

最后，我们需要在 Controller 中使用 @Valid 注解来触发验证。

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("Token is valid");
    }
}

注意，这里使用了 @Valid 注解，而不是 @MyValidator。Spring Boot 的验证框架会扫描带有 @Valid 注解的参数，并根据参数上的约束注解（例如 @MyValidator）来执行验证。

注意事项：

• 确保你的项目中引入了 javax.validation 的依赖。
• 需要在 Controller 类上添加 @Validated 注解，才能使 @Valid 注解生效。如果使用 Spring Boot，通常不需要显式添加 @Validated，因为它默认已经启用。
• 如果验证失败，Spring Boot 会抛出 MethodArgumentNotValidException 异常。你需要配置全局异常处理，来处理这个异常并返回合适的错误信息。
• JsonSyntaxValidator 中的 isValid 方法允许空字符串通过验证。如果需要禁止空字符串，可以在方法中添加相应的判断。

总结：

通过自定义注解和验证器类，并结合 @Valid 注解，我们可以方便地对 Spring Boot 请求体中的字符串进行验证。这种方法不仅可以用于验证 JSON 格式，还可以用于验证其他类型的字符串，例如邮箱地址、电话号码等。关键在于编写合适的验证器类，并使用 @Constraint 注解将验证器类与自定义注解关联起来。