Java注解

Java注解

Annotation,注解,可理解为对代码贴上的标签。

注解的定义: 跟接口类似,只是多了一个@符号

public @interface TestAnnotation {}

注解的使用:

@TestAnnotation
public class Test {}

元注解,或者元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种,是用来给普通的注解进行解释说明,可以理解为标签的标签。

@Retention:用来表明注解的有效时间,也就是生存时间,分为:源码时保留、编译时保留、运行时保留。

它的取值如下:

  • - RetentionPolicy.SOURCE  注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。 
    - RetentionPolicy.CLASS  注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。 
    - RetentionPolicy.RUNTIME  注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
    
    生存周期 RUNTIME > CLASS > SOURCE.

@Documented:表明可以将注解的元素包含到Document中。

@Target:目标,指定了注解应该运用的地方,如果没有此项,可以认为标签能够随便贴,如果使用Target了,则标签只能贴到指定的地方了。

取值如下:

ElementType.TYPE:可以给一个类型进行注解,包括类、接口、枚举。
ElementType.Method:可以给一个方法进行注解
ElementType.Filed:给成员变量注解
ElementType.CONSTRUCTOR:给构造方法注解

以及其他。

@Inherited 继承,当一个超类被Inherited注解过的A注解的话,那么如果这个超类的子类没有应用其他注解的话,它会继承超类的注解A。

@Repeatable:重复,Java8 的新特性。指注解的值可以同时取多个。例如一个人的身份可以是多重的,

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

}

注解的属性

注解只有成员变量,没有成员方法,并且成员变量的定义形式需要使用无形参的方法来声明,包括 返回值+变量名+();返回值表示其类型。

如下:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();
    String msg();
}

可以设置默认值:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id() default -1;
    String msg() default "Hi";
}

注解的成员属性值的设置如下:

@TestAnnotation(id=5, msg="Hello")
public class Test {}

如果只有一个成员,则可以直接将值写在括号中。

@TestAnn("one")

如果注解没有属性则连括号都可以省略。

@TestNoFiled

public class Test {}

Java预置的注解:@Override、@Deprecated、@SuppressWarnings、

@FunctionalInterface: java8新增的,表示这个接口是一个函数接口,即只有一个抽象方法。

前面把注解定义好,写好,然后像标签一样贴到代码相应的位置上,后续就是对标签的检阅,对注解的提取。

注解的提取方式是通过反射机制实现。

  1. 通过Class对象的方法: isAnnotationPresent()来判断该Class对象是否使用了某个注解。
    public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
  2. 通过getAnnotation()来获取对应的注解对象。反射中的Class/Field/Method等都可以调用该方法。
    public <A extends Annotation> A getAnnotation(Class<A> annotationClass)
  3. 或者是通过 getAnnotations() 方法获取该类的所有注解对象,前面一个方法只是获取指定的注解对象。
    public Annotation[] getAnnotations()

如果Annotation对象不为null,就可以读取它的属性了,如下:

@Retention(RetentionPolicy.RUNTIME)
public @interface  TestAnnotation {
    int id() default -1;
    String msg() default "Hi";
}

@TestAnnotation(id=3, msg="good")
public class Test {
    public static void main(String[] args) {
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if (hasAnnotation) {
            TestAnnotation annotation = Test.class.getAnnotation(TestAnnotation.class);
            print(annotation.id());
            print(annotation.msg());
        }
    }
}

需要注意的是,如果一个注解想要在运行时被获取,那么它应该有元注解:@Retention(RetentionPolicy.RUNTIME)

如果是对类的成员变量的注解进行提取解析,则需要借助反射

public @interface Check {
    int value() default 0;
}

class Test {

```
@Check(5)
int age;

@Check(value = 9)
void setAge(int age) {

}

public static void main() throws Exception{
    Field ageFiled = Test.class.getField("age");
    ageFiled.setAccessible(true);

    Check checkAnn = ageFiled.getAnnotation(Check.class);
    print(checkAnn.value());

    Method setAgeMethod = Test.class.getMethod("setAge", Integer.TYPE);
    setAgeMethod.setAccessible(true);

    if (setAgeMethod != null) {
        checkAnn = setAgeMethod.getAnnotation(Check.class);
        print(checkAnn.value());
    }
}
```
}

注解的使用场景?

注解是一系列元数据,可以提供一些数据来解释程序代码,并非代码的一部分,也不会对代码的运行有影响的。主要作用有3个:

  1. 提供信息给编译器,编译器可以利用注解来探测错误或告警信息。
  2. 编译阶段的处理:某些软件工具可以根据注解信息生成代码、html文档或者进行其他处理。
  3. 运行阶段的处理:某些注解可以在代码运行时候,被代码提取出来使用。

即注解本身是不会生效或者执行什么动作,它是被别人拿来用的。被编译器、软件工具、代码使用,提供辅助信息,可以看成一种特殊的注释信息。

例子,一个测试框架,测试代码是否正常:

  1. 定义注解
   @Retention(RetentionPolicy.RUNTIME)
   public @interface Jiecha {}
  1. 对被测试的代码添加注解
public class NoBug {
 @Jiecha
 public void jiafa(){
     System.out.println("1+1="+1+1);
 }

@Jiecha
 public void chufa(){
     System.out.println("6 / 0="+ 6 / 0);
 }

 public void jianfa(){
     System.out.println("1-1="+(1-1));
 }
}
  1. 抽取注解,进行测试

    public class TestTool {
    
     public static void main(String[] args) {
     NoBug nobug = new NoBug();
     
    
    ```
    Class clz = nobug.getClass();
    Method[] methods = cls.getDeclaredMethods();
    
    for (Method m : methods) {
     if (m.isAnnotationPresent(Jiecha.class) {
         try {
             m.setAccessible(true);
             m.invoke(nobug, null);
             
         } catch (Exception e) {
             print("错误报告");
         }
     }
    }
    ```
    }
    }
    

使用注解时,需要借助反射,但反射比较慢,所以需要谨慎计算时间成本。

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

推荐阅读更多精彩内容

  • 从JDK5开始,Java增加了Annotation(注解),Annotation是代码里的特殊标记,这些标记可以在...
    CarlosLynn阅读 551评论 0 2
  • 两年前,我只是一个每天重复着单调的工作,课外时间没有任何爱好的青年。工作、生活、婚姻、家庭早没有激情。突然...
    春26阅读 163评论 0 0
  • 请大家坐在垫子中央,面向过道的方向。双脚向前伸直,脚背回勾。双手放于臀部旁侧后侧边缘,指腹点地,指尖朝前,手肘内夹...
    Iris_huang阅读 927评论 0 0
  • Angular2中包含了一个路由框架,我们只需要定义一个个的路径和它对应的组件,然后在页面跳转时也是用Angula...
    小孩真笨阅读 456评论 0 0