Java注解

定义

注解(Annotation),也叫元数据,是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一层次。它可以声明在包、类、字段、方法、局部变量、方法参数、构造函数等的前面,用来对这些元素进行说明和注释。

元注解

元注解的作用就是负责注解其他注解,即注解的注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其他annotatio类型作说明。Java5.0定义的元注解:@Retention@Target@Documented@Inherited

@Retention

@Retention表示需要在什么级别保存该注释信息,用于描述注解的生命周期,取值有

             1、@Retention(RetentionPolicy.SOURCE)  注解仅存在于源码中,在class字节码文件中不包含

             2、@Retention(RetentionPolicy.CLASS)  默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得

             3、@Retention(RetentionPolicy.RUNTIME) 注解会在class字节码文件中存在,在运行时可以通过反射获取到


SOURCE 例1

自定义注解MyAnnotation,Retention的取值是保留策略的SOURCE

@Retention(RetentionPolicy.SOURCE)

public  @interface  MyAnnotation{

}

标注的类Test

@MyAnnotation

public classTest {

           public static void main(String[] args) {

                             System.out.println("生成的class文件反编译后不会出现注解@MyAnnotation");

            }

}

反编译生成的.class文件,Test类不存在MyAnnotation注解

CLASS 例2

自定义注解MyAnnotation,Retention的取值是保留策略的CLASS

@Retention(RetentionPolicy.CLASS)

public  @interface  MyAnnotation{

}

标注的类Test

@MyAnnotation

public classTest {

               public static void  main(String[] args) {

                              System.out.println("生成的class文件反编译后会出现注解@MyAnnotation");

                              Annotation[] annotations = Test.class.getAnnotations();

                             System.out.println("Runtime期间标注在Test类上的注解个数为:"+ annotations.length);

                 }

}

验证结果:.class文件出现注解,运行期间获取Test类上的注解个数为0



RUNTIME 例2

自定义注解MyAnnotation,Retention的取值是保留策略的RUNTIME

@Retention(RetentionPolicy.RUNTIME)

public  @interface  MyAnnotation{

}

标注的类Test

@MyAnnotation

public classTest {

             public static void  main(String[] args) {

                            System.out.println("生成的class文件反编译后会出现注解@MyAnnotation");

                            Annotation[] annotations = Test.class.getAnnotations();

                            System.out.println("Runtime期间标注在Test类上的注解个数为:"+ annotations.length);

              }

}

验证结果:.class文件出现注解,运行期间获取Test类上的注解个数为1



@Target

用于设定注解使用范围,通过ElementType来指定可使用范围的枚举集合。

注解只能在ElementType设定的范围内使用,否则将会编译报错。

@Documented

@Documented标注的注解应该被javadoc工具记录。默认情况下,javadoc是不包括注解的,如果声明注解时指定了@Documented,注解类型信息也会被包括在生成的文档中。

@Inheried

@Inherited:允许子类继承标注在父类上的注解。

package-info.java

package-info.java不是平常类,其作用有三个:

          1.为标注在包上Annotation提供便利

           2.声明包的私有类和常量

           3. 提供包的整体注释声明

package-info.java里不能声明public classpublic interface,在package-info.java定义的类和普通类没什么却别。


例子 1

MyPackageAnnotation

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.PACKAGE)

@Documented

public@interfaceMyPackageAnnotation{

          String version()default"";

}

package-info.java

@MyPackageAnnotation(version ="1.0")

packagecom.leeem.domain;

importcom.leeem.annotation.MyPackageAnnotation;

//类方法

classPackageClass{

           public voidclassMethod(){

                        System.out.println("class method");

           }

}

//类常量字段

classPackageClassConstant{

              public static finalStringERROR_CODE="100001";

}

//接口方法

interfacePackageInterface{

          public voidinterfaceMethod();

}

Test.java  --获取包注解

public classTest {

                     public static voidmain(String[] args) {

                              Package p = Package.getPackage("com.leeem.domain");

                              MyPackageAnnotationmyPackageAnnotation = p.getAnnotation(MyPackageAnnotation.class);

                              if(myPackageAnnotation !=null&& p.isAnnotationPresent(MyPackageAnnotation.class)){

                                                  System.out.println("获取到包注解,且版本version为:"+ myPackageAnnotation.version());

                               }

                      }

}

输出:获取到包注解,且版本version为:1.0

Test.java  --使用package-info.java定义的类 (接口类似)

public classTest {

                public static voidmain(String[] args) {

                              PackageClasspackageClass =newPackageClass();

                              packageClass.classMethod();

                  }

}

输出:class method

Test.java  --使用package-info.java定义的类的常量

public classTest {

               public static voidmain(String[] args) {

                             System.out.println(PackageClassConstant.ERROR_CODE);

               }

}

输出:100001


Java内置注解

Java SE5内置了三种标准注解:@Override、@Deprecated、@SuppressWarnings

@Override:表示当前的方法定义将覆盖超类中的方法。

@Deprecated:标注已过时或已废弃的代码,通常存在更好的选择。使用该注解标注的元素时,编译器会报警

@SuppressWarnings:用来抑制编译时的警告信息

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容