(003)java中的注解(Annotation)

简介

注解,java中提供了一种原程序中的元素关联任何信息、任何元素的途径的途径和方法。

注解是那些插入到源代码中使用其他工具可以对其进行处理的标签。注解不会改变程序的编译方式。java编译器会对包含注解与不包含注解的代码生成相同的虚拟机指令。在java中,注解是被当做修饰符(如public/static之类)来使用的。

概览图:

java中的注解概览图

注解与注释

注释是供人看的,注解是供程序调用的。一种是程序员写给另一个程序员的,一种是程序员写给计算机解析的。

常用注解

  • @Override: 修饰重载父类方法;
  • @Deprecated: 修饰未来将被抛弃的类/方法/属性等等;
  • @SuppressWarnings: 关闭不当编译器警告信息。

注解运行机制分类

  • 源码注解: 注解只在源码中存在,编译成.class文件中不存在;
  • 编译时注解: 注解存在于源码与.class中,运行时不存在;
  • 运行时注解: 在所有阶段都存在,可以影响程序运行逻辑。

注解来源分类

  • 来自jdk的注解:如@Override/@Deprecated等等;
  • 三方的注解: 如junit中的@Test/@Before等等;
  • 自定义注解: 通过元注解自定义的注解。

元注解

给注解进行注解,用于自定义注解。

  • @Target: 指明定义的注解的作用域,其值包括:
    • ElementType.CONSTRUCTOR: 构造方法声明;
    • ElementType.FIELD: 属性/字段声明;
    • ElementType.LOCAL_VARIABLE: 局部变量声明;
    • ElementType.METHOD: 方法声明;
    • ElementType.PACKAGE: 包声明;
    • ElementType.PARAMETER: 参数声明;
    • ElementType.TYPE: 类接口声明;
    • ElementType.ANNOTATION_TYPE: 注解类型声明;
    • ElementType.TYPE_PARAMETER: 类型参数声明(@since 1.8);
    • ElementType.TYPE_USE: 类型使用(@since 1.8)
  • @Retention: 自定义注解的生命周期,其值包括:
    • RetentionPolicy.SOURCE: 只在源码显示,编译时丢弃;
    • RetentionPolicy.CLASS: 编译时记录到.class中,运行时忽略;
    • RetentionPolicy.RUNTIME: 运行时存在,可通过反射来读取。
  • @Inherited: 一个标记注解,阐述了某个被标注的类型是被继承的,只能继承与类。
  • @Documented: 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。

自定义注解

//@Target(ElementType.METHOD)
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String desc() default "";
    String author() default "";
    int age() default 18;
}
  • 使用关键字@interface定义注解;
  • 成员变量以无参无异常的方式声明;
  • 可以通过default关键字给成员变量指定默认值;
  • 成员变量的类型是受限制的,包括原始类型、String、Class、Annotation、Enumeration;
  • 如果注解只有一个成员变量,则成员名称必须取名value(),在使用中可以忽略成员名称与赋值号(=);
  • 注解可以没有成员,没有成员的注解称为标示注解。

使用注解

// @<注解名称>(<成员名1>=<成员值1>,<成员名2>=<成员值2> ...)

@Description(desc = "I'm class annotation")
public class AnnotationApp {

    @Description(desc = "I'm method annotation",author = "rudy")
    public String eyeColor(){
        return "red";
    }
}

解析注解

通过反射获取类、方法、成员上的运行时注解信息,从而实现动态控制程序运行的逻辑。

import Annotation.Description;
import org.junit.Test;

public class AnnotationTest {

    @Test
    public void testParse() throws ClassNotFoundException {
        // 取出注解
        Class cls = Class.forName("Annotation.AnnotationApp");
        boolean isExit =  cls.isAnnotationPresent(Description.class);
        if(isExit){
            // 做逻辑处理
            Description annotation = (Description) cls.getAnnotation(Description.class);
            System.out.println("get annotation:" + annotation.desc());
        }else{
            System.out.println("no annotation!");
        }
    }
}
  • 使用类加载器加载类,获取类对象;
  • 判断是否存在类注解;
  • 取出类注解,做逻辑处理;
  • 方法注解类似。

他山之石

都看到这里了,成神之路上,要不要一起?


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

推荐阅读更多精彩内容