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

原创 2016年08月04日 16:45:07

源码注解(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());
}
总的来说还是挺好用的。

相关内容:自定义注解之运行时注解(RetentionPolicy.RUNTIME)

代码例子:AnnotationSample

深入理解编译注解(五)RetentionPolicy.SOURCE 和 RetentionPolicy.CLASS区别讨论

前言这篇我觉得应该是一个讨论篇,因为我自己还没有找到一个非常满意的答案,希望大家一起来讨论。正文元注解RetentionPolicy,表明注解的生命周期: 1、SOURCE:在原文件中有效,被编译...

自定义注解之运行时注解(RetentionPolicy.RUNTIME)

对注解概念不了解的可以先看这个:Java注解基础概念总结 前面有提到注解按生命周期来划分可分为3类: 1、RetentionPolicy.SOURCE:注解只保留在源文件,当Java文件编译成clas...

自定义注解之编译时注解(RetentionPolicy.CLASS)(一)

说到编译时注解(RetentionPolicy.CLASS)都要和注解处理器(Annotation Processor)扯上关系,因为这里是真正体现编译时注解价值的地方。需要注意的一点是,运行时注解(...

Java注解-注解处理器(编译期|RetentionPolicy.SOURCE)

简单介绍编译注解如何工作。
  • N_ou25
  • N_ou25
  • 2016年01月19日 13:41
  • 1722

Java注解(3)-注解处理器(编译期|RetentionPolicy.SOURCE)

转载地址:http://blog.zenfery.cc/archives/78.html 注解的处理除了可以在运行时通过反射机制处理外,还可以在编译期进行处理。在编译期处理注解时,会处理到不再产...
  • vite_s
  • vite_s
  • 2016年11月24日 16:44
  • 285

Delphi7高级应用开发随书源码

  • 2003年04月30日 00:00
  • 676KB
  • 下载

利用编译时注解生成Java源代码

编译时注解开发

java源码级注解处理+字节码级注解处理

【0】README 0.1)本文文字描述转自 core java volume 2, 旨在学习 java源码级注解处理+字节码级注解处理  的基础知识; -----------------------...

Java注解(3)-源码级框架

源码级框架是在javac编译源码时,生成框架代码或文件。因为源码级别框架发生过程是在编译期间,所以并不会过多影响到运行效率。因此,搭建框架时候应该优先考虑使用源码级别框架。...

Java编译时注解自动生成代码

在开始之前,我们首先申明一个非常重要的问题:我们并不讨论那些在运行时(Runtime)通过反射机制运行处理的注解,而是讨论在编译时(Compile time)处理的注解。注解处理器是一个在javac中...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:自定义注解之源码注解(RetentionPolicy.SOURCE)
举报原因:
原因补充:

(最多只允许输入30个字)