注解的那些事儿(二)| 如何自定义注解

自定义注解是自己写框架的必备技能,使用注解能极大地提升开发效率,因此自定义注解是一个高级开发者必备的技能。

要自定义注解,首先需要了解一个注解的构成部分。

一个注解大致可以分为三个部分:注解体、元注解、注解属性

在在这三个主要组成部分中,注解体指定了注解的名字,而元注解则标记了该注解的使用场景、留存时间等信息,而注解属性则指明该注解拥有的属性。

注解体

注解体是最简单的一个组成部分,只需要实例中一样有样学样即可。与接口的声明唯一的不同是在 interface 关键字前多了一个 @ 符号。

//声明了一个名为sweet的注解体
@Retention(RetentionPolicy.RUNTIME) 
public @interface sweet{
}

元注解

元注解(meta-annotation)本身也是一个注解,用来标记普通注解的存留时间、使用场景、继承属性、文档生成信息。

元注解是一个特殊的注解,它是 Java 源码中就自带的注解。在Java 中只有四个元注解,它们分别是:@Target、@Retention、@Documented、@Inherited。

@Target注解

Target 注解限定了该注解的使用场景。

它有下面这些取值:

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE}) 
public @interface Autowired { 
    boolean required() default true;
}

在上面 Autowire的 注解中,其 Target 注解的值为 CONSTRUCTOR、METHOD、PARAMETER、FIELD、ANNOTATION_TYPE 这 5 个值。这表示 Autowired 注解只能在构造方法、方法、方法形参、属性、类型这 5 种场景下使用。

@Retention注解

Retention 注解用来标记这个注解的留存时间。

它其有四个可选值:

  • RetentionPolicy.SOURCE。注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS。注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME。注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
@Retention(RetentionPolicy.RUNTIME) 
public @interface Autowired { 
    boolean required() default true;
}

在上面 Autowire的 注解中,其 Retention 注解的值为 RetentionPolicy.RUNTIME,说明该注解会保留到程序运行的时候。

@ Documented 注解表示将注解信息写入到 javadoc 文档中。

在默认情况下,我们的注解信息是不会写入到 Javadoc 文档中的。但如果该注解有 @Documented 标识,那么该注解信息则会写入到 javadoc 文档中。

例如在下面这个例子中,我们声明了一个 @Spicy 的注解,没有 @Documented 元注解。

public @interface Spicy {
    String spicyLevel();
}

声明一个 @Sweet 注解,有 @Documented 元注解。

@Documented
public @interface Sweet {
    String sweetLevel();
}

接下来写一个 SweetDemo 类,类中的 sweetWithDoc 方法使用 @Sweet 注解,spicyWithoutDoc 方法使用 @Spicy 注解。

public class SweetDemo {
    public static void main(String arg[]) {
        new SweetDemo().sweetWithDoc();
        new SweetDemo().spicyWithoutDoc();
    }
    @Sweet (sweetLevel="Level.05")
    public void sweetWithDoc() {
        System.out.printf("sweet With Doc.");
    }
    @Spicy (spicyLevel="Level.04")
    public void spicyWithoutDoc() {
        System.out.printf("spicy Without Doc.");
    }
}

最后我们使用 Javadoc 命令去生成对应的 JavaDoc 文档,打开文档你会看到:sweetWithDoc方法上面有一个注解信息,而 spicyWithoutDoc 方法上却没有注解信息。

这个就是 @Documented 这个元注解的作用。

@Inherited

@ Inherited注解标识子类将继承父类的注解属性。

在下面的例子中,我们声明了一个 Sweet 注解,接着在 Peach 类使用了 @Sweet 注解,但是并没有在 RedPeach 类使用该注解。

//声明一个Sweet注解,标识甜味。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Sweet {}
//桃子有甜味
@Sweet
public class Peach {}
//红色的水蜜桃
public class RedPeach extends Peach {}

虽然我们没在 RedPeach 类上使用了 @Sweet 注解,但是我们在 Sweet 注解声明中使用了 @Inherited 注解,所以 RedPeach 继承了 Peach 的 @Sweet 注解。

注解属性

注解属性类似于类方法的声明,注解属性里有三部分信息,分别是:属性名、数据类型、默认值。

在 @Autowired 注解中就声明了一个名为 required 的 boolean 类型数据,其默认值是 true。

public @interface Autowired {
    boolean required() default true;
}

需要注意的是,注解中定义的属性,它的数据类型必须是 8 种基本数据类型(byte、short、int、long、float、double、boolean、char)或者是类、接口、注解及它们的数组。

总结

一个注解大致可以分为三个部分:注解体、元注解、注解属性。在这三个主要组成部分中:注解体指定了注解的名字、元注解则标记了该注解的使用信息,注解属性指明注解的属性。

学习注解只要知道这三个部分就够了,至于那些繁杂的属性,就用下面这张图来解决吧。用到的时候翻一翻,查一查,足矣!

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏前端桃园

知识体系解决迷茫的你

最近在星球里群里都有小伙伴说道自己对未来的路比较迷茫,一旦闲下来就不知道自己改干啥,今天我这篇文章就是让你觉得一天给你 25 个小时你都不够用,觉得睡觉都是浪费...

21440
来自专栏haifeiWu与他朋友们的专栏

复杂业务下向Mysql导入30万条数据代码优化的踩坑记录

从毕业到现在第一次接触到超过30万条数据导入MySQL的场景(有点low),就是在顺丰公司接入我司EMM产品时需要将AD中的员工数据导入MySQL中,因此楼主负...

29640
来自专栏钱塘大数据

理工男图解零维到十维空间,烧脑已过度,受不了啦!

让我们从一个点开始,和我们几何意义上的点一样,它没有大小、没有维度。它只是被想象出来的、作为标志一个位置的点。它什么也没有,空间、时间通通不存在,这就是零维度。

33030
来自专栏腾讯高校合作

【倒计时7天】2018教育部-腾讯公司产学合作协同育人项目申请即将截止!

15720
来自专栏Ken的杂谈

【系统设置】CentOS 修改机器名

18030
来自专栏微信公众号:小白课代表

不只是软件,在线也可以免费下载百度文库了。

不管是学生,还是职场员工,下载各种文档几乎是不可避免的,各种XXX.docx,XXX.pptx更是家常便饭,人们最常用的就是百度文库,豆丁文库,道客巴巴这些下载...

44530
来自专栏FSociety

SQL中GROUP BY用法示例

GROUP BY我们可以先从字面上来理解,GROUP表示分组,BY后面写字段名,就表示根据哪个字段进行分组,如果有用Excel比较多的话,GROUP BY比较类...

5.1K20
来自专栏腾讯社交用户体验设计

ISUX Xcube智能一键生成H5

51220
来自专栏钱塘大数据

中国互联网协会发布:《2018中国互联网发展报告》

在2018中国互联网大会闭幕论坛上,中国互联网协会正式发布《中国互联网发展报告2018》(以下简称《报告》)。《中国互联网发展报告》是由中国互联网协会与中国互联...

13550
来自专栏怀英的自我修炼

考研英语-1-导学

英二图表作文要重视。总体而言,英语一会比英语二难点。不过就写作而言,英语二会比英语一有难度,毕竟图表作文并不好写。

11810

扫码关注云+社区

领取腾讯云代金券

年度创作总结 领取年终奖励