Pre

SpringBoot - 优雅的实现【参数校验】高级进阶

SpringBoot - 优雅的实现【自定义参数校验】高级进阶

SpringBoot - 优雅的实现【参数分组校验】高级进阶

SpringBoot - 使用Assert校验让业务代码更简洁

概述

接上文， Spring Validation 提供的注解基本上够用，但是复杂的校验，我们还是需要自己定义注解来实现自动校验。

举个例子：实体类中的sex性别属性 , 只能输入 M 、 F 这2个枚举值

三部曲

Step1 搞自定义注解

package com.artisan.customvalidator;import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑
public @interface EnumString {String message() default "value not in enum values.";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};/*** @return date must in this value array*/String[] value();/*** Defines several {@link EnumString} annotations on the same element.** @see EnumString*/@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})@Retention(RUNTIME)@Documented@interface List {EnumString[] value();}
}

Step2 搞校验逻辑

package com.artisan.customvalidator;import lombok.extern.slf4j.Slf4j;import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.List;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
@Slf4j
public class EnumStringValidator implements ConstraintValidator<EnumString, String> {private List<String> enumStringList;@Overridepublic void initialize(EnumString constraintAnnotation) {log.info("EnumStringValidator initialize.....");enumStringList = Arrays.asList(constraintAnnotation.value());}@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {if (value == null) {return true;}return enumStringList.contains(value);}
}

Step3 使用

在字段上增加注解

Step4 验证

附 int 类型的判断

package com.artisan.customvalidator;import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;/*** @author 小工匠* @version 1.0* @Des 扩展int枚举校验* @mark: show me the code , change the world*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumInteger.List.class)
@Documented
@Constraint(validatedBy = EnumNumberValidator.class)
public @interface EnumInteger {String message() default "value not in enum values.";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};/*** @return date must in this value array*/int[] value();/*** Defines several {@link EnumInteger} annotations on the same element.** @see EnumInteger*/@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})@Retention(RUNTIME)@Documented@interface List {EnumInteger[] value();}
}

package com.artisan.customvalidator;import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.ArrayList;
import java.util.List;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
public class EnumNumberValidator implements ConstraintValidator<EnumInteger, Number> {private List<Integer> enumStringList;@Overridepublic void initialize(EnumInteger constraintAnnotation) {enumStringList = new ArrayList<>();int[] values = constraintAnnotation.value();for (int value : values) {enumStringList.add(value);}}@Overridepublic boolean isValid(Number value, ConstraintValidatorContext context) {if (value == null) {return true;}return enumStringList.contains(value.intValue());}
}

源码

https://github.com/yangshangwei/boot2

SpringBoot - 优雅的实现【自定义参数校验】高级进阶相关推荐

SpringBoot - 优雅的实现【参数校验】高级进阶
文章目录 Pre 概述参数校验三部曲 Step1 搞依赖 Step2 搞参数校验的实体类常用的校验注解 Step3 开始验证存在的问题使用统一格式 + 全局异常Handler 优化源码 P ...
SpringBoot - 优雅的实现【参数分组校验】高级进阶
文章目录 Pre 需求实现三部曲 Step1 定义分组接口 Step2 给参数分配分组 Step3 指定分组 Step4 验证源码 Pre SpringBoot - 优雅的实现[参数校验]高级进阶 ...
SpringBoot - 优雅的实现【业务校验】高级进阶
文章目录 Pre 需求实现三部曲实体类 Step1 搞两个自定义注解 Step2 搞自定义校验器 Step3 搞验证小结源码 Pre SpringBoot - 优雅的实现[参数校验]高级进阶 ...
e0312 不存在用户定义的_更加灵活的参数校验，Spring-boot自定义参数校验注解
上文我们讨论了如何使用@Min.@Max等注解进行参数校验,主要是针对基本数据类型和级联对象进行参数校验的演示,但是在实际中我们往往需要更为复杂的校验规则,比如注册用户的密码和确认密码进行校验,这个时 ...
SpringBoot实现通用的接口参数校验
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料作者:cipher juejin.im/post/5af3c25b ...
springboot+dubbo+validation 进行 rpc 参数校验
注意:本文dubbo 版本 2.8.4 springboot 版本 2.0.4.RELEASE 项目结构 test-rest (前端消费着,controller 层,springboot+maven项 ...
Spring Mvc Controller返回值、参数绑定、参数校验 (高级二)
1,Controller 返回值返回moduleAndView 返回 String 返回void 2,Controller 参数绑定客户端请求携带的key/value 键值对绑定到 Contro ...
自定义检验注解_多注解自定义参数校验
好久直接更新了单个注解参数校验以后.偷懒了好久,今天就把多个注解自定义的参数校验写了一下,思路是一样的,只是一个注解包含的字段把它分解成了多个注解,类似于java-valid自带的不同功能的校验注解一 ...
SpringBoot使用Validation框架完成参数校验AND异常处理
关于Validation框架:(官方简介) 在任何时候,当你要处理一个应用程序的业务逻辑,数据校验是你必须要考虑和面对的事情.应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的.在通常的 ...