使用自定义注解进行参数校验

本文介绍了Java中如何使用@interface定义自定义注解,并探讨了@Retention、@Target、@Documented和@Inherited这四个元注解的作用。@Retention控制注解的保留策略,@Target指定注解的使用位置,@Documented使注解成为公共API,@Inherited允许子类继承父类的注解。此外,还提到了@Constraint用于创建参数校验的注解,通过实现ConstraintValidator接口进行逻辑验证。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

java用 @interface Annotation{ } 定义一个注解 @Annotation,一个注解是一个类。
   @Override,@Deprecated,@SuppressWarnings为常见的3个注解。

注解相当于一种标记,在程序中加上了注解就等于为程序加上了某种标记,以后,
JAVAC编译器,开发工具和其他程序可以用反射来了解你的类以及各种元素上有无任何标记,看你有什么标记,就去干相应的事。

注解@Retention可以用来修饰注解,是注解的注解,称为元注解。

Retention注解有一个属性value,是RetentionPolicy类型的,Enum RetentionPolicy是一个枚举类型,
这个枚举决定了Retention注解应该如何去保持,也可理解为Rentention 搭配 RententionPolicy使用。RetentionPolicy有3个值:CLASS RUNTIME SOURCE。
用@Retention(RetentionPolicy.CLASS)修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,但不会被虚拟机读取在运行的时候;
用@Retention(RetentionPolicy.SOURCE )修饰的注解,表示注解的信息会被编译器抛弃,不会留在class文件中,注解的信息只会留在源文件中;
用@Retention(RetentionPolicy.RUNTIME )修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,会被虚拟机保留在运行时,
所以他们可以用反射的方式读取。RetentionPolicy.RUNTIME 可以让你从JVM中读取Annotation注解的信息,以便在分析程序的时候使用.

@Target({ElementType.TYPE}) 注解

ElementType 这个枚举类型的常量提供了一个简单的分类:注释可能出现在Java程序中的语法位置(这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置)

@Documented:

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。

@Inherited:

@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
  在这里插入图片描述
  @Targethe 和@Retention上面已经介绍过了,说说@Constraint,这个主要用于在指定class类里面实现该类ConstraintValidator<A,T>时,A为注解类,T为注解作用的参数类型,以下为Object类型。该类中可直接引用注入spring容器中的对象,例如service等。
  此外,在属性里面如果不想设置default,在用到次注解的时候一定要在写入参,比如message没有默认值,在用的时候一定要@PasswordNotNull(message=“”)。
  在这里插入图片描述
  在这里插入图片描述
上面定义的initialize :message=constraintAnnotation.message()表示显示我们在定义注解时候的默认值或者自己写的文字的字面提示,
isValid:这里主要是逻辑判断,第一个参数就是我们传入的参数,对这个传入的参数进行相关的逻辑校验,return true就代表返回成功,然后也会返回message相应的提示。如果返回false就是错误,也不会执行上面的initialize的代码

到这里已经完成了对这个注解的自定义了,接下来可以到某个类里面的参数进行试验即可。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值