博客

自定义注解

  • Post author:
  • Post category:其他




注解


Annontation

是java5引入的新特性,中文名称注解. 他提供了一种安全的类似注释的机制,用来将任何信息或元数据(metadata)与程序元素(类,方法,成员变量等)进行关联.为程序的元素(类,方法,成员变量)加上更直观更明确的说明,这些说明信息与程序的业务逻辑无关,并且供指定的工具或框架使用.注解像一个修饰符一样,应用于包,类型,方法,构造方法,成员变量,参数及本地变量的声明语句中.

java注解是附加在代码中的一些原信息,用于一些工具在编译,运行进行解析是使用,起到配置,说明的功能.注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用.包含在java.lang.annotation.包中.



注解的用处

  1. 生成文档.
  2. 跟踪代码的依赖性,实现代替配置文件的功能
  3. 在编译时进行格式检查.



注解的原理

注解的本质是一个继承了Annotation的特殊接口,其具体实现类是java运行时生成的动态代理类.而我们通过发射获取注解时,返回的是java运行时生成的动态代理对象PROXY.通过代理对象调用自定义注解接口的方法,会最终调用AnnotationInvocationHandler的invoke()方方法.该方法会从memberValues的这个map中索引出对应的值,而memberValues的来源是java常量池.



元注解

java.lang.annotation提供了四种元注解,专门注解其他的注解.

  • @Documented 注解是否包含在javaDoc中

    一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中.

  • @Retention –什么时候使用该注解

    ● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。

    ● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式

    ● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

  • @Target 注解用于什么地方

    默认值为任何元素，表示该注解用于什么地方。可用的ElementType参数包括

    ● ElementType.CONSTRUCTOR:用于描述构造器

    ● ElementType.FIELD:成员变量、对象、属性（包括enum实例）

    ● ElementType.LOCAL_VARIABLE:用于描述局部变量

    ● ElementType.METHOD:用于描述方法

    ● ElementType.PACKAGE:用于描述包

    ● ElementType.PARAMETER:用于描述参数

    ● ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

    @ Inherited 是否允许子类继承该注解

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

常见标准的Annotation：

1.）Override

java.lang.Override是一个标记类型注解，它被用作标注方法。它说明了被标注的方法重载了父类的方法，起到了断言的作用。如果我们使用了这种注解在一个没有覆盖父类方法的方法时，java编译器将以一个编译错误来警示。

2.）Deprecated

Deprecated也是一种标记类型注解。当一个类型或者类型成员使用@Deprecated修饰的话，编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警。

3.）SuppressWarnings

SuppressWarning不是一个标记类型注解。它有一个类型为String[]的成员，这个成员的值为被禁止的警告名。对于javac编译器来讲，被-Xlint选项有效的警告名也同样对@SuppressWarings有效，同时编译器忽略掉无法识别的警告名。

@SuppressWarnings(“unchecked”)



自定义注解：

自定义注解类编写的一些规则:

  1. Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
  2. 参数成员只能用public或默认(default)这两个访问权修饰
  3. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.
  4. 要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation对象,因为你除此之外没有别的获取注解对象的方法
  5. 注解也可以没有定义成员, 不过这样注解就没啥用了

    PS:自定义注解需要使用到元注解

自定义注解使用场景

类属性自动赋值。

验证对象属性完整性。

代替配置文件功能，像spring基于注解的配置。

可以生成文档，像java代码注释中的@see,@param等

来源：CSDN

原文：

https://blog.csdn.net/PORSCHE_GT3RS/article/details/80304701