本文介绍了如何在 spring Boot 中对接收字符串类型的请求体进行自定义校验。通过创建自定义注解和校验器，并结合 @Valid 注解，可以实现对请求体字符串内容的有效性验证，例如检查是否符合 json 格式。本文提供了详细的代码示例和步骤说明，帮助开发者轻松实现自定义请求体字符串校验。
在 spring boot 应用中，我们经常需要对请求体进行校验，以确保数据的有效性和安全性。通常情况下，我们会使用 JSR-303 规范提供的注解，例如 @NotNull、@Size 等，对 POJO 类的字段进行校验。但是，如果请求体直接是一个字符串，而不是一个 POJO，我们该如何进行自定义校验呢？本文将介绍如何创建一个自定义的校验器，来校验请求体中的字符串是否符合特定的格式，例如 JSON 格式。
1. 创建自定义注解
首先，我们需要创建一个自定义的注解，用于标记需要进行校验的请求体参数。
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<? extends Payload>[] payload() default {}; }
在这个注解中，@Target({PARAMETER}) 指定了该注解可以用于方法参数上。@Retention(RUNTIME) 指定了该注解在运行时可见。@Constraint(validatedBy = {JsonSyntaxValidator.class}) 指定了使用 JsonSyntaxValidator 类来执行校验逻辑。message、groups 和 payload 是 JSR-303 规范中定义的标准属性，用于指定校验失败时的错误信息、分组和负载。
2. 创建自定义校验器
接下来，我们需要创建一个自定义的校验器，实现 ConstraintValidator 接口，并实现 isValid 方法来执行具体的校验逻辑。
import com.google.gson.JsonParser; import com.google.gson.JsonSyntaxException; import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class JsonSyntaxValidator implements ConstraintValidator<MyValidator, String> { @Override public void initialize(MyValidator constraintAnnotation) { // 可以进行一些初始化操作，例如读取配置信息 } @Override public boolean isValid(String token, ConstraintValidatorContext constraintValidatorContext) { if (token == null || token.isEmpty()) { return false; // 空字符串不认为是有效的 JSON } try { JsonParser.parseString(token); return true; // 成功解析，说明是有效的 JSON } catch (JsonSyntaxException e) { return false; // 解析失败，说明不是有效的 JSON } } }
在这个校验器中，initialize 方法用于进行一些初始化操作，例如读取配置信息。isValid 方法接收需要校验的字符串作为参数，并返回一个布尔值，表示该字符串是否有效。在这个例子中，我们使用 com.google.gson.JsonParser 来解析字符串，如果解析成功，则认为该字符串是一个有效的 JSON。
3. 在 Controller 中使用自定义校验器
最后，我们需要在 Controller 中使用自定义的注解和校验器。
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<String> authorize(@Valid @RequestBody String token) { // logic return ResponseEntity.ok("Token is valid"); } }
在这个 Controller 中，我们使用 @RequestBody 注解来接收请求体中的字符串，并使用 @Valid 注解来触发校验。需要注意的是，这里使用的是 @Valid 注解，而不是自定义的 @MyValidator 注解。@Valid 注解会触发 JSR-303 规范的校验器，包括我们自定义的 JsonSyntaxValidator。
注意事项：
- 确保项目中引入了 javax.validation 和 com.google.code.gson 依赖。
- @Valid 注解必须与 @RequestBody 注解一起使用才能生效。
- 如果校验失败，Spring Boot 会抛出一个 MethodArgumentNotValidException 异常，我们需要使用 @ExceptionHandler 注解来处理这个异常，并返回合适的错误信息。
总结：
通过以上步骤，我们可以创建一个自定义的校验器，来校验请求体中的字符串是否符合特定的格式。这种方法可以用于校验各种类型的字符串，例如 xml、CSV 等。只需要修改校验器中的校验逻辑即可。这种方法可以提高代码的可读性和可维护性，并确保数据的有效性和安全性。
