java自定义注解(Annotation)

java用 @interface Annotation{ } 定义一个注解 @Annotation,一个注解是一个类。自定义注解之前我们先看一下java里已经定义好的一些注解。
@Override,@Deprecated,@SuppressWarnings为常见的3个注解。

@Override

@Override表示子类重写了父类的方法,或者实现了接口的方法。帮助开发者确认子类是否正确的覆盖了父类的方法,若父类中没有此方法,编译器即报错。但是,子类与父类有同样的方法,但子类的方法上没有@Override注解,是不会报错。


image.png

image.png

@Deprecated

注解@Deprecated,用来表示某个类的属性或方法已经过时,不想别人再用时,在属性和方法
上用@Deprecated修饰,如图:


过期方法

image.png

@SuppressWarnings

@SuppressWarnings是抑制警告的意思。比如新建一个变量,但是没有用,编译器会提示此变量未使用(unused)的警告。如果在方法中,添加了@SuppressWarnings({"unused"})的相关注解,这个警告就不会再提示了。


image.png
    @SuppressWarnings({"unused"})
    public static void main(String[] args) {
        int a=10;
    }

image.png

image.png

image.png

通过以上常见注解 我们来总结下规律
1.@interface 是声明注解的关键字(就像定义接口时 关键字是 interface)
2.在注解中使用的都是 java.lang.annotation包下的类与接口

image.png

3.Annotation 所有注释类型扩展的公共接口。 注意,手动扩展这个接口不限定注释类型。 还要注意,此接口本身并不定义注释类型。
image.png

4.在java.lang.annotation包下有已经定义好的注解,我们可以直接拿过来用。
Java提供了4种注解,专门负责新注解的创建,叫做元注解。
分别为
@Target
@Retention
@Documented
@Inherited

@Target

里面有个方法 value() 返回值是ElementType数组

image.png

用于描述注解的使用范围,有一个枚举ElementType来指定,具体如下:
CONSTRUCTOR:用于描述构造器
FIELD:用于描述域
LOCAL_VARIABLE:用于描述局部变量
METHOD:用于描述方法
PACKAGE:用于描述包
PARAMETER:用于描述参数
TYPE:用于描述类、接口(包括注解类型) 或enum声明
image.png

如下这个Person注解,说明Person注解只能添加到方法上 。

@Target(ElementType.METHOD)
 public @interface Person{ 
}
自定义注解

使用自定义注解

@Retention

@Retention元注解,表示需要在什么级别保存该注释信息(生命周期)。可选的RetentionPoicy参数包括:
里面有个方法 value() 返回值是RetentionPolicy 保留策略

image.png

@Retention(RetentionPolicy.CLASS)修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,但不会被虚拟机读取在运行的时候;
@Retention(RetentionPolicy.SOURCE )修饰的注解,表示注解的信息会被编译器抛弃,不会留在class文件中,注解的信息只会留在源文件中;
@Retention(RetentionPolicy.RUNTIME )修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,会被虚拟机保留在运行时,


RetentionPolicy保留策略

这里我们常用的是虚拟机运行时所以使用RetentionPolicy.RUNTIME

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Person {
}
image.png

@Documented

@Documented:它是一个标记注解,即没有成员的注解,用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化


image.png

如果用javadoc生成文档时,想把注解也生成文档,就加这个注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Person {
    
}
image.png

@Inherited

被@Inherited标注的类型是可被继承的,比如一个class被@Inherited标记,那么一个子类继承该class后,则这个annotation将被用于该class的子类。


image.png
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Person {
    
}

下面使用元注解来自定义个注解并使用
类注解

import java.lang.annotation.*;
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Documented
public @interface Person {
     String value() default "我是人类";
     String say() default "我是人类";
     String[] organs() default {"耳朵", "眼睛", "鼻子", "嘴"}; 
}
import java.lang.reflect.Field;

@Person
public class Girl {
    
    @Person("我是女孩")
    public String info;
    

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        method2();
    }
    
    public static void method2() {
         Class<Girl> c = Girl.class; 
        //因为注解是在成员字段上,因此需要获得类的所有字段信息
            Field[] fields = c.getDeclaredFields();
            for (Field field : fields) {
                //判断这个字段上是否有相应的注解信息(Person.class)
                if (field.isAnnotationPresent(Person.class)) {
                    Person p = field.getAnnotation(Person.class);
                    System.out.println("信息自述为:"+p.value());
                }
            }
    }
    
    public static void method1() {
         Class<Girl> c = Girl.class;  
          //如果Girl类名上有注解@MyAnnotation修饰,则为true 
          if(Girl.class.isAnnotationPresent(Person.class))  
          {  
           System.out.println("have annotation");  
        // 若存在就获取注解
           Person annotation = (Person) Girl.class.getAnnotation(Person.class);
          System.out.println(annotation);
          // 数组
          String[] arrs = annotation.organs();
          for (String arr : arrs) {
              System.out.println(arr);
          }
          // 获取注解方法
          System.out.println(annotation.say()); 
          }  
          
    }

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

推荐阅读更多精彩内容

  • java自定义注解Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置...
    半路和尚怎么出家阅读 4,549评论 0 3
  • 深入理解Java:注解(Annotation)自定义注解入门 要深入学习注解,我们就必须能定义自己的注解,并使用注...
    _npc_阅读 541评论 0 0
  • 概念 作用在类、方法、成员变量上 与业务逻辑无关,有类似切面的概念,起辅助作用 可以在编译和运行时起作用 作用 生...
    当当一丢丢阅读 499评论 0 0
  • 关于工作:对于升级组件来说,看到了一个Interceptor的自定义注解,定义了几个参数,如果为true,使用特殊...
    superxcp阅读 786评论 0 0
  • 黑云煞有其事从西边压向东边,天被风婆子吵的眯西着眼,一阵呼啸的疾风扇过25楼的窗户,遮光帘被掀得老高,职场...
    木雨瑾阅读 578评论 0 3