在业务开发过程中我们会遇到形形色色的注解,但是框架自有的注解并不是总能满足复杂的业务需求,我们可以自定义注解来满足我们的需求。根据注解使用的位置,文章将分成字段注解、方法、类注解来介绍自定义注解
字段注解
字段注解一般是用于校验字段是否满足要求,hibernate-validate依赖就提供了很多校验注解,如 NotNull、 Range等,但是这些注解并不是能够满足所有业务场景的。比如我们希望传入的参数在指定的String集合中,那么已有的注解就不能满足需求了,需要自己实现。
自定义注解
定义一个 Check注解,通过 interface声明一个注解
Target定义注解的使用位置,用来说明该注解可以被声明在那些元素之前。
•ElementType.TYPE:说明该注解只能被声明在一个类前。
•ElementType.FIELD:说明该注解只能被声明在一个类的字段前。
•ElementType.METHOD:说明该注解只能被声明在一个类的方法前。
•ElementType.PARAMETER:说明该注解只能被声明在一个方法参数前。
•ElementType.CONSTRUCTOR:说明该注解只能声明在一个类的构造方法前。
•ElementType.LOCAL_VARIABLE:说明该注解只能声明在一个局部变量前。
•ElementType.ANNOTATION_TYPE:说明该注解只能声明在一个注解类型前。
•ElementType.PACKAGE:说明该注解只能声明在一个包名前
Constraint通过使用validatedBy来指定与注解关联的验证器
Retention用来说明该注解类的生命周期。
•RetentionPolicy.SOURCE:注解只保留在源文件中
•RetentionPolicy.CLASS:注解保留在class文件中,在加载到JVM虚拟机时丢弃
•RetentionPolicy.RUNTIME:注解保留在程序运行期间,此时可以通过反射获得定义在某个类上的所有注解。
验证器类
验证器类需要实现ConstraintValidator泛型接口
第一个泛型参数类型Check:注解,第二个泛型参数Object:校验字段类型。需要实现initialize和isValid方法,isValid方法为校验逻辑,initialize方法初始化工作
使用方式
定义一个实体类
对sex字段加校验,其值必须为woman或者man
测试
注意需要在User对象上加上@Validated注解,这里也可以使用@Valid注解
极悦,免费下载学习。
你适合学Java吗?4大专业测评方法
代码逻辑 吸收能力 技术学习能力 综合素质
先测评确定适合在学习