[移动开发]Android 自定义注解详细用法，手写Butterknife黄油刀

前言

本篇文章主要讲解 Java 注解在Android中的常见用法

Java 注解（Annotation）

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

内置的注解

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

• @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
• @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
• @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说 元注解，自定义注解核心)是:

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
• @Documented - 标记这些注解是否包含在用户文档中。
• @Target - 标记这个注解应该是哪种 Java 成员。
• @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

注解的组成部分

Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

更多基本知识点参考，有更全面的，这里就不过多描述了 Java 注解详细讲解以及基础语法

话不多说，先上代码，再逐一解释：

• MainActivity

@ContentView(R.layout.activity_main)
public class MainActivity extends AppCompatActivity {

    @ViewInject(R.id.text_welcome)
    TextView text_welcome;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ViewUntil.inject(this);
        initData();
    }

    private void initData() {
        text_welcome.setText("我是通过注解后成功修改的值");
    }
}

总结：这个 MainActivity 没啥好讲解的，类似于黄油刀用法，使用了@ContentView 和 @ViewInject 这俩个自定义注解分别得到对应的布局和对应的控件，并最后，修改了 text_welcome 的显示文本

• ContentView

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ContentView {
    int value();
}

总结：这里使用了 @Target, @Retention, @interface 这三个关键代码，现在分别对这三个进行讲解

1. @Retention(RetentionPolicy.RUNTIME)
   它的作用是指定 Deprecated 的策略是 RetentionPolicy.RUNTIME。这就意味着，编译器会将Deprecated 的信息保留在 .class 文件中，并且能被虚拟机读取【参考上面注解的组成部分】
2. @Target(ElementType.TYPE)
   它的作用是指定该 Annotation 的类型是 ElementType.TYPE。这就意味着，ContentView 是来修饰"类、接口（包括注释类型）或枚举声明"的注解。【参考上面注解的组成部分】
3. @interface
   它的作用是实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。
   定义 Annotation 时，@interface 是必须的。

• ViewInject

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ViewInject {
    int value();
}

总结：上面的 @Retention 与 @interface 已经说了，而 @Target(ElementType.FIELD)，参考上面注解的组成部分

• ViewUntil

public class ViewUntil {

    public static void inject(Object context) {
        injectLayout(context);
        injectView(context);
    }


    private static void injectView(Object context) {
    	//获取对应的绑定对象
        Class<?> aClass = context.getClass();
        //获取对应绑定对象的所有成员属性
        Field[] fields = aClass.getDeclaredFields();
        for (Field field : fields) {
        	//得到每一个 被注解绑定的控件
            ViewInject viewInject = field.getAnnotation(ViewInject.class);
			//当然存在有些成员属性，没有被注解绑定，所以这里跳过该变量即可
            if (viewInject == null) {
                continue;
            }
            //得到每一个被绑定的控件id
            int valueId = viewInject.value();
            try {
            //通过反射，拿到绑定对象的 findViewById 方法名
                Method method = aClass.getMethod("findViewById", int.class);
                //拿到对应方法名后，调用对应方法
                View view = (View) method.invoke(context, valueId);
//               将 view   btn  产生联系
                field.setAccessible(true);
                field.set(context, view);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    private static void injectLayout(Object context) {
        int layouyId = 0;
        Class<?> clazz = context.getClass();
        ContentView contentView = clazz.getAnnotation(ContentView.class);
        if (contentView == null) {
            return;
        }
        //拿到注解里面的设置的布局id
        layouyId = contentView.value();

        try {
            //        通过反射拿到 setContentView 方法，然后调用该方法时，将注解得到的布局id，传入进去，从而实现 加载布局的功能
            Method contentMethod = context.getClass().getMethod("setContentView", int.class);
            contentMethod.invoke(context, layouyId);
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

总结：该类目前有三个方法：inject，injectView，injectLayout

1. inject：该方法暴露给外部对象绑定使用
2. injectLayout：初始化绑定对象对应的布局
3. injectView：初始化绑定对象对应的每个控件
   其他的注释写的很全面，想必应该能看懂吧。

运行效果

回顾

到这，我们实现了布局、控件的绑定。但并没有实现控件的事件绑定（点击、长按）相关的。
接下来的内容涉及到动态代理知识相关，建议先看完 Android 静态代理与动态代理详解

自定义注解进阶用法（控件事件的绑定）

在开始之前，我们先整理一下需求。控件的事件绑定，分为点击事件、长按事件。
一个控件可能会有多个事件；
一个事件也可能会绑定多个控件；
完全是多对多的关系！
于是乎我们需要自定义属于自己的注解（@EventBase），
用来修饰对应的点击事件（@OnClick）和长按事件（@OnLongClick）

@EventBase

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface EventBase {
//setOnLongClickListener
    String listenerSetter();
    /**
     * 事件监听的类型
     * @return
     * OnLongClickListener.class
     */
    Class<?> listenerType();

    /**
     * 事件被触发之后，执行的回调方法的名称
     * @return
     *
     * onLongClick
     */
    String callbackMethod();

}

总结：这里 @Target(ElementType.ANNOTATION_TYPE) 它的作用是指定 Inherited 的类型是 ANNOTATION_TYPE。这就意味着，@Inherited 只能被用来标注 “Annotation 类型”。

@OnClick

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@EventBase(listenerSetter="setOnClickListener",listenerType = View.OnClickListener.class,callbackMethod ="onClick" )
public @interface OnClick{
    int[] value();
}

总结：这里注意，多了一个 @EventBase 来修饰 OnClick 注解，表示 OnClick 对应类型，以及对应出发的方法都和系统的点击事件一一对应了起来。

@OnLongClick

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@EventBase(listenerSetter="setOnLongClickListener",listenerType =
        View.OnLongClickListener.class,callbackMethod ="onLongClick" )
public @interface OnLongClick {
    int[] value();
}

总结：同上， @EventBase 修饰的 OnLongClick 注解，和系统的长按事件一一对应了起来。

注：这里的长按和点击对应的注解都用到了 @EventBase 注解，这里可能会被误认为，这个似于类的继承，拥有了父类的公开的内容。但千万不要往这方面想。注解是不能被继承的，只能拿来修饰其他注解，这也是面试官非常喜欢问的一点。

继续贴代码 最新的ViewUntil

public class ViewUntil {

    public static void inject(Object context) {
        injectLayout(context);
        injectView(context);
        injectClick(context);
    }

    private static void injectClick(Object context) {
        //拿到绑定的对象
        Class<?> clazz = context.getClass();
        //获取绑定对象所有的方法
        Method[] methods = clazz.getDeclaredMethods();
        for (Method method : methods) {
            Annotation[] annotations = method.getAnnotations();
            for (Annotation annotation : annotations) {
                Class<?> annotionType = annotation.annotationType();
                EventBase eventBase = annotionType.getAnnotation(EventBase.class);
                if (eventBase == null) {
                    continue;
                }
//                拿到事件三要素
                /**
                 * setOnLongClickListener
                 */
                String listenerSetter = eventBase.listenerSetter();
                /**
                 * OnLongClickListener.class
                 */
                Class<?> listenerType = eventBase.listenerType();
                /**
                 * 事件被触发之后，执行的回调方法的名称
                 * @return
                 *
                 * onLongClick
                 */
                String callBackMethod = eventBase.callbackMethod();
                try {
                    Method valueMethod = annotionType.getDeclaredMethod("value");
                    int[] viewId = (int[]) valueMethod.invoke(annotation);
                    for (int id : viewId) {
//                        有多少个按钮 id ---》findviewById   View.setOnClickerListener
                        Method findViewById = clazz.getMethod("findViewById", int.class);
                        View view = (View) findViewById.invoke(context, id);
                        ListenerInvocationHandler listenerInvocationHandler = new ListenerInvocationHandler(context, method);
                        Method setListener = view.getClass().getMethod(listenerSetter, listenerType);
                        Object proxy = Proxy.newProxyInstance(listenerType.getClassLoader(),
                                new Class[]{listenerType}, listenerInvocationHandler);
                        setListener.invoke(view, proxy);
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }

            /**
             * btn  button    ====> value  R.id.btn  ===>findviewbyid
             *      btn.setOnClickListener(new View.OnClickListener() {
             *             @Override
             *             public void onClick(View v) {
             *
             *             }
             *         });
             */
//            setOnClickListener   Method  设置
//

        }


    }


    private static void injectView(Object context) {
        Class<?> aClass = context.getClass();
        Field[] fields = aClass.getDeclaredFields();
        for (Field field : fields) {
            ViewInject viewInject = field.getAnnotation(ViewInject.class);
            if (viewInject == null) {
                continue;
            }
            int valueId = viewInject.value();
            try {
                Method method = aClass.getMethod("findViewById", int.class);
                View view = (View) method.invoke(context, valueId);
//                view   btn  产生联系
                field.setAccessible(true);
                field.set(context, view);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    private static void injectLayout(Object context) {
        int layouyId = 0;
        Class<?> clazz = context.getClass();
        ContentView contentView = clazz.getAnnotation(ContentView.class);
        if (contentView == null) {
            return;
        }
        //拿到注解里面的设置的布局id
        layouyId = contentView.value();

        try {
            //        通过反射拿到 setContentView 方法，然后调用该方法时，将注解得到的布局id，传入进去，从而实现 加载布局的功能
            Method contentMethod = context.getClass().getMethod("setContentView", int.class);
            contentMethod.invoke(context, layouyId);
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

总结：这里也没啥可说的，只要理解了上面注解的使用，以及动态代理使用，就非常容易明白。
刚开始先拿到 对应方法 的 EventBase 注解，然后得到注解里面的事件三要素，接着通过反射找到对应的控件，最后将事件三要素以及对应控件通过动态代理的方式 实现了点击、长按事件。

MainActivity

@ContentView(R.layout.activity_main)
public class MainActivity extends AppCompatActivity {

    @ViewInject(R.id.text_welcome)
    TextView text_welcome;


    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ViewUntil.inject(this);
        initData();
    }

    private void initData() {
        text_welcome.setText("我是通过注解后成功修改的值");
    }

    @OnLongClick({R.id.btn_one, R.id.btn_two})
    public boolean onLongClick(View view) {
        switch (view.getId()) {
            case R.id.btn_one:
                Toast.makeText(this, "你在长按按钮----------》1", Toast.LENGTH_LONG).show();
                break;
            case R.id.btn_two:
                Toast.makeText(this, "你在长按按钮----------》2", Toast.LENGTH_LONG).show();
                break;
        }
        return false;
    }


    @OnClick({R.id.btn_one, R.id.btn_two})
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.btn_one:
                Toast.makeText(this, "你在点击按钮----------》1", Toast.LENGTH_LONG).show();
                break;
            case R.id.btn_two:
                Toast.makeText(this, "你在点击按钮----------》2", Toast.LENGTH_LONG).show();
                break;
        }
    }

}

ListenerInvocationHandler

//处理器
public class ListenerInvocationHandler implements InvocationHandler {
    private Object context;
    private Method activityMethod;

    private  final String TAG = "Handler";

    public ListenerInvocationHandler(Object context, Method activityMethod) {
        this.context = context;
        this.activityMethod = activityMethod;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        Log.i(TAG, "invoke: ----调用前");
        return activityMethod.invoke(context, args);
    }
}

最终运行效果图

Demo地址：点我下载