自定义校验器在 Spring Boot 中校验字符串请求体

自定义校验器在 Spring Boot 中校验字符串请求体

在 Spring Boot 应用中,我们经常需要对请求体进行校验,以确保接收到的数据符合预期的格式和规范。对于简单的字符串请求体,我们可以通过自定义校验器来实现更灵活的验证逻辑。本文将介绍如何创建一个自定义校验器,用于验证请求体中的字符串是否符合 JSON 格式。

首先,我们需要创建一个自定义注解,用于标记需要进行 json 格式验证的参数。

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})@Documentedpublic @interface MyValidator {    String message() default "{Token is not in Json syntax}";    Class[] groups() default {};    Class[] payload() default {};}

接下来,我们需要创建一个校验器类,实现 ConstraintValidator 接口,并实现 isValid 方法,用于执行实际的 JSON 格式验证逻辑。

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; // Allow empty strings, or handle as needed        }        try {            JsonParser.parseString(token);            return true;        } catch (JsonSyntaxException e) {            return false;        }    }}

现在,我们可以在 Controller 中使用 @RequestBody 注解接收字符串请求体,并使用 @Valid 注解触发验证。需要注意的是,这里需要使用 @Valid 注解,而不是自定义的 @MyValidator 注解。 @MyValidator 只是定义了校验规则,而 @Valid 才是触发校验的注解。

import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.*;import javax.validation.Valid;@RestControllerpublic class MyController {    @RequestMapping(value = "/endpoint", method = {RequestMethod.POST})    @ResponseBody    public ResponseEntity authorize(@Valid @RequestBody String token) {        // logic        return ResponseEntity.ok("Token is valid");    }}

注意事项:

百度文心百中 百度文心百中

百度大模型语义搜索体验中心

百度文心百中 22 查看详情 百度文心百中 确保你的 Spring Boot 项目引入了 javax.validation 依赖,通常是通过 spring-boot-starter-validation 依赖引入。@Valid 注解必须与 @RequestBody 一起使用才能触发验证。如果验证失败,Spring Boot 会抛出 MethodArgumentNotValidException 异常,你需要全局异常处理来捕获并处理该异常,返回合适的错误信息。

总结:

通过以上步骤,我们成功地创建了一个自定义校验器,用于验证请求体中的字符串是否符合 JSON 格式。这种方法可以应用于各种需要自定义验证逻辑的场景,例如验证字符串是否符合特定的正则表达式,或者是否包含特定的字符。关键在于定义好自定义注解和校验器类,并在 Controller 中使用 @Valid 注解触发验证。

以上就是自定义校验器在 Spring Boot 中校验字符串请求体的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/245172.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月4日 03:15:37
下一篇 2025年11月4日 03:16:25

相关推荐

发表回复

登录后才能评论
关注微信