Java注解

一、注解介绍

Java注解(Annotation)又称 Java 标注。Java 语言中的类、方法、变量、参数和包等都可以被标注。

1.1、注解写法

格式:

@Target 注解标注的目标:类、方法、变量、参数和包等
@Retention 作用域:源码、编译时、运行时
public @interface 注解名称{
    属性列表;
}

注解通过 @interface 关键字进行定义,如下,定义一个MyAnnotation的注解:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int value() default -1;
    String name();
}

@Target、@Retention,也是元注解,元注解是可以注解到注解上的注解。

@Target

Target 目标,限定注解了标注的地方。取值如下:

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

@Target 可以给多个值,注解到多个地方,如

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
}

@Retention

Retention 英文意为保留,标识注解作用域,在什么时候有效。取值如下:

  • RetentionPolicy.SOURCE 注解只在源码阶段保留,并被编译器忽略。
  • RetentionPolicy.CLASS 注解在源码阶段、编译器进行编译时保留,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME 注解在源码阶段、编译器进行编译、运行时保留,运行时,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。

@interface

定义注解时,用@interface定义

注解的属性

注解可以定义一些属性,如value、name:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int value() default -1;
    String name();
}

default 指定了默认值

1.2、注解的使用

我们定义一个注解,简单的使用,如下:

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int value() default -1;
}


//使用注解 MyAnnotation
public class MyAnnotationTest {

    @MyAnnotation(value = 1)
    private int age;

    @MyAnnotation
    private int age1;
    
    ......
}

Android元注解的使用

在Android中,系统源码帮我们定了一些元注解,如:IntDef, LongDef, StringDef,可以限定参数的取值范围,可以减少使用枚举,减少内存。

如,我们定义一个星期:

    public static final int Sunday = 0;
    public static final int Monday = 1;
    public static final int Tuesday = 2;
    public static final int Wednesday = 3;
    public static final int Thursday = 4;
    public static final int Friday = 5;
    public static final int Saturday = 6;
    

再定义一个注解,限定使用这个注解时的取值,若不是限定的值,则源码就会报红:

    @IntDef({Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday})
    @Target({ElementType.PARAMETER, ElementType.FIELD})
    @Retention(RetentionPolicy.SOURCE)
    public @interface Week {
    }

注解Week的使用:

    @Week
    private static int weekDay = Saturday;

    public static void setWeekDay(@Week int weekDay){
        AnnotationUsageDemo.weekDay = weekDay;
    }
    
    
    public static void main(String[] args) {
        //报红,须使用:Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
        //setWeekDay(5);

        //正确
        setWeekDay(Friday);
    }

不使用限定值,报红,如图:

1.png

1.3、注解的用法

注解单独使用是没有意义的,常见的用法:

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

推荐阅读更多精彩内容