java注解 简书_Java注解详解

在研究了butterknife以后,感觉有必要深入研究一下注解(其实还有好多地方用到过,比如retrofit.以后准备研究的dagger2也用到了注解)

一、概念

Java提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法。

二、元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

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

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。

RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。

RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。(通常我们都用RUNTIME)

@Documented

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

@Target

Target 是目标的意思，@Target 指定了注解运用的地方。@Target 有下面的取值

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解

ElementType.CONSTRUCTOR 可以给构造方法进行注解

ElementType.FIELD 可以给属性进行注解

ElementType.LOCAL_VARIABLE 可以给局部变量进行注解

ElementType.METHOD 可以给方法进行注解

ElementType.PACKAGE 可以给一个包进行注解

ElementType.PARAMETER 可以给一个方法内的参数进行注解

ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

@Inherited

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

@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 注解过的注解数组，注意它是数组。

下面我举一个详细的例子

1.先定义一个类的注解

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestClassAnnotation {

int id() default -1;

String msg() default "Hi";

}

2.再定义一个方法的注解

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestMethodAnnotation {

String name() default "method";

String returnType() default "void";

String[] paramType() default {""};

}

3.写一个测试类然后给出对应的注解

@TestClassAnnotation(id = 5, msg = "hello")

class AATest {

@TestMethodAnnotation()

String getName(int id) {

return "AATest";

}

String getNameNoAnnotation(int id) {

return "AATest";

}

}

4.测试代码(获取注解信息)

//获取类的注解信息

boolean hasAnnotation = AATest.class.isAnnotationPresent(TestClassAnnotation.class);

if (hasAnnotation) {

TestClassAnnotation testAnnotation = AATest.class.getAnnotation(TestClassAnnotation.class);

System.out.println("id:" + testAnnotation.id());

System.out.println("msg:" + testAnnotation.msg());

}

//获取类中的方法的注解信息

Method[] method = AATest.class.getDeclaredMethods();//所有方法

for (Method me : method) {

TestMethodAnnotation mothod = me.getAnnotation(TestMethodAnnotation.class);

if (mothod != null) {

//不为null表示标注了TestMethodAnnotation的方法

System.out.println("--------------------------------------");

System.out.println(me.getName());

System.out.println(me.getReturnType().toString());

for (Parameter type : me.getParameters()) {

System.out.println(type.getType().toString());

}

//如果用mothod的方法只能获取默认的参数

System.out.println("--------------------------------------");

System.out.println(mothod.name());

System.out.println(mothod.returnType());

for (String type : mothod.paramType()) {

System.out.println(type);

}

}

}

5.测试结果

id:5

msg:hello

--------------------------------------

getName

class java.lang.String

int

--------------------------------------

method

void

6.注解和反射的区别

反射:(在运行时才知道要操作的类是什么，并且可以在运行时获取类的完整构造，并调用对应的方法)

用途:用来处理数据的

数据来源:处理的数据必须是固定的(数据已经给定,只能修改已经存在的属性或者方法)

处理数据规则:怎么处理这些数据是不固定的(按照需求来).

缺点:破坏数据的封装性.效率也有一定问题

优点:在开发中动态加载类，比如在Android中的动态加载解决65k问题等等，模块化和插件化都离不开反射，离开了反射寸步难行。

注解:

用途:仅仅是元数据,仅仅提供它定义的属性信息(怎么处理这些数据是通过javapoet生成的文件来处理的)

数据来源:处理的数据不固定.标注啥处理啥

处理数据规则:处理数据的规则是固定的(通过javapoet生成的文件来处理)

缺点:一旦规则变了,涉及的类必须重新编译才能生效

优点:大量同质代码可以合并findViewById,setOnClickListener(高级一点的还有dagger2)