造自己的轮子系列之——仿Butterknife框架

最近在项目中用到了Butterknife框架，而且配合插件ButterKnifeZelezny更是好用的飞起，学习了下butterknife源码，差不多了解个大概：Butterknife在编译时刻利用APT分析程序代码，扫描每一个有注解的类，找出类中带有注解的字段，然后查找我们自己定义的注解，然后动态执行findViewById操作，同理OnClick事件。由此我们可以来实现个自己的Butterknife，那我的就叫Hunterknife了。

首先我们要创建个包含注入代码的辅助类来绑定View控件和点击事件

ViewBind.java

/**
 * @Retention 用于声明注解生效的生命周期, 有三个枚举值可以选择
 * 1.RetentionPolicy.SOURCE 注解只保留在源码上，编译成class时自动被编译器抹去
 * 2.RetentionPolicy.CLASS 注解只保留在字节码上，vm加载字节码时自动抹去
 * 3.RetentionPolicy.RUNTIME 注解永久保留，可以被vm加载到内存
 * 由于我们想在运行时对Filed上的注解进行反射操作，因此Retention值必须设为RUNTIME
 *
 * @target 用于指定注解可以声明在哪些成员上面，我们设置的值有Filed和Method
 * 由于我们当前注解类是要声明在Filed上，因此我们设置为ElementType.FILED
 *
 * @interface 是声明注解类组合关键字
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)

public @interface ViewBind  {
    //value是所有注解类的默认属性名
    int value();
}

Click.java

/**
 * 用于添加到方法上，方法上指定button的id，且可以绑定多个button的id
 * 当点击button时通过反射调用方法
 */


@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)

public @interface Click {
    //int[]数组用于绑定多个id
    int[] value();
}

接下来是主要核心方法了Hunterknife.bind()

public class HunterKnife {
    public static void bind(final Activity activity){
        /**
         * 通过字节码获取activity中所有字段，并且使用getDeclaredFields方法
         * 因为这样才能获取到任何权限修饰的Field。包括private
         */
        Field[] declaredFileds = activity.getClass().getDeclaredFields();
        for (int i=0;i<declaredFileds.length;i++){
            Field field = declaredFileds[i];
            //设置为可访问，即使为私有，暴力反射
            field.setAccessible(true);
            //获取字段上的注解对象
            HunterKnife.ViewBind annotation = field.getAnnotation(HunterKnife.ViewBind.class);
            if (annotation!=null){
                int id = annotation.value();
                //获取控件
                View view = activity.findViewById(id);
                try {
                    //参数1为当前Field所属的对象
                    //参数2为要给Field设置的值
                    field.set(activity,view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }

        Method[] declaredMehtod = activity.getClass().getDeclaredMethods();
        for (int i=0;i<declaredMehtod.length;i++){
            final Method method = declaredMehtod[i];
            method.setAccessible(true);
            //获取方法上的注解
            HunterKnife.Click annotation = method.getAnnotation(HunterKnife.Click.class);
            //如果没有循环下一个
            if (annotation==null){
                continue;
            }
            //获取注解中的数据
            int[] ids = annotation.value();
            for (int j=0;j<ids.length;j++){
                final View button = activity.findViewById(ids[i]);
                button.setOnClickListener(new View.OnClickListener() {
                    @Override
                    public void onClick(View v) {
                        try {
                            method.invoke(activity,button);
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    }
                });
            }
        }
    }

}

至此，我们自己的butterknife框架已经完成了，是不是不太难，当然我也只是完成了一部分，其他的可以自己拓展。

测试代码和项目在github上，欢迎Star。Hunterknife完整项目