Java高级特性——注解，这也许是最简单易懂的文章了

博主在初学注解的时候看到网上的介绍大部分都是直接介绍用法或者功能，没有实际的应用场景，篇幅又很长致使学习的时候难以理解其意图，并且学完就忘QAQ。本篇文章中我将结合实际的应用场景尽量由浅入深，平缓的介绍java注解。

java注解是jdk1.5之后新出的特性，对于它的应用很是普遍，咱们首先来看一下注解的应用，百度百科上这样说：

咱们能够看到，注解的做用有三方面：

编写doc文档：这个就咱们很经常使用的 @return 以及 @author，加了这些注解之后，就能够用jdk帮咱们自动生成对应的API文档了

编译检查：这个也很常见 @Override，并且功能很强大，我将会在之后的文章中介绍

进行代码分析：这是本篇文章的重点。这个和编译检查同样也是一个强大的功能，但相比与编译检查因为其用到了反射，在性能上存在一些问题

后台开发中的SSH三大框架，以及我们安卓端的retrofit，ButterKnife，Lombok等框架和插件也是大量的用到了注解。这里我将经过手撸一个假的ButterKnife来具体演示注解有什么用，怎么用。

咱们首先来看段代码

public class MainActivity extends AppCompatActivity {

@OnClick(R.id.test_btn)
void test(){
    test_tv.setText("恭喜您，绑定成功了！");
}

@FindViewByID(R.id.test_tv)
TextView test_tv;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bindView(this);
}
}

这是一个最基本的activity，里面有2个控件，Button和TextView

在我点击Button后TextView的文字被改变。而我所作的仅仅是ButterKnife.bindView(this)并添加2个注解而已，这样就实现了控件的绑定，省去了不少与业务无关的代码，是否是简洁了不少。

看了注解的功能是否是很想了解它是怎么作到的，接下来我就来看看它是什么，怎么用，怎么利用

什么是注解

官方把它叫作元数据，即一种描述数据的数据。因此，能够说注解就是源代码的元数据。用它来能够来描述、标记咱们的源代码。

怎样定义一个注解

如下是我上文中定义的一个 @OnClick注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClick {

int value() default 0;

}

可见和定义一个类同样，只是将class改成 @interface，而且顶部经过几个原注解来讲明这个注解的一些重要信息，具体以下：

J2SE5.0版本在 java.lang.annotation提供了四种元注解，专门注解其余的注解：

@Documented –注解是否将包含在JavaDoc中
@Retention –何时使用该注解
@Target? –注解用于什么地方
@Inherited – 是否容许子类继承该注解

@Documented–一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中，通常不用管。

@Retention– 定义该注解的生命周期，很重要，必须指定，如下是3种生命周期的介绍

RetentionPolicy.SOURCE – 在编译阶段丢弃。这些注解在编译结束以后就再也不
有任何意义，因此它们不会写入字节码。@Override, @SuppressWarnings都属
于这类注解。
RetentionPolicy.CLASS – 在类加载的时候丢弃。在字节码文件的处理中有用。
注解默认使用这种方式。
RetentionPolicy.RUNTIME– 始终不会丢弃，运行期也保留该注解，所以可使
用反射机制读取该注解的信息。咱们自定义的注解一般使用这种方式。

@Target – 表示该注解用于什么地方。若是不明确指出，该注解能够放在任何地方。如下是一些可用的参数。须要说明的是：属性的注解是兼容的，若是你想给7个属性都添加注解，仅仅排除一个属性，那么你须要在定义target包含全部的属性。

ElementType.TYPE:用于描述类、接口或enum声明
ElementType.FIELD:用于描述实例变量
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE 另外一个注释
ElementType.PACKAGE 用于记录java文件的package信息

@Inherited – 定义该注释和子类的关系

那么注解体里的内容有该怎样定义

Annotations只支持基本类型、String及枚举类型。注释中全部的属性被定义成方法，并容许提供默认值。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Book{
public enum Priority {LOW, MEDIUM, HIGH}
String author() default "Yash";
int price() default 20;
Status status() default Status.NOT_STARTED;
}

看看怎么用它

@Todo(priority = Todo.Priority.MEDIUM, author = "zsq", status = 
Todo.Status.STARTED)
public void incompleteMethod1() {

}

经过字段名 = 的形式给字段赋值，若是没赋值，则使用缺省值。若是注解中只有一个属性，能够直接命名为“value”，使用时无需再标明属性名，例如我定义的 @OnClick注解。

好了，花了那么多精力来认识他，该看看该怎么来利用它了

咱们定义了本身的注解并将其应用在业务逻辑的方法上。如今咱们须要写一个用户程序调用咱们的注解。这里咱们须要使用反射机制。若是你熟悉反射代码，就会知道反射能够提供类名、方法和实例变量对象。全部这些对象都有getAnnotation()这个方法用来返回注解信息。咱们须要把这个对象转换为咱们自定义的注释(使用 instanceOf()检查以后)，同时也能够调用自定义注释里面的方法。

全部这些对象都有getAnnotation()！

全部这些对象都有getAnnotation()！

全部这些对象都有getAnnotation()！

重要的API说3遍，另外用到的几个方法也很重要，下面的代码会演示，更多的API使用参考能够去查阅JDK文档。

具体到咱们本编文章的实例，调用注解的家伙就是咱们刚刚在MainActivity里用到的 ButterKnife，咱们经过设置监听的注解来看看它到底作了什么

public static final void bindView(final Activity activity){
    traversalMethod(activity);
    traversalField(activity);
}

在咱们调用的ButterKnife.bindView(this)中咱们拿到了MainActivity的实例，而且经过反射遍历里面全部的方法：

private static void traversalMethod(final Activity activity) {
    Method[] methodArray = getObjectMethodArray(activity);
    for (final Method method:methodArray){
        if(isAnnotationPresent(method)){

            int viewID = getViewID(method);

            setOnClickListenerForControl(activity, method, viewID);

        }
    }
}

private static Method[] getObjectMethodArray(Activity activity) {
    return activity.getClass().getMethods();
}

接着判断方法是否被咱们注解：

private static boolean isAnnotationPresent(Method method) {
    return method.isAnnotationPresent(OnClick.class);
}

若是是咱们用注解标注的方法则经过注解获取注解里保存的空间ID，而且经过MainActivity的实例为其设置点击监听，在监听内调用被注解标注的方法。

private static int getViewID(Method method) {
    return method.getAnnotation(OnClick.class).value();
}

private static void setOnClickListenerForControl(final Activity activity, final Method method, int viewID) {
    activity.findViewById(viewID).setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {

            try {
                method.invoke(activity);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
        }

    });
}

大功告成！是否是很简单

咱们用反射获取注解的方式实现了ButterKnife的功能，但文章开头说过反射的存在性能上的不足。而实际上ButterKnife自己用的也不是反射，而是用的apt工具在编译时期就能够获取到全部的方法、字段、以及他们的注解，从而避免了使用反射，解决了性能的问题。接下来的文章我会讲解本文开头提到的第三点，也就是ButterKnife实际使用的方法，将咱们本身的ButterKnife改成ButterKnife官方的实现方法。

如下github地址是本篇文章讲解用到的demo：
https://github.com/sally519/MyButterKnief

文章很长，但愿看完的人能收获点东西

做者水平有限，若有遗漏和错误，欢迎指正！