@Validated注解自定义参数校验

本文介绍如何使用Hibernate Validator自定义参数校验注解,包括创建自定义注解及其实现类,以确保后端接收到的数据符合预期格式。

个人博客纯净版

@Validated注解自定义参数校验 | 代码搬运工

参数校验是我们程序开发中必不可少的过程。用户在前端页面上填写表单时,前端js程序会校验参数的合法性,当数据到了后端,为了防止恶意操作,保持程序的健壮性,后端同样需要对数据进行校验。后端参数校验最简单的做法是直接在业务方法里面进行判断,当判断成功之后再继续往下执行。但这样带给我们的是代码的耦合,冗余。当我们多个地方需要校验时,我们就需要在每一个地方调用校验程序,导致代码很冗余,且不美观。

那么如何优雅的对参数进行校验呢?JSR303就是为了解决这个问题出现的,本篇文章主要是介绍Hibernate Validator如何自定义参数校验注解。

自定义校验注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Constraint(validatedBy = IntValueRangeValidator.class)
public @interface IntValueRange {

    int[] values();

    String message() default "不在取值范围之内";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

<

Spring 框架中,使用 `@Validated` 实现自定义注解以支持动态正则表达式参数校验是一种高级用法,适用于需要灵活校验规则的场景。以下是一个完整的实现方案。 ### 自定义注解的定义 首先,定义一个自定义注解 `@DynamicPattern`,其作用是允许在运行时动态传入正则表达式,以校验字符串类型的参数。 ```java import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ ElementType.FIELD, ElementType.PARAMETER }) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = DynamicPatternValidator.class) public @interface DynamicPattern { String message() default "Invalid format"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` ### 校验器实现 接下来,实现 `ConstraintValidator` 接口,编写具体的校验逻辑。通过从注解的属性中获取正则表达式,并在运行时动态校验输入值是否匹配。 ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; import java.util.regex.Pattern; public class DynamicPatternValidator implements ConstraintValidator<DynamicPattern, String> { private String regex; @Override public void initialize(DynamicPattern constraintAnnotation) { this.regex = constraintAnnotation.message(); // 假设 message 属性用于传递正则表达式 } @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value == null) { return true; // 可根据需求定义 null 是否有效 } return Pattern.matches(regex, value); } } ``` ### 使用自定义注解 在业务实体或方法参数中使用 `@DynamicPattern` 注解,并通过 `message` 属性传递正则表达式。例如: ```java public class UserRequest { @DynamicPattern(message = "^[a-zA-Z0-9_]+$") // 动态指定正则表达式 private String username; // Getter and Setter } ``` ### 启用校验并处理异常 在 Spring Boot 应用中,确保在配置类或主类上使用 `@EnableValidation` 以启用校验功能。同时,可以通过 `@ExceptionHandler` 或 `@ControllerAdvice` 捕获校验异常并返回友好的错误信息。 ```java import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; @ControllerAdvice public class ValidationExceptionHandler { @ExceptionHandler(javax.validation.ConstraintViolationException.class) public ResponseEntity<String> handleValidationExceptions() { return new ResponseEntity<>("Validation failed due to invalid input format.", HttpStatus.BAD_REQUEST); } } ``` ### 总结 通过自定义 `@DynamicPattern` 注解并结合 `ConstraintValidator` 的实现,可以实现基于动态正则表达式的参数校验功能。这种方式不仅灵活,还能够很好地与 Spring校验机制集成,适用于需要动态调整校验规则的业务场景[^1]。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值