Java源码注解(RetentionPolicy.SOURCE)

源码注解(RetentionPolicy.SOURCE)的生命周期只存在Java源文件这一阶段,是3种生命周期中最短的注解。当在Java源程序上加了一个注解,这个Java源程序要由javac去编译,javac把java源文件编译成.class文件,在编译成class时会把Java源程序上的源码注解给去掉。需要注意的是,在编译器处理期间源码注解还存在,即注解处理器Processor 也能处理源码注解,编译器处理完之后就没有该注解信息了。

(关于注解处理器Processor的详细用法放在编译时注解RetentionPolicy.CLASS里说明,或则可以先看这个:Java注解处理器使用详解

在这里就不用注解处理器来处理源码注解了,来看一个我之前看到的挺有用的用法。

自定义注解

在开始写注解前,先来考虑我们平时会遇到的一种情况:

我们定义的类有一个 int 型的状态参数要设置,但我们设置的状态又只能限定在[OPEN=1, CLOSE=2]这两种状态,如果我们要提供一个接口来设置的话,那么一种做法是定义一个Enum枚举来作为参数,这样就能限定参数的取值范围了,但是使用枚举会比常量占用更多的内存。

这里可以用注解来处理这种问题,也就是下面要讲的自定义源码注解,这里需要用到一个元注解@IntDef(限定整型数据范围),来看下代码:

/** 
 * 测试源码注解 
 */  
public class TestSourceAnnotation {  
  
    // 状态值  
    public static final int STATUS_OPEN = 1;  
    public static final int STATUS_CLOSE = 2;  
    private static int sStatus = STATUS_OPEN;  

    private TestSourceAnnotation() {}    
  
    // 定义适用于参数的注解,限定取值范围为{STATUS_OPEN, STATUS_CLOSE}  
    @Retention(RetentionPolicy.SOURCE)  
    @Target(ElementType.PARAMETER)  
    @IntDef({STATUS_OPEN, STATUS_CLOSE})  
    public @interface Status {  
    }  
  
    /** 
     * 定义方法并使用@Status限定参数的取值 
     * @param status 
     */  
    public static void setStatus(@Status int status) {  
        sStatus = status;  
    }  
  
    public static int getStatus() {  
        return sStatus;  
    }  
  
    public static String getStatusDesc() {  
        if (sStatus == STATUS_OPEN) {  
            return "打开状态";  
        } else {  
            return "关闭状态";  
        }  
    }  
}  

这里定义了一个@Status注解,并用注解@IntDef限定了取值范围,最后将@****Status注解用在参数上就行了,这样在使用调用方法的使用只能使用指定的参数{STATUS_OPEN, STATUS_CLOSE},就算用数值1编译器也会提示报错。除了@IntDef注解外还用一个@StringDef注解可以使用,用来处理字符串。

看下使用代码:

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,834评论 25 707
  • 此刻,我坐在咨询室里,静心的想了一下我的心理咨询职业,我不自觉的发笑了。 心理咨询的本质是协助解决正常人的不健康心...
    早晴心理咨询师阅读 263评论 2 2
  • 那年高中。 瑾。是我的同班同学。 他很好看,尤其是当太阳就这样子划过他的脸庞。眼睛里也充满了温柔的光。他有很多人...
    乔伊锦鲤阅读 343评论 0 0
  • 今天下午做饭熬了些油渣,色泽金黄的油渣酥脆可口,把我一下拉回了童年的时候,小时候最幸福的事就是过年时候在厨房站在母...
    成年小饭阅读 276评论 0 0