深入浅出注解,框架设计的基础

何为注解

注解(Annotation)是 Java 中的一个类型,通俗地理解就像一个标签,贴在了代码上。众所周知,Spring 支持大量注解,基于注解可以完成 Bean 的注入和生命周期管理,注解也是取代 xml 配置的一种方法。使用注解可以把元数据和源代码绑定在一起,可以用于描述代码无法描述的信息,并在编译或运行中使用。

在 Java 中使用注解非常简单,比如我们可以定义一个用于标记类型的注解,并根据这个注解从 Spring 中提取出相应的 Bean。在这段代码中,我们使用了 Java 自带的注解 @Retention、@Override,Spring 提供的注解 @Service、@PostConstruct,以及自定义的注解 @MyAnnotation。

@Service
@MyAnnotation
public class TestAnnotation implements ApplicationContextAware {
    ApplicationContext context;

    //定义一个注解
    @Retention(RetentionPolicy.RUNTIME)
    @interface MyAnnotation{}

    @Override
    public void setApplicationContext(ApplicationContext context) throws BeansException {
        this.context = context;
    }

    @PostConstruct
    private void init(){
        Map<String, Object> beans = context.getBeansWithAnnotation(MyAnnotation.class);
        System.out.println("找到 bean " + beans.keySet());
    }
}

定义注解

定义注解非常像定义接口,在 interface 关键词前面加了一个 @。实际上,注解类型与其他类型一样,最终也是编译成 class 文件。定义注解需要用到一些元注解,这些元注解是 Java 语言提供的,用来定义注解的一些特性。

元注解 @Inherited 用于声明该注解支持子类继承父类中的注解。

元注解 @Documented 用于声明该注解需要包含到 Javadoc 中。

元注解 @Retention 定义注解的级别,可选值定义在 RetentionPolicy 枚举类,包括运行时(RUNTIME)、类文件(CLASS)、源代码(SOURCE)。

元注解 @Target 定义注解的使用范围,值的类型是 ElementType 枚举值。注解的使用范围可以设置一个或多个,常用的有 ElementType.TYPE 表示用于 Java 类、ElementType.METHOD 表示用于 Java 方法、ElementType.FIELD 表示用于类的字段、ElementType.PARAMETER 表示用于方法的参数。

注解支持定义元素,定义的形式有点类似方法定义,并可以使用 default 设置默认值。如下代码中定义的值为 value,获取值调用 value() 即可,如果使用时没有给出值则默认值为 test。需要注意的是注解的默认值不能是 null,最终一定会有一个值。如果需要表示值不存在,需要自己定义一个特殊值来表示。

注解的元素类型支持基本类型、String、Class、enum、Annotation 以及这些类型的数组。

//定义一个注解
@Inherited
@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation2 {
    String value() default "test";
}

从 Java 8 开始,新增了元注解 @Repeatable,用于表示注解可以有多个值。如下的代码 SingleAnnotation 可以有多个值,使用 @Repeatable 声明了多个值合并为注解 @RepeatAnnotation。这种情况下,@RepeatAnnotation 的元素必须有 value,且类型必须为 SingleAnnotation 数组,才能进行聚合。

使用时,@SingleAnnotation 可以定义多次给出多个不同的值,解析注解时则需要按照 @RepeatAnnotation 进行解析。关于注解的解析,请参考后文注解处理器。

@Retention(RetentionPolicy.RUNTIME)
@interface RepeatAnnotation {
    SingleAnnotation[] value();
}

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(RepeatAnnotation.class)
@interface SingleAnnotation{
    String value();
}

@SingleAnnotation("hello")
@SingleAnnotation("world")
public class RepeatAnnotationTest{
    public static void main(String[] args){
        RepeatAnnotation annotation = RepeatAnnotationTest.class.getAnnotation(RepeatAnnotation.class);
        for (SingleAnnotation singleAnnotation : annotation.value()) {
            System.out.println(singleAnnotation.value());
        }
    }
}

Java 中的注解不支持继承,因此不能使用 extends 关键字。但是注解可以进行嵌套,也就是一个注解的值是另一个注解。如下的代码中,MyAnnotation3 注解的第二个值类型为 MyAnnotation2,使用时对第二个值赋值一样需要按照注解的格式写为 @MyAnnotation2("world")。

public @interface MyAnnotation3 {
    String value() default "test";
    MyAnnotation2 annotation();
}

@MyAnnotation3(value = "hello"
    ,annotation = @MyAnnotation2("world"))
private void test2(){}

注解处理器

定义注解以后需要编写注解处理器,才能发挥注解的作用。在最开始的例子中,我们定义的注解处理器从 Spring 上下文中找出所有使用了注解 MyAnnotation 的 Java Bean,然后打印出这些 Bean 的名字。

@PostConstruct
private void init(){
    Map<String, Object> beans = context.getBeansWithAnnotation(MyAnnotation.class);
    System.out.println("找到 bean " + beans.keySet());
}

在 Java 中可以通过反射很方便地处理注解。对于 Class 上面的注解,可以通过 Class 的方法获取所有注解或指定注解,如下所示。

//获取类型的所有注解
TestAnnotation.class.getAnnotations();
TestAnnotation.class.getDeclaredAnnotations();
//获取类型的指定注解
TestAnnotation.class.getAnnotation(MyAnnotation.class);
TestAnnotation.class.getDeclaredAnnotation(MyAnnotation.class);

对于方法上的注解,可以通过 Method 的方法获取所有注解或指定注解,如下所示。Method 还提供了 getParameterAnnotations() 来获取方法参数上面的所有注解,每个参数的注解都是一个数组,返回值为二维数组。

Method init = TestAnnotation.class.getDeclaredMethod("init");
//获取方法的所有注解
init.getAnnotations();
init.getDeclaredAnnotations();
//获取方法的指定注解
init.getAnnotation(PostConstruct.class);
init.getDeclaredAnnotation(PostConstruct.class);
//获取方法的参数的所有注解,返回二维数组
init.getParameterAnnotations();

对注解进行处理时,注解可以当做普通的变量对待。如下代码所示,annotation 是一个注解类型的变量,与普通变量区别不大,可以有类型定义,值也可以是 null。但是读取注解的值时,需要调用方法,如 annotation.value()。

MyAnnotation2 annotation = TestAnnotation.class.getAnnotation(MyAnnotation2.class);
if(annotation != null){
    System.out.println(annotation.value());
}

结语

关于 Java 注解,本文只覆盖这些内容。注解是一个被广泛使用的特性,如 Java 本身的 @Override、Spring 中的 @Service @Autowired、MyBatis 中的 @Insert @Update 等。基于注解,实现了对代码的自动化处理,如扫描和自动注入 JavaBean,大大简化了 Java 程序员的开发工作。正因如此,我们不仅需要了解常用的注解使用方式,还需要深入理解注解背后的工作原理。

本文首发于公众号程序之心,每天给你诚意满满的干货,欢迎关注。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,748评论 6 342
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,119评论 15 116
  • 南京,并不陌生的城市。第一次见她,七岁不到,小学一年级的五一黄金周,妈妈带着我到江苏一带旅游。或许是太小不懂事,也...
    众知阅读 253评论 1 0
  • 毛毛站在家门口,犹豫了很久很久不敢进去,手里是折成一小块的试卷。78分。 毛毛的爸爸妈妈望子成龙非常严厉,对于学习...
    拾光人生阅读 414评论 3 2