Android 自定义注解

  我们在项目中经常用到注解，比如原生自带的@Override、@NonNull等 ，等三方框架ButterKnife中@BindView、@OnClick等。用的久了，就想着去看看它是怎么弄出来的，因自定义注解的使用场景比较少，故此次咱先做下简单了解。

注解的作用：
1.和编译器一起给你一些提示警告信息。
2.配合一些ide 可以更加方便快捷 安全有效的编写java代码。谷歌出的support-annotations这个库 就是主要干这个的。
3.和反射一起 提供一些类似于spring 可配置的功能，方便简洁。

运行时注解与编译时注解的区别是什么呢？
a）保留阶段不同。运行时注解保留到运行时，可在运行时访问。而编译时注解保留到编译时，运行时无法访问。
b）原理不同。运行时注解是Java反射机制，而编译时注解通过APT、AbstractProcessor。
c）性能不同。运行时注解由于使用Java反射，因此对性能上有影响。编译时注解对性能没影响。这也是为什么ButterKnife从运行时切换到了编译时的原因。
d）产物不同。运行时注解只需自定义注解处理器即可，不会产生其他文件。而编译时注解通常会产生新的Java源文件。

  下面来试试实现ButterKnife中的BindView和OnClick。
先定义下BindView（ViewInject）和OnClick的注解，写的是运行时注解：

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Retention 用于声明该注解生效的生命周期，有三个枚举值可以选择

 * 1. RetentionPolicy.SOURCE 注释只保留在源码上面，编译成class的时候自动被编译器抹除
 * 2. RetentionPolicy.CLASS 注释只保留到字节码上面，VM加载字节码时自动抹除
 * 3. RetentionPolicy.RUNTIME 注释永久保留，可以被VM加载时加载到内存中
 * 注意：由于我们的目的是想在VM运行时对Filed上的该注解进行反射操作，因此Retention值必须设置为RUNTIME
 * @Target 用于指定该注解可以声明在哪些成员上面，常见的值有FIELD和Method，
 * 由于我们的当前注解类是想声明在Filed上面
 * 因此这里设置为ElementType.FIELD。
 * 注意：如果@Target值不设置，则默认可以添加到任何元素上，不推荐这么写。
 * @interface 是声明注解类的组合关键字。
 */

@Target({java.lang.annotation.ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject {//通过@interface 来定义注解
    public abstract int value();
}

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({java.lang.annotation.ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClick
{
    public abstract int[] value();
}

定义好注解后，再写个的类去处理findViewById和OnClick的操作：

import android.app.Activity;
import android.view.View;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class ViewUtilsTest {
    public static void inject(final Activity activity) {
        /**
         * 通过字节码获取activity类中所有的字段，在获取Field的时候一定要使用
         * getDeclaredFields(),
         * 因为只有该方法才能获取到任何权限修饰的Filed，包括私有的。
         */
        Class clazz = activity.getClass();
        Field[] declaredFields = clazz.getDeclaredFields();
        //一个Activity中可能有多个Field，因此遍历。
        for (int i = 0; i < declaredFields.length; i++) {
            Field field = declaredFields[i];
            //设置为可访问，暴力反射，就算是私有的也能访问到
            field.setAccessible(true);
            //获取到字段上面的注解对象
            ViewInject annotation = (ViewInject) field.getAnnotation(ViewInject.class);
            //一定对annotation是否等于null进行判断，因为并不是所有Filed上都有我们想要的注解
            if (annotation == null) {
                continue;
            }
            //获取注解中的值
            int id = annotation.value();
            //获取控件
            View view = activity.findViewById(id);
            try {
                //将该控件设置给field对象
                field.set(activity, view);
            } catch (IllegalArgumentException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        //获取所有的方法（私有方法也可以获取到）
        Method[] declaredMethods = clazz.getDeclaredMethods();
        for (int i = 0; i < declaredMethods.length; i++) {
            final Method method = declaredMethods[i];
            //获取方法上面的注解
            OnClick annotation = (OnClick) method.getAnnotation(OnClick.class);
            if (annotation == null) {
                //如果该方法上没有注解，循环下一个
                continue;
            }
            //获取注解中的数据，因为可以给多个button绑定点击事件，因此定义注解类时使用的是int[]作为数据类型。
            int[] value = annotation.value();
            for (int j = 0; j < value.length; j++) {
                int id = value[j];
                final View button = activity.findViewById(id);
                button.setOnClickListener(new View.OnClickListener() {
                    public void onClick(View v) {
                        try {
                            //反射调用用户指定的方法
                            method.invoke(activity, button);
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    }
                });
            }
        }
    }
}

代码中的意思很容易看懂，就是把界面activity传过来，再去遍历定义好的字段，取出注入的id，最后仍然是咱们经常用的findViewById。点击监听也是如此。然后，就结束了。。就可以用了，像ButterKnife一样用就行：

public class TestActivity extends AppCompatActivity {
    @ViewInject(R.id.btn_test)
    Button button;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test1);
        ViewUtilsTest.inject(this);
    }

    @OnClick(R.id.btn_test)
    public void onClick(View v) {
        if (v.getId() == R.id.btn_test) {
            Toast.makeText(TestActivity.this,"test111111",Toast.LENGTH_SHORT).show();
        }
    }    
}

貌似没问题了，可以成功的toast出来。但这只是最简单的了解，想再多了解点的，可以看看这个：https://www.jianshu.com/p/806e3500fec4