ButterKnife的实现原理解密之IOC思想

ButterKnife只要是写过Android的相信都不会陌生,它是一款控件注入、事件注如神器可以帮助开发者提高开发效率。
什么是IOC技术呢?说到IOC它的解释其实看上去并没有那么的容易懂,通俗一点讲IOC是原来由程序代码中主动获取的资源,转变由第三方获取并使原来的代码被动接收的方式,以达到解耦的效果,称为控制反转,想要更详细的要了解IOC的思想请到Spring的原码查看,这里只分享IOC思想的一部分。
那如何使用IOC思想实现Butterknife的控件注入的功能呢?下面将用代码来讲解实际中是如何实现的。
首先得有像Butterknife一样的自定义注解来标记一下哪一个控件是需要注入的,所以得定义一个自定义的注解

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

这个注解是在运行时生效的,同时是使用在成员变量上的,有了这个注解后就是可以写一个注入工具来实现控件的注入了,其实现原理是使用注解+反射来达到注入的效果,通过查找类中的所有成员找到带有自定义的注解拿到该控件的id值,然后反射系统中的findViewByid()的方法来达到注入的效果。

   /**
     *
     * @param targer
     */
    private static void injectFindViewById(Object targer) {
        Class<?> aClass = targer.getClass();
        Field[] declaredFields = aClass.getDeclaredFields();
        for (Field field : declaredFields) {
            ViewInject viewInject = field.getAnnotation(ViewInject.class);
            if(viewInject != null){
                int viewId = viewInject.value();
                try {
                    Method findViewByIdMethod = aClass.getMethod("findViewById",int.class);
                    View view = (View)findViewByIdMethod.invoke(targer,viewId);
                    field.setAccessible(true);
                    field.set(targer,view);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }

这个就是使用IOC技术来实现Butterknife的控件注入的功能,Butterknife还一个事件注入的功能这个功能的实现原理和控件注入差不多;接下就看一下事件的注入是如何做到的,这里的只实现一种事件注入的实现分析OnClick()的事件注入只要理解了一种的事件的注入其它的22种事件也是一样的。同样也是要定义一个自定义的注解来标记哪一个方法需要事件的注入。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@EventBase(listenerSetter = "setOnClickListener",listenerType = View.OnClickListener.class,callbackMethoed = "onClick")
public @interface OnClick {
    int[] value() default -1;
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface EventBase {
    String listenerSetter();
    Class<?> listenerType();
    String callbackMethoed();
}

这里还需要再定义一个EventBase注解来记录这事件是要设置系统中的哪一个事件监听。有了注解后就是要来实现这个注入的功能了。

/**
    * 事件注入
    * @param targer
    */
   private static void injectEvent(Object targer) {
       Class<?> aClass = targer.getClass();
       Method[] declaredMethods = aClass.getDeclaredMethods();
       for (Method method : declaredMethods) {
           Annotation[] annotations = method.getAnnotations();
           for (Annotation annotation : annotations) {
               Class<?> annotationClass = annotation.annotationType();
               EventBase eventBase = annotationClass.getAnnotation(EventBase.class);
               if(eventBase == null){
                   continue;
               }
               String listenerSetter = eventBase.listenerSetter();
               Class<?> lisetenerType = eventBase.listenerType();
               String callBackMethod = eventBase.callbackMethoed();
               Method valueMethod = null;
               try{
                   valueMethod = annotationClass.getDeclaredMethod("value");
                   int[] viewId = (int[]) valueMethod.invoke(annotation);
                   for (int id : viewId) {
                       Method findViewByid = aClass.getMethod("findViewById",int.class);
                       View view = (View) findViewByid.invoke(targer,id);
                       if(view == null){
                           continue;
                       }
                       ListenerInvocationHandler invocationHandler = new ListenerInvocationHandler(targer,method);
                       Object proxy =  Proxy.newProxyInstance(lisetenerType.getClassLoader(),new Class[]{lisetenerType},invocationHandler);
                       Method onClickMethod = view.getClass().getMethod(listenerSetter,lisetenerType);
                       onClickMethod.invoke(view,proxy);
                   }
               }catch (Exception e){
                   e.printStackTrace();
               }
           }
       }
   }

其实现原理和控件注入是一样的都是通过反射系统中的方法来实现的,只是在事件的注入中要使用到动态代理才能把事件的回调到相应的方法上。

public class ListenerInvocationHandler implements InvocationHandler {

    private Object activity;
    private Method activityMethod;

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

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        return activityMethod.invoke(activity,args);
    }
}

以上就是使用IOC的思想来实现ButterKnife的控件的注入和事件的注入,从上述可以看到所有的注入都是使用反射来实现的从性能上来看其实并不太好,下面分析ButterKnife的实现过程。为了解决这个性能问题ButterKnife对IOC做了优化,从运行时改成了编译时来完成所有的注入功能。
要从编译时完成控件的注入和事件的注入那就使用注解处理器来完成这个事情。代码的实现下次再分享了。
项目代码链接:https://github.com/WayneQi/WayneDemo

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,158评论 4 370
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,600评论 1 307
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,785评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,655评论 0 220
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,075评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,002评论 1 225
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,146评论 2 318
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,918评论 0 211
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,671评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,838评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,318评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,636评论 3 263
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,343评论 3 244
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,187评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,982评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,126评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,934评论 2 279

推荐阅读更多精彩内容