SpringBoot 实现自定义注解来校验字段

实现需求:
实现IP校验

1·创建注解

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

/**
 * @author zhout
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = IpAddressValidator.class)
public @interface IpAddress {

    String message() default "IP格式不正确。";

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

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

通过@Constraint(validatedBy = IpAddressValidator.class)来指定校验规则

2·创建自定义校验器
具体校验逻辑在这里实现

import cn.hutool.core.lang.Validator;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;

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

/**
 * IP地址校验器
 * @author zhout
 */
public class IpAddressValidator implements ConstraintValidator<IpAddress,String> {
    @Override
    public void initialize(IpAddress constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }


    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
    //这里实现具体的校验逻辑,校验通过则return true,否则return false
        if (StringUtils.isBlank(value)) {
            return false;
        }
        if (!Validator.isIpv4(value)){
            return false;
        }
        return true;
    }
}

3·给需要校验的字段添加我们创建的注解

@ApiModel("白名单IP对象")
@TableName("whitelist")
@Data
public class Whitelist implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty("白名单IP")
    @NotNull(message = "ip不能为空")
    @IpAddress
    private String ip;

}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot 提供了一种基于注解的方式来实现校验,即使用 `javax.validation` 标准规范中的注解来实现校验。如果需要自定义校验规则,可以按照以下步骤进行: 1. 创建自定义注解 ```java @Target({ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = MyValidator.class) public @interface MyValidation { String message() default "Invalid field"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 2. 创建自定义校验器 ```java public class MyValidator implements ConstraintValidator<MyValidation, String> { @Override public void initialize(MyValidation constraintAnnotation) { // 初始化 } @Override public boolean isValid(String value, ConstraintValidatorContext context) { // 自定义校验逻辑 return value != null && value.startsWith("prefix"); } } ``` 3. 在需要校验字段上添加自定义注解 ```java public class MyEntity { @MyValidation private String myField; // getter/setter } ``` 4. 在 Controller 中使用 `@Validated` 注解进行校验 ```java @RestController @RequestMapping("/my-entity") @Validated public class MyController { @PostMapping public MyEntity create(@RequestBody @Valid MyEntity entity) { // 创建实体 } } ``` 在上面的示例中,`MyValidation` 注解和 `MyValidator` 校验实现了一个自定义的校验规则,用于判断字符串是否以 "prefix" 开头。在 `MyEntity` 实体类中,使用了 `@MyValidation` 注解来标注需要校验字段。在 `MyController` 中,使用了 `@Validated` 注解来开启校验,并在 `create()` 方法中使用 `@RequestBody @Valid` 注解来对请求体进行校验。 以上就是使用 Spring Boot 自定义校验规则的步骤。需要注意的是,自定义的校验注解需要使用 `@Constraint` 注解进行标注,并指定校验器的实现类。校验器需要实现 `ConstraintValidator` 接口,并指定校验注解和校验字段的类型。在校验逻辑中,可以使用 `ConstraintValidatorContext` 对象来进行错误信息的设置。在 Controller 中,需要使用 `@Validated` 注解开启校验,并在需要校验的参数上使用 `@Valid` 注解。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值