那些高端、优雅的注解是怎么实现的 <1> -- 自定义注解语法

概述

使用元注解来定义我们自己的注解,就是自定义注解。
一个自定义注解可能像下面这样

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Message {
    String decr() default "类名";

    String author();

    int age();

}

接下来,我们下如何定义,各个关键字、元注解的作用。

自定义注解系列文章

一:使用@interface关键字定义

使用@interface关键字定义一个注解,@interface 后面是自定义注解的名称,如下所示。

image

二:声明成员

注解可以有0到多个成员,下面看下如何声明。

  • 成员不能有参数,不能抛出异常,


    image
  • 当成员有参数或抛出异常则会报错时,编译器会报错


    image
  • 成员类型受限:只能为 Java 基本数据类型、String、ClassAnnotation 、Enumeration

  • 如果只有一个成员,该成员应该命名为 value,可以在使用时忽略成员名和赋值号(=),如果命名为其他的,虽然不会报错,但不能忽略成员名和赋值号。并且这是个约定俗成的做法,就不要杠了

  • 用default指明成员的默认值


    image
  • 注解类可以没有成员,这样的注解称为标识注解

三:元注解

元注解是用来注解注解的原始注解,每个元注解有不同的作用和用法,下面逐一看下。

1.@Target({})

指明作用范围。可以同时指定多个枚举,从而使得该注解可以作用到多个场合。
如作用范围为@Target({ElementType.TYPE,ElementType.METHOD})的注解,就可以注解在类声明和方法声明的地方。下面是指定范围的枚举值说明

  • TYPE:类、接口(包括注释类型)或枚举声明

  • FIELD:字段声明(包括枚举常量)

  • METHOD:方法声明

  • PARAMETER:参数声明

  • CONSTRUCTOR:构造函数声明

  • LOCAL_VARIABLE:局部变量声明

  • ANNOTATION_TYPE:注解类型声明

  • PACKAGE:包申明

  • TYPE_PARAMETER: 类型参数声明(1.8新加入),表示这个注解可以用来标注类型参数

  • TYPE_USE:类型使用声明(1.8新加入),用于标注各种类型,只要是类型名称,都可以进行注解

2.@Retention()

指明生命周期(分类的时候根据生命周期分类就是依据这个),生命下周起只能指定一个

  • SOURCE(源码):Annotations are to be discarded by the compiler.(会被编译器抛弃)

  • CLASS(class期间):Annotations are to be recorded in the class file by the compiler,but need not be retained by the VM at run time. This is the default behavior.(在.class 期间存在,在VM期间被抛弃,也是默认生命周期)

  • RUNTIME(运行期) :Annotations are to be recorded in the class file by the compiler and retained by the VM at run time, so they may be read reflectively.(一直保留到运行期间,所以可以通过反射获取)

3.Inherited

标识注解,允许子类继承父类的注解,即它所标注的注解将具有继承性。(后面会详细阐述)

4.Documented

也是标识注解,生成javadoc时是否会包含注解

四:使用自定义注解

1.一般注解使用方式

假设有如下注解

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Message {
    String decr() default "类名";

    String author();

    int age();

}

可以像如下方式使用

@Message(decr = "动物类",author = "zhang",age = 28)
public class Animal {
    String name;
    String age;

   }

当然因为有作用域的限制,不能把作用在方法声明上的注解用在类名声明上。我上面这个自定义注解既可以用在类声明上也可以用在方法声明上。

2.只有一个成员的注解使用方式

如下注解


@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Message {
    String value() default "类名";
    
}

就可以像下面这样使用,可以省略参数名和赋值号(=)

@Message("动物类")
public class Animal {
    String name;
    String age;
   }

五:总结

现在这样的自定义注解,虽然可以使用了。并没有什么特别的功能呢,也不会影响业务逻辑。现在你还看不到注解的强大和魅力,下一节注解的解析,才是注解强大的关键。

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

推荐阅读更多精彩内容