自定义注解

注解可以简单理解为代码的特殊标记,可以在编译、加载或运行时被加载。

1. 元注解

@Target 表示该注解使用范围

可选的ElementType参数有:
CONSTRUCTOR:用于构造器声明
FIELD:域声明(包括enum实例)
LOCAL_VARIABLE:局部变量声明
METHOD:方法声明
PACKAGE:包声明
PARAMETER:参数声明
TYPE:类、接口(包括注解类型)或enum声明

@Retention 表示注解保存级别

可选RetentionPolicy参数有:
SOURCE:注解将被编译器丢弃
CLASS:注解在class文件中可用,但会被VM丢弃
RUNTIME:VM将在运行期间保留注解,因此可以通过反射机制读取注解的信息

@Document 将注解包含到javaDoc中
@Inherited 允许子类继承父类注解

2. 自定义注解及使用

2.1. 创建注解类

public @interface SubscribeAnnotation {
}

2.2. 添加元注解

@Target(ElementType.METHOD) // 注解可用在方法上
@Retention(RetentionPolicy.RUNTIME) // 运行时保留,常用于与AOP组合,实现面向切面编程
// @Document
@Inherited // 子类重构的方法将继承该注解
public @interface SubscribeAnnotation {
}

2.3. 为注解增加“属性”

import common.Publish;
import java.lang.annotation.*;

/**
 * 自定义注释
 * @author pinzhong
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface SubscribeAnnotation {
    // 1. 未设置默认值的属性需在使用时明确指定其值
    // 2. 当只有一个没有默认值的属性且命名称为vale时,为其赋值时可省略参数名
    // 3. 此处结合使用时可理解为啥标题称之为【“属性”】
    String value(); 
    Class<? extends Publish> publish() default Publish.class;
}

2.4. 使用注解

创建一个类,根据自定义注释@Target的使用范围限制(示例中我们指定为方法)进行使用:

public class TestAnnotation {
    @SubscribeAnnotation(value= "testPub", publish = Publish.class) // 结合2.3中value()处3的注释
    public void publish(){}

    @SubscribeAnnotation("name") // 结合2.3中vale()的注释
    public void publish(String s){}

    public static void main(String[] args) {
        // 使用反射获取注解
        Method[] methods = TestAnnotation.class.getMethods();
        for (Method method : methods) {
            Annotation[] annotations = method.getAnnotations();
            if (annotations != null && annotations.length > 0)
                for (Annotation anno : annotations) {
                    if (anno.annotationType().equals(SubscribeAnnotation.class))
                        System.out.println("TestAnnotation." + method.getName() + " has SubscribeAnnotation annotation!");
                }
        }
    }
}

输出结果:

TestAnnotation.publish has SubscribeAnnotation annotation!
TestAnnotation.publish has SubscribeAnnotation annotation!

文末语:
自定注解其实很简单,简单来说定义一个@interface类,在其类上添加元注解标明该注解的使用范围、保存级别、是否保存到JavaDoc中、是否允许子类继承,最后添加“属性”即可;难处在使用上,后续会补充上该处文章。

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

推荐阅读更多精彩内容