spring自定义注解校验字段格式

在我们开发项目过程中，肯定会遇到对存储字段的格式进行验证操作的，比如ip，手机号等，这样我们一般都是加个if判断，如果需要验证的地方很多，我们就要加很多if判断，这样会代码重复的地方也就多了起来，看起来也不好看，我们如何才能更加精炼我们的代码呢，自定义注解可以解决这些个问题，我们只需要在实体bean上加个注解就可以对我们的格式进行验证，方面，显得高大上。下面是代码实现：

定义注解：

@Target(ElementType.FIELD) //指定作用于字段上
@Constraint(validatedBy = IpV4ValidRule.class) // 指定验证规则类
@Retention(RetentionPolicy.RUNTIME) // 项目运行时可以被发现
public @interface IpValid {
    String message() default "IP格式不正确"; //默认提示信息
    Class<?>[] groups() default {}; //分组
    Class<? extends Payload>[] payload() default { };
}

 实现ConstraintValidator<T,T>，这个类就可以被spring管理起来，可以在里面添加规则验证逻辑

public class IpV4ValidRule implements ConstraintValidator<IpValid,String> {
    @Override
    public void initialize(IpValid constraintAnnotation) {}

    @Override
    public boolean isValid(String str, ConstraintValidatorContext constraintValidatorContext) {
        if(ObjectUtils.isEmpty(str)){
            return false;
        }else if(str.matches(Regexs.IP_REGEX)){
            return true;
        }
        return false;
    }
}

实体bean需要验证的字段上加个@IpValid即可

public class Event{

    @IpValid
    private String ip;
}

 

在控制层添加@Validated 或者@Valid即可实现验证 

 @ApiOperation("保存")
    @PostMapping
    public Event save(@Validated @RequestBody Event event) {
		return eventService.save(event);
    }

简单吧~.~