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

本文介绍了如何在Spring Boot中使用自定义验证器来验证请求体中的字符串。通过自定义注解和验证器类，可以实现对请求体字符串的特定格式或内容的校验，从而确保接收到的数据符合预期。本文提供详细的代码示例，帮助开发者理解和应用自定义验证器。

在Spring Boot应用中，对请求数据进行验证是至关重要的，它可以有效地防止非法数据进入系统，提高应用的健壮性和安全性。当请求体是一个简单的字符串时，我们仍然可以通过自定义验证器来实现复杂的验证逻辑。以下是如何实现这一目标的详细步骤。

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 }) 指定使用 JsonSyntaxValidator 类来验证被注解的参数。
• message()、groups() 和 payload() 是标准的验证注解属性，用于定义验证失败时的消息、分组和负载。

2. 创建自定义验证器类

接下来，我们需要创建一个实现了 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 false; // 空字符串也认为是不合法的
        }

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

在这个验证器类中：

• initialize() 方法用于初始化验证器，可以读取注解中的参数。
• isValid() 方法用于执行实际的验证逻辑。它接收被验证的值（token）和一个 ConstraintValidatorContext 对象，可以用于自定义验证失败时的消息。

3. 在Controller中使用验证

萝卜简历

免费在线AI简历制作工具，帮助求职者轻松完成简历制作。

下载

现在，我们可以在Spring Boot Controller中使用自定义的验证注解。

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
public class MyController {

    @RequestMapping(value = "/endpoint", method = { RequestMethod.POST })
    public ResponseEntity authorize(@Valid @RequestBody String token) {
        // logic
        return ResponseEntity.ok("Token is valid");
    }
}

关键点：

• 使用 @RequestBody 注解来接收请求体中的字符串。
• 使用 @Valid 注解来触发验证。注意，这里应该使用@Valid注解，而不是自定义的@MyValidator注解。 @Valid注解会触发Spring Boot的验证机制，从而调用我们自定义的验证器。
• @MyValidator 注解本身并不直接触发验证，它只是声明了使用哪个验证器。

4. 配置验证器（如果需要）

如果自定义验证器需要依赖注入，需要将验证器声明为一个Spring Bean。

import org.springframework.stereotype.Component;
import com.google.gson.JsonParser;
import com.google.gson.JsonSyntaxException;

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

@Component
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 false; // 空字符串也认为是不合法的
        }

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

5. 异常处理

如果验证失败，Spring Boot会抛出 MethodArgumentNotValidException 异常。我们需要配置一个全局异常处理器来处理这个异常，并返回合适的错误信息。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity handleValidationException(MethodArgumentNotValidException ex) {
        return new ResponseEntity<>(ex.getBindingResult().getFieldError().getDefaultMessage(), HttpStatus.BAD_REQUEST);
    }
}

总结与注意事项

• 确保在Controller中使用 @Valid 注解来触发验证。
• 自定义验证器类需要实现 ConstraintValidator 接口。
• 如果验证器需要依赖注入，需要将它声明为一个Spring Bean。
• 配置全局异常处理器来处理验证失败的情况。
• 可以根据实际需求自定义验证逻辑，例如校验字符串的长度、格式等。
• 避免在验证器中执行复杂的业务逻辑，验证器应该只负责验证数据的有效性。

通过以上步骤，我们就可以在Spring Boot中使用自定义验证器来验证请求体中的字符串，从而提高应用的健壮性和安全性。