Android注解:Java注解

java 注解语法

注解定义

modifiers @interface AnnotationName {
	elementDeclaration1
	elementDeclaration2
}

java注解通过@interface进行定义;例:

public @interface TestAnnotation {
	String name() 
}

其实这个和定义接口没啥区别,只是在interface关键字前加了一个@

注解元素声明

注解的元素声明形式

type elementName()//形式1
type elementName() default value//形式2

Type可以是基本类型(int,byte,long等)、String、Class(可以是泛型,Class)、enum、注解、以及前面所述类型的数组

注解元素赋值

注解元素赋值的一般形式是@AnnotationName(element1=value1,element2=value2),但是注解元素的赋值还有两种快捷方式。

  • 使用注解时,如果没有指定元素赋值,要么是注解中没有任何元素,要么注解的所有元素都有默认值,那么你就不需要使用圆括号

例如@Bugreport

  • 如果注解有一个元素具有特殊的名字value,并且在使用注解是没有指定其他元素,那么你就可以忽略掉这个元素名以及等号

例如:

//定义
public @interface ActionListener{
	String value()
}
//使用
@ActionListener("YellowButton")

元注解

我们每次点开别人的注解经常看到的是这样的

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

那么@Target @Retention是什么呢?这些就是元注解。
元注解简单点说就是:可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面
元注解包括5种:
元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

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

它的取值如下:

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

我们可以这样的方式来加深理解,@Retention 去给一张标签解释的时候,它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期。

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码中,我们指定 TestAnnotation 可以在程序运行周期被获取到,因此它的生命周期

@Documented

顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target

target 是限制注解的使用场景,比如只能注解方法,只能注解类等。Target可以设置的值有:
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
例如我们点开Override

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

从Target设定的值,可以看出Override只能注解方法,从Retention来看,只存在于源码阶段。

@Inherited

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
说的比较抽象。代码来解释。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}

@Test
public class A {}

public class B extends A {}

注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。
什么样的注解会多次应用呢?通常是注解的值可以同时取多个。
举个例子,一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
    Person[]  value();
}

@Repeatable(Persons.class)
@interface Person{
    String role default "";
}


@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

}

注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。

我们再看看代码中的相关容器注解。

@interface Persons {
    Person[]  value();
}

按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。

如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。

参考资料:
秒懂,Java 注解 (Annotation)你可以这样学
Java核心技术

你可能感兴趣的:(Android注解,Android注解)