注解 - 基础知识

概述

Java从JDK 5开始支持在源文件中嵌入补充信息,这类信息称为注解。术语“元数据”也用于表示这种特性,但是术语“注解”更具描述性且更常用。注解不会改变程序的动作,因此也就不会改变程序的语义。但是在开发和部署期间,各种工具可以使用这类信息。

注解是通过基于接口的机制创建的。声明注解要在关键字interface前面加@,这告诉编译器正在声明一种注解类型。所有注解都只包含方法声明,但是不能为这些方法提供方法体,而是由Java实现这些方法。这些方法的行为更像是域变量。

public @interface Anno {
    
    String name();
    
    int value();
    
}

注意:注解不能包含extends子句,但是所有注解类型都自动扩展了Annotation接口。

在JDK 8之前,注解只能用于注解声明,JDK 8添加了注解类型的功能。所有类型的声明都可以有与之相关的注解。例如,类、方法、域变量、参数以及枚举常量都可以带有注解,甚至注解本身也可以被注解。对于所有情况,注解都要放在声明的最前面。

应用注解时,需要为注解的成员提供值。例如:

@Anno(name = "example", value = 100)
public static void test() {
    // ...
}

默认值

可以为注解成员提供默认值,应用注解时如果没有为注解成员指定值,就会使用默认值。

默认值的一般形式如下:
type member() default value;

例子

public @interface Anno {
    
    String name() default "example";
    
    int value() default 100;
    
}

可以有以下4种方式使用@Anno:

@Anno()
@Anno(name = "other")
@Anno(value = 1000)
@Anno(name = "other", value = 1000)

保留策略

注解的保留策略决定了在什么位置丢弃注解。Java定义了三种保留策略,被封装在java.lang.annotation.RetentionPolicy枚举中。这三种策略是:

  • SOURCE:注解只在源文件中保留,在编译期间会被丢弃。
  • CLASS:注解在编译时会被存储到.class文件中,但是在运行时通过JVM不能得到这些注解。
  • RUNTIME:注解在编译时会被存储到.class文件中,而且在运行时也可以通过JVM得到这些注解。因此,RUNTIME保留策略提供了最永久的注解。

注意:

  • 如果没有为注解指定保留策略,将使用默认策略CLASS。
  • 局部变量声明的注解不能存储在.class文件中。

保留策略是通过Java的内置注解@Retention指定的,一般形式如下:
@Retention(retention-policy)

例子

@Retention(RetentionPolicy.RUNTIME)
public @interface Anno {
    
    String name();
    
    int value();
    
}

在运行时使用反射获取注解

尽管设计注解的目的主要是用于其它的开发和部署工具,但是如果为注解指定了RUNTIME保留策略,那么任何程序在运行时都可以使用反射来获取注解。

public @interface Anno {
    
    String name();
    
    int value();
    
}

public class AnnoTest {

    @Anno(name = "example", value = 100)
    public static void test() {
        AnnoTest at = new AnnoTest();

        try {
            Class<?> c = at.getClass();
            Method m = c.getMethod("test");
            MyAnno anno = m.getAnnotation(Anno.class);

            System.out.println(anno.name() + ": " + anno.value());
        } catch(NoSuchMethodException e) {
            System.out.println("Method Not Found.");
        }
    }

}

AnnotatedElement接口

前面例子中使用的getAnnotation()方法是由AnnotatedElement接口定义的,该接口在java.lang.refect包中定义。类Method、Field、Constructor、Class和Package都实现了这个接口。

除了getAnnotation()方法,AnnotatedElement接口还定义了一些其它方法:

  • 获取所有注解:
Annotation[] getAnnotations();
  • 获取所有非继承注解:
Annotation[] getDeclaredAnnotations();
  • 判断该声明或者类型是否有应用某种类型的注解(主要用于标注注解):
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);

JDK 8又添加了getDeclaredAnnotation()、getAnnotationsByType()和getDeclaredAnnotationsByType()方法。其中后两个方法自动使用重复注解。

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

推荐阅读更多精彩内容

  • 备注: 本文大部分内容及代码均来自网上,具体引用看末尾 8.参考引用** 概念及作用 JDK注解 元注解 自定...
    ting723阅读 1,466评论 2 5
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 注解 创建注解 下面代码创建了一个名为MyAnno的注解,有两个成员str和val。@Retention(…)注解...
    kylinxiang阅读 3,613评论 0 2
  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,137评论 0 2
  • 占有欲这玩意儿一旦过度 就会像温暖柔软的一双手 却猛地恶狠狠掐住你的喉 在你挣扎喘息空气稀薄即将窒息的时候 耳畔又...
    张巨鹿阅读 366评论 2 0