使用自定义注解进行restful请求参数的校验方式
程序员文章站
2022-01-20 06:08:09
目录3、在需要校验的对象的字段上加上@bytelength注解自定义注解进行restful请求参数的校验在使用springmvc开发的时候,我们通常会在controller中的方法参数实体类中加上@n...
自定义注解进行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>定义参数校验逻辑的处理类
以上为个人经验,希望能给大家一个参考,也希望大家多多支持.