自定义注解之源码注解(RetentionPolicy.SOURCE)

http://blog.csdn.net/github_35180164/article/details/52119731

源码注解(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());  
}  
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,964评论 25 709
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,992评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,099评论 19 139
  • 在他的人生之火几乎就要熄灭时,老师为他燃起了一支蜡烛…… 那一年,他念高三。他父母都是农民,吃苦耐劳,挣的...
    欢喜轩阅读 397评论 0 5
  • 儿时梦想,旧时乾坤。二十载,天南海北。忆往昔,岁月如歌。陡相见,人过半百。相拥时,泪洒衣襟。说不完的春花秋月,道不...
    阿杜阿云阅读 117评论 0 1