Java注解小结

Java

1.前言

发现Retrofit、ButterKnife、ActiveAndroid、GreenDao等许多流行的开源库都使用了注解。JDK 1.5中引入了注解，那么注解是什么呢？有什么优点？

2.介绍

2.1 概念

定义：能够添加到 Java 源代码的语法元数据。类、方法、变量、参数、包都可以被注解，可用来将信息元数据与程序元素进行关联
元数据从metadata一词译来，就是“关于数据的数据”的意思。

2.2 注解分类

• JDK内置系统注解
• 元注解
• 自定义注解

2.3 JavaSE中内置三个标准注解

• @Override：用于修饰此方法覆盖了父类的方法
• @Deprecated：用于修饰已经过时的方法
• @SuppressWarnnings:用于通知java编译器禁止特定的编译警告

2.4 元注解

负责注解其他注解。Java5.0中定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。自定义注解需要用到。

2.4.1 @Target

1.@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
2.作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
3.取值(ElementType)有：
　　　　1.CONSTRUCTOR:用于描述构造器
　　　　2.FIELD:用于描述域
　　　　3.LOCAL_VARIABLE:用于描述局部变量
　　　　4.METHOD:用于描述方法
　　　　5.PACKAGE:用于描述包
　　　　6.PARAMETER:用于描述参数
　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

2.4.2 @Retention：

1.@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
2.作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）
3.取值（RetentionPoicy）有：
　　1.SOURCE:在源文件中有效（即源文件保留）
　　2.CLASS:在class文件中有效（即class保留）
　　3.RUNTIME:在运行时有效（即运行时保留）
Retention meta-annotation类型有唯一的value作为成员。

2.4.3 @Documented

　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

2.4.4 @Inherited

　　@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

2.5 自定义注解

　　1.使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

　　2.定义注解格式：
　　public @interface 注解名 {定义体}

　　3.注解参数的可支持数据类型：
　　　　1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2.String类型
　　　　3.Class类型
　　　　4.enum类型
　　　　5.Annotation类型
　　　　6.以上所有类型的数组

注意点

Java 8 加强了注解框架，有更多注解标签。另外有兴趣可以看下注解处理工具APT，编译时实现注解。

4.实践

运用注解和反射简单实现一个类似ButterKnife的注入功能。

4.1 定义BindView注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface BindView {
    int value() default -1;
}

这个value设置的是资源id的值。

4.2 编写注入代码

public class InjectsUtils {
    public static void bind(Activity activity) {
        Class<? extends Activity> clazz = activity.getClass();
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            BindView bindView = field.getAnnotation(BindView.class);
            if (bindView != null) {
                // 获取元数据
                int viewId = bindView.value();
                if (viewId != -1) {
                    // 处理元数据
                    try {
                        Method method = clazz.getMethod("findViewById", int.class);
                        Object resView = method.invoke(activity, viewId);
                        field.setAccessible(true);
                        field.set(activity, resView);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
}

4.3 Activity部分代码

public class MainActivity extends AppCompatActivity {
    @BindView(R.id.tv)
    private TextView tv;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        InjectsUtils.bind(this);
        tv.setText("Inject OK！");
    }
}

这样就避免了输入大量的findViewById的代码，减少重复工作。当然使用反射是损耗性能的，目前ButterKnife 8.0是采取了编译时处理Annotion（通过自定义APT），对性能基本不影响。

小结

注解主要的作用是通过编译时或运行时读取到元数据，然后依据元数据做特定处理。定义了注解，并在需要的时候给相关类，类属性加上注解信息，如果没有响应的注解信息处理流程，注解可以说是没有实用价值的。

优点

• 提供用来完整描述程序所需的信息
• 生成描述符文件
• 更加干净易读的代码以及编译期类型检查和特定处理（自动生成代码）

附上基础知识思维导图

图出处：http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html