美文网首页
Java注解学习笔记

Java注解学习笔记

作者: 留给时光吧 | 来源:发表于2018-05-13 16:13 被阅读0次

作为一个Android开发者,关于注解应该用的很多,比如大名鼎鼎的ButterKnife框架,就是主要依赖于注解实现的。在开发过程中我们也实际的体会到了注解的遍历。但是关于注解的开发,很多人却并不熟悉,一方面注解这个概念引入的较晚,大概在Java5.0时才引入。另一方面,关于它的一些高级操作都必须借助于反射,而很多人又对反射掌握的并不是很好。今天,在这里就把Java注解做一个学习。

首先注解其实就是一个接口,但是为了和接口进行区分,便是下面这个样子,这里我们先以最常见的Override注解为例:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

如上面所示,要定义一个注解只需像定义一个接口一样,但是要在interface前面加@符号。但是仅仅这样声明的话,这个注解是没有任何功能的。要使一个注解有功能,我们要先从元注解开始了解。

元注解就是几个基本注解,用于注解自定义注解的,就像Java中的基本数据类型。若是没有那几个基本类型,所有Java程序可能就无从谈起了。以上面Override 注解为例,它有两个元注解,分别是Retention和Target。元注解的功能就是定义个限制我们的注解的功能和行为。首先先来了解一下所有的元注解。

元注解并不多,因为它们是基本的注解,所以只覆盖一些重要的部分(就像基本数据类型一样),一共有下面5种:

  • 1、@Retention
    这个注解类似于一种声明周期的概念,他规定一个注解的存活时间。它的值为一个枚举类:RetentionPolicy。共有一下三种:
 RetentionPolicy.SOURCE //定义该注解仅在源码中保留,编译时便会被抛弃

 RetentionPolicy.CLASS  //定义该注解只保留到字节码文件中,但不会被加载到虚拟机

 RetentionPolicy.RUNTIME //定义该注解最后会被加载到虚拟机中,运行时可得

就像那个Override 注解一样,他只是标记某个方法是父类的重写,对程序运行没有任何影响,为了不增大程序体积,所以只需在源码阶段保留,做一个提示就好。

  • 2、@Target
    这个注解规定该注解的应用范围,以Override 为例,他只是标记该方法是否是重写方法,所以只能用在方法上,也就是METHOD,该元注解的值是枚举类ElementType,一共有下面几个值:
    ElementType.TYPE //可以用在类,接口(包括注解),枚举

    ElementType.FIELD  //可以用在成员变量(包括枚举值)

    ElementType.METHOD  //可以用在方法上

    ElementType.PARAMETER //可以用在参数上

    ElementType.CONSTRUCTOR //可以用在构造方法上

    ElementType.LOCAL_VARIABLE  //可以用在局部方法

    ElementType.ANNOTATION_TYPE //可以用在注解上

    ElementType.PACKAGE //可以用在包上

    ElementType.TYPE_PARAMETER //用来标注类型参数

    ElementType.TYPE_USE //能标注任何类型名称
  • 3、@Documented
    这个注解意味着该注解将包含在 javadoc 中 ,将会被javadoc工具提取成文档
  • 4、@Inherited
    以这个注解修饰的注解去标注一个类时,这个类的子类也同样会拥有该注解。说起来比较拗口,下面代码解释一下:
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{}


@MyAnnotation
public class A {}


public class B extends A {}

在上面代码中B虽然没有MyAnnotation注解,但是A有,而且MyAnnotation有Inherited声明,所以B也有MyAnnotation注解。

  • 5.@Repeatable
    这是Java1.8的新特性,他表示一个注解可以重复注解多次。我们举一个例子:

正常情况下重复一个注解会报错:



但是我们做如下修改后·:

@Retention(RetentionPolicy.RUNTIME)
public @interface Values {
    MyAnnotation[] value();
}

@Repeatable(value = Values.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String Author() default "chen";
}

这样就不会报错了:



至于多个注解的值可以这样取:

if (MyClass.class.isAnnotationPresent(Values.class)){
            Values values = MyClass.class.getAnnotation(Values.class);
            for (MyAnnotation annotation : values.value())
                System.out.println(annotation.Author());
        }

上面介绍了5种元注解,下面介绍注解本身的知识,注解本身其实相当于一种接口,我们应用注解时,就相当于实现注解中的方法。那么注解作为一种特殊的存在,他的方法有没有什么特殊要求呢?

这里要说明的是,注解实际上是没有方法的,它只有成员变量,但是成员变量的声明和接口方法很类似,只不过都是无参的形式。所以怎样理解都行。首先注解的成员类型只能为基本数据类型、类、接口或者是注解。它可以有默认值,以default关键字修饰。举例如下:

public @interface MyAnnotation {
    String Author() default "chen";
}

在使用时如下:

@MyAnnotation(Author = "liu")
public class MyClass {
    @MyAnnotation(Author = "li")
    public void fun(){

    }
}

另外,如果一个注解仅有一个名字为value的成员变量时,应用是括号中可以直接写值,而不必写变量名,如在上面的Repeatable注解中的例子,MyAnnotation 可以这样写:

@Repeatable(Values.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String Author() default "chen";
}

上面就是注解的定义和应用。但是仅有这样是不够的,注解依其字面意思就可以知道,就类似与注释标签的意思,注解是用来给别人看的,那么我么你在程序运行中,怎么拿到注解的内容呢?

首先,对于类的注解可以这样:

if (MyClass.class.isAnnotationPresent(MyAnnotation.class)){
        MyAnnotation annotation = MyClass.class.getAnnotation(MyAnnotation.class);
        System.out.println(annotation.Author());
}

也就是首先判断某各类是否有某个注解,然后再拿到该注解,然后取值。对应的还有一个更笼统的方法:isAnnotation();判读时候有注解修饰,然后拿到全部注解:getAnnotations()。

其次对于成员变量或者方法的注解,则要依靠反射了:

        try {
            Method testMethod = MyClass.class.getDeclaredMethod("fun");
            MyAnnotation annotation = testMethod.getAnnotation(MyAnnotation.class);
            if (annotation!=null)
                System.out.println(annotation.Author());
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }

对于方法,没有判断是否有某个注解的方法,只能直接去取,不为空的话就是有,然后再取值就可以,当然也可以拿到全部注解:getAnnotations()。

对于方法中的参数也很简单:

            Method method = MyClass.class.getDeclaredMethod("fun");
            MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
            Parameter parameter = method.getParameters()[0];
            parameter.getAnnotation(MyAnnotation.class);

基本套路都是一样的,关键是借助于反射。

到这里注解的介绍基本上就完成了,不能否认,注解如果运用恰当,绝对是一个强大的工具。

相关文章

  • Java反射机制学习笔记

    上一篇《java注解学习笔记》中最后说到了注解的实现主要依赖java的反射机制,那么这一篇主要介绍一下java的反...

  • JAVA注解学习笔记

    学习书籍 JAVA编程思想(第四版)第20章 java SE5中引入的新特性之一,并在java.lang中内置了几...

  • Java注解学习笔记

    什么是Java注解 注解:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本...

  • Java注解学习笔记

    作为一个Android开发者,关于注解应该用的很多,比如大名鼎鼎的ButterKnife框架,就是主要依赖于注解实...

  • Java 注解 学习笔记

    Java 注解 学习笔记 前言: 注解是一个很早就出现的技术,之前一直没有时间就这么拖着,现在闲暇之时学习一下,...

  • Java 注解 学习笔记

    我们平常写Java代码,对其中的注解并不是很陌生,比如说写继承关系的时候经常用到@Override来修饰方法。但是...

  • java注解学习笔记

    注解的定义 官方定义:Java注解用于为Java代码提供元数据。作为元数据,注解不直接影响你的代码执行,但也有一些...

  • Java注解学习笔记

    注解是Java提供的一种原程序中的元素关联任何数据和任何信息的一种途径和方法。 注解的分类 按运行机制分 源码注解...

  • 关于注解

    自己学习笔记,仅供自己参考,如有不对欢迎指正 1.source注解,生命周期存活与Java源文件(.java文件)...

  • 相关文章

    我的笔记核心理论基础、Socket通信原理、RPC远过程调用协议、Dubbo博客 java注解-01、java注解...

网友评论

      本文标题:Java注解学习笔记

      本文链接:https://www.haomeiwen.com/subject/flikdftx.html