使用自定义注解进行restful请求参数的校验方式
自定义注解进行restful请求参数的校验
在使用springmvc开发的时候,我们通常会在controller中的方法参数实体类中加上@NotNull()等类似注解,然后在方法参数上加上
@Vilad 注解,这样在有请求的时候,就会自动按照我们的注解进行参数是否合法,避免了我们手工的校验。
但是,自带的校验注解有的时候并不能满足我们的业务验证需求,因此,我们就有必要进行自定义校验注解,以业务为需求定制我们
自己的校验注解。
下面我们来看一个例子:
1、首先我们使用@interface定义一个注解
@Target( { METHOD, FIELD, ANNOTATION_TYPE }) @Retention(RUNTIME) @Constraint(validatedBy = ByteLengthValidator.class)// 使用@Constraint指定注解校验实现类,这是一个限制型注解,只能使用指定的实现类 @Documented public @interface ByteLength { int min() default 0; int max() default 2147483647; String charsetName() default "GBK"; String message() default "的长度只能在{min}和{max}之间"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
2、实现注解实现类(和@interface定义的注解在同一个包下)
注解实现类需要实现ConstraintValidator 接口
public class ByteLengthValidator implements ConstraintValidator<ByteLength, String>{ // 实现ConstraintValidator int min; int max; String charsetName; @Override public void initialize(ByteLength constraintAnnotation) { this.min = constraintAnnotation.min(); this.max = constraintAnnotation.max(); this.charsetName = constraintAnnotation.charsetName(); } @Override public boolean isValid(String value, ConstraintValidatorContext context) { // 实现校验规则 if (null == value) { return min <= 0; } try { int length = value.getBytes(charsetName).length; return length >= min && length <= max; } catch (UnsupportedEncodingException e) { e.printStackTrace(); return false; } } }
3、在需要校验的对象的字段上加上@ByteLength注解
然后在接口方法的该对象参数上加上@Vilad 注解,在接收的请求的时候,就会使用
我们自定义的@ByteLength 进行校验该字段。
springboot小技巧:restful接口参数校验,自定义校验规则
restful风格接口参数校验
在接收参数的实体类的属性上添加默认的注解或者自定义注解
自定义参数校验注解方法
1>定义自定义注解
2>定义参数校验逻辑的处理类
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家.
相关文章
Spring注解@Configuration和@Component区别详解
@Component和@Configuration都可以作为配置类,之前一直都没觉得这两个用起来有什么差别,可能有时程序跑的和自己想的有所区别也没注意到,下面这篇文章主要给大家介绍了关于Spring注解@Configuration和@Component区别的相关资料,需要的朋友可以参考下2023-04-04IntelliJ IDEA(2020.2)的下载、安装步骤详细教程
这篇文章主要介绍了IntelliJ IDEA(2020.2)的下载、安装步骤详细教程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2020-08-08利用Spring boot+LogBack+MDC实现链路追踪
这篇文章主要介绍了利用Spring boot+LogBack+MDC实现链路追踪,MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对,下文详细介绍需要的小伙伴可以参考一下2022-04-04在Java中使用redisTemplate操作缓存的方法示例
这篇文章主要介绍了在Java中使用redisTemplate操作缓存的方法示例,在Redis中可以存储String、List、Set、Hash、Zset。感兴趣的可以了解一下2019-01-01
最新评论