Java注解只需看这篇就可以

  • 什么是注解
  • 自定义注解
  • 如何获取注解信息

什么是注解

Java注解是在JDK5时引入的新特性,标记解释的意思。
Java常用注解有

@Override   用于标明此方法覆盖了父类的方法
@Deprecated 废弃,这个类或者方法,变量已经废弃

如废弃代码如下:

@Deprecated
public class CustomProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

自定义注解

明白了注解是标记相关信息,那我们该如何在开发中自定义注解,实现相关简写了。大概几个步骤

  1. 用@interface标识类
  2. 用元注解标识自定义相关属性:
@Target标记运用的地方,
@Retention标记保留期
@Documented标记内容到Javadoc 中
@Inherited标记是否可以继承
用@interface标识。
@Target 指定了注解运用的地方,有以下几种取值
  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
@Retention标记保留期

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。它的取值如下:

  • RetentionPolicy.SOURCE
    注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS
    注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME
    注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们

生命周期长度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方后者一定也能作用。
如果只是做一些检查性的操作,比如 @Override 和 @SuppressWarnings,则可选用 SOURCE 注解。
如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS注解;
一般如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;

用@Documented标记注解中的元素包含到 Javadoc 中去
用元注解@Inherited标记是否可以继承

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解
完整的自定义注解示例:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface CustomAn {
    String value();
}

自定义注解完成。

如何处理注解

自定义好注解和内容,注解除了标识标记的意思,其实我们还可以通过注解处理器在程序编译阶段对注解的对象(类,方法)进行生成代码。那我们可以怎么处理注解呢?
分两种情况

  • 定义为@Retention(RetentionPolicy.RUNTIME)的注解就可以运行期中通过反射获取相关信息(如果不是设置为这个,使用反射获取不到注解信息)如代码:
public class TestAnim {
    @CustomAn(value = "1234")
    public void animTest() {

    }

    public static void main(String[] args) {
        TestAnim testAnim = new TestAnim();
        try {
            //反射获取指定类的方法
            Method method = testAnim.getClass().getMethod("animTest");
            //判断方法是不是使用了TestAnim注解
            if (method.isAnnotationPresent(CustomAn.class)) {
                //获取注解类
                CustomAn customAn=method.getAnnotation(CustomAn.class);
                //打印注解值
                System.out.println(customAn.value());
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
    }
}
  • 定义为@Retention(RetentionPolicy.CLASS)的注解,我们可以使用注解处理器(注解处理器,不是注解,分清概念),在项目编译的时候(.Java源码编译时期)使用注解处理器对指定注解的类,方法等进行处理生成相对应代码。需要对注解做怎么样的处理?那就需要自定义对指定注解做处理。

好了注解基础已经讲完了,如果都熟悉了可以关注Android项目实际使用APT使用

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

推荐阅读更多精彩内容