ITPub博客

首页 > 应用开发 > Java > Java Annotation 注解

Java Annotation 注解

原创 Java 作者:百联达 时间:2016-12-06 15:59:32 0 删除 编辑
一:背景

JDK 5中引入了源代码中的注解(annotation)这一机制。注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,用来简化程序中的配置。

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

二:简介

a.Annotation与interface的异同:

1)、Annotation类型使用关键字@interface而不是interface。


这个关键字声明隐含了一个信息:它是继承了java.lang.annotation.Annotation接口,并非声明了一个interface


2)、Annotation类型、方法定义是独特的、受限制的。


Annotation类型的方法必须声明为无参数、无异常抛出的。这些方法定义了annotation的成员:方法名成为了成员名,而方法返回值成为了成员的类型。


方法返回值类型必须为primitive类型、Class类型、枚举类型、annotation类型或者由前面类型之一作为元素的一维数组。


方法的后面可以使用DEFAULT和一个默认数值来声明成员的默认值,NULL不能作为成员默认值,这与我们在非annotation类型中定义方法有很大不同。


Annotation类型和它的方法不能使用annotation类型的参数、成员不能是generic。只有返回值类型是Class的方法可以在annotation类型中使用generic,


因为此方法能够用类转换将各种类型转换为Class。


3)、Annotation类型又与接口有着近似之处


它们可以定义常量、静态成员类型(比如枚举类型定义)。Annotation类型也可以如接口一般被实现或者继承。


b.注解分类

1 、标准 Annotation
包括Override, Deprecated, SuppressWarnings,标准 Annotation 是指 Java 自带的几个 Annotation,上面三个分别表示重写函数,函数已经被禁止使用,忽略某项 Warning


(1)、Override
  java.lang.Override是一个markerannotation类型,它被用作标注方法。它说明了被标注的方法重载了父类的方法,起到了断言的作用。如果我们使用了这种annotation在一个没有覆盖父类方法的方法时,java编译器将以一个编译错误来警示。这个annotaton常常在我们试图覆盖父类方法而确又写错了方法名时加一个保障性的校验过程。
(2)、Deprecated
  Deprecated也是一种markerannotation。当一个类型或者类型成员使用@Deprecated修饰的话,编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”:如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员,虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated,但编译器仍然要报警。
注意:@Deprecated这个annotation类型和javadoc中的@deprecated这个tag是有区别的:前者是java编译器识别的,而后者是被javadoc工具所识别用来生成文档(包含程序成员为什么已经过时、它应当如何被禁止或者替代的描述)。
(3)、SuppressWarnings
  此注解能告诉Java编译器关闭对类、方法及成员变量的警告。
  有时编译时会提出一些警告,对于这些警告有的隐藏着Bug,有的是无法避免的,对于某些不想看到的警告信息,可以通过这个注解来屏蔽。
        SuppressWarning不是一个markerannotation。它有一个类型为STRING[]的成员,这个成员的值为被禁止的警告名。对于javac编译器来讲,被-Xlint选项有效的警告名也同样对@SuppressWarings有效,同时编译器忽略掉无法识别的警告名。annotation语法允许在annotation名后跟括号,括号中是使用逗号分割的NAME=VALUE对用于为annotation的成员赋值:
@SuppressWarnings(VALUE={"unchecked","fallthrough"})
public void lintTrap() { /* sloppy method body omitted */ }

2.元注解是指注解的注解。包括  @Retention @Target @Document @Inherited四种。

@Retention 定义注解的保留策略
 

@Retention(RetentionPolicy.SOURCE)    //注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS)  // 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME)   // 注解会在class字节码文件中存在,在运行时可以通过反射获取到

@Target:定义注解的作用目标

@Target(ElementType.TYPE) // 接口、类、枚举、注解
@Target(ElementType.FIELD)  // 字段、枚举的常量
@Target(ElementType.METHOD)  // 方法
@Target(ElementType.PARAMETER)  // 方法参数
@Target(ElementType.CONSTRUCTOR)   // 构造函数
@Target(ElementType.LOCAL_VARIABLE) // 局部变量
@Target(ElementType.PACKAGE) / // 包

@Document:说明该注解将被包含在javadoc中
@Inherited:说明子类可以继承父类中的该注解

3.自定义 Annotation

自定义 Annotation 表示自己根据需要定义的 Annotation,定义时需要用到上面的元 Annotation


三:使用

在一般的Java开发中,最常接触到的可能就是@Override和@SupressWarnings这两个注解了。使用@Override的时候只需要一个简单的声明即可。这种称为标记注解(marker annotation ),它的出现就代表了某种配置语义。而其它的注解是可以有自己的配置参数的。配置参数以名值对的方式出现。使用 @SupressWarnings的时候需要类似@SupressWarnings({"uncheck", "unused"})这样的语法。在括号里面的是该注解可供配置的值。由于这个注解只有一个配置参数,该参数的名称默认为VALUE,并且可以省略。而花括号则表示是数组类型。在JPA中的@Table注解使用类似@Table(NAME = "Customer", SCHEMA = "APP")这样的语法。从这里可以看到名值对的用法。在使用注解时候的配置参数的值必须是编译时刻的常量。

从某种角度来说,可以把注解看成是一个XML元素,该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解,就相当于把一部分元数据从XML文件移到了代码本身之中,在一个地方管理和维护。

四:开发

点击(此处)折叠或打开

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. public @interface BusinessCheckPoint {

  5.     /**
  6.      * TODO: 业务检查点名称
  7.      *
  8.      * @return
  9.      */
  10.     String checkName() default StringUtils.EMPTY;

  11.     /**
  12.      * TODO: 业务类型
  13.      *
  14.      * @return
  15.      */
  16.     String creditCheckName() default StringUtils.EMPTY;

  17. }
@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型。可以通过default来声明参数的默认值。在这里可以看到@Retention和@Target这样的元注解,用来声明注解本身的行为。@Retention用来声明注解的保留策略,有CLASS、RUNTIME和SOURCE这三种,分别表示注解保存在类文件、JVM运行时刻和源代码中。只有当声明为RUNTIME的时候,才能够在运行时刻通过反射API来获取到注解的信息。@Target用来声明注解可以被添加在哪些类型的元素上,如类型、方法和域等


五:处理

利用JAVA类的反射机制

点击(此处)折叠或打开

  1. method.getAnnotation(AnnotationName.class);
  2. method.getAnnotations();
  3. method.isAnnotationPresent(AnnotationName.class);

来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/28624388/viewspace-2129869/ ,如需转载,请注明出处,否则将追究法律责任。

上一篇: Java Proxy动态代理
请登录后发表评论 登录
全部评论
15年以上互联网经验,先后从事过制造业,证券业,物业行业和物流行业信息系统和互联网产品的设计落地实施,8年系统架构经验。最近关注企业数字化转型、财务数字化服务共享、大语言模型、Kubernetes微服务架构和Istio微服务治理框架。

注册时间:2013-02-05

  • 博文量
    332
  • 访问量
    1265641