Java基础——注解

基本概念

在JAVA中我们都知道有注释的概念,注释有单行注释多行注释文档注释。这种注释是给开发人员看的。
而在JAVA中的注解是给程序看的,用于告知程序一些东西

注解(Annotation) 也叫元数据。一种代码级别的说明。它是JDK1.5以后版本引入的一个特性,与类、接口、枚举是在同一个层次。可以声明在包、类、字段、方法、局部变量、方法参数等前面,用来对这些元素进行说明,注释

作用分类

  1. 编写文档:通过代码里标识的元数据生成文档[生成doc文档]
  2. 代码分析:通过代码里标识的元数据对代码进行分析[使用反射]
  3. 编译检查:通过代码里标识的元数据让编译器能实现基本的编译检查[Override]

JDK中预定义的一些注解

  • @Override
    用于检测被该注解标注的方法是否是继承自父类的
  • @Deprecated
    将该注解标注的内容,已过时
  • SuppressWarnings
    抑制警告

自定义注解

格式:

元注解
public @interface 注解名称{
属性列表
}

  • 注解的本质上就是一个接口,该接口默认继承Annotation
public interface MyAnno extends Annotation{
}

注解本质上就是个接口,那么我们也就知道 接口中可以定义的在注解中也可以定义。

注解的属性

接口中可以定义成员方法,这些成员方法被称作注解的属性

  • 要求
  1. 属性的返回值类型
  • 基本数据类型
  • String
  • 枚举
  • 注解
  • 以上类型的数组
    这里我们发现,注解属性的返回值类型没有void类型,所以在注解中定义的方法不能用void
  1. 定义了属性,在使用时需要给属性赋值,
    1. 多个属性的赋值可以使用,隔开。
    2. 如果在使用的时候不想给注解的属性赋值,可以在定义时添加default默认值
    3. 如果只有一个注解的属性需要赋值,并且属性的名称是value。则value可以省略。直接定义值即可。
    4. 给数组赋值,使用{}包裹,如果数组中只有一个值,则{}可以省略
      我们来演示一下,现在我们有一个自定义的注解MyAnno,其中定义了一些注解属性
      MyAnno.java
public @interface MyAnno {
    int myInt();
    String myString();
    MyAnno2 myAnno2();
    MyEnum myEnum();
    String[] strs();
    double value();
}

MyAnno2.java

public @interface MyAnno2 {
}

MyEnum.java

public enum MyEnum {
    my1, my2;
}

在使用MyAnno注解时
Example.java

@MyAnno(myInt = 1,myString = "myString",myAnno2 = @MyAnno2,strs = {"a","b","c"},myEnum = MyEnum.my1, value = 2.23d)
public class Example {
}

我们可以看到,在使用注解时,需要对注解中的属性进行赋值,如果注解中有value的属性 则使用value=进行赋值

元注解

元注解:用于描述注解的注解,元注解也是一个注解
我们来看一下JDK预定义的注解中的元注解的使用

  • Override
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

可以看到在Override上面的@Target @Retention就是元注解。
元注解也是预定义的。

  • @Target:描述注解能够作用的位置,作用于方法、类等
    使用Target元注解需要指定ElementType,ElementType是一个枚举类
    • @Target(ElementType.Type) 表示只能作用于类上
    • @Target(ElementType.Method) 表示可以作用于方法上
    • @Target(ElementType.FIELD) 表示可以作用于成员变量上
  • @Retention:描述注解被保留的阶段
    • @Retention(RetentionPolicy.SOURCE) 表示作用的注解会被抽取到源代码的javadoc的文档中
    • @Retention(RetentionPolicy.SOURCE)
    • @Retention(RetentionPolicy.RUNTIME) 表示作用的注解会保留到运行时阶段,会保留到class文件中,并被JVM读取到
  • @Documented:描述注解是否被抽取到api文档中
  • @Inherited:描述注解是否被子类继承

在程序中使用(解析)注解

解析注解步骤

  1. 获取注解定义的位置的对象(Class,Method,Field)
  2. 获取字节码文件对象的注解对象
  3. 调用注解对象中定义的抽象方法,获取配置的属性值
    我们定义一个注解,里面有两个返回String类型的抽象方法
  • ProAnno.java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ProAnno {
    String getClassName();

    String getMethodName();
}
  • UseAnno.java
@ProAnno(getClassName = "com.probuing.useanno.UseAnno",getMethodName = "hello")
public class UseAnno {
    public static void main(String[] args) {
        //获取注解定义位置的对象
        Class<UseAnno> aClass = UseAnno.class;
        //通过获取的对象获取注解对象
        ProAnno getClassName = aClass.getAnnotation(ProAnno.class);
        //调用注解对象中定义的抽象方法,获取配置的属性
        String className = getClassName.getClassName();
        String methodName = getClassName.getMethodName();
        System.out.println("anno className"+className);
        System.out.println("anno methodName"+methodName);
    }
}

在指定的对象中,有一个api方法可以快速的判断是否被指定的注解作用

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

推荐阅读更多精彩内容

  • 夯实 Java 基础 - 注解 不知道大家有没有一种感觉,当你想要了解某个知识点的时候,就会发现好多技术类 APP...
    醒着的码者阅读 1,044评论 4 7
  • 文章开头先引入一处图片。 这处图片引自老罗的博客。为了避免不必要的麻烦,首先声明我个人比较尊敬老罗的。至于为什么放...
    小乖心塞阅读 351评论 1 0
  • 注解基本概念 我们在开发当中经常看到一些注解,例如override,Deprected等,这些注解再常见不过了,但...
    zhonj阅读 1,059评论 0 0
  • java自定义注解 Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配...
    尼尔君阅读 515评论 0 0
  • 一、身教重于言传 孩子是上天赐予我们的天使,是我们自我修炼的镜子。孩子的言行举止很大程度上呈现了父母的影子。孩子的...
    知秋跃迁阅读 262评论 0 1