自己动手打造一套IOC注解框架

1.概述

---

这是我们的内涵段子系统架构的第一期分享，希望大家可以先去了解一下这一期的内容：2017Android进阶之路与你同行。在介绍内涵段子整个项目的时候我们也说好了会分析系统源码设计模式，第三方框架源码解析，然后自己动手一点一点打造一套内涵段子框架。这一期的内容对于部分哥们可能有点麻烦，如果觉得抽象请看视频讲解。
　　那么什么是IOC，控制反转（Inversion of Control，英文缩写为IOC），其实就是反射加注解如果你学过Java后台这个在三大框架中会经常使用。过多的去解释其实也没什么意思，我们主要来看有什么用处。
　　附视频讲解地址：http://pan.baidu.com/s/1kVFMRQJ

2.第三方IOC框架源码解析

---

今天主要讲的就是Android中IOC框架就是注入控件和布局或者说是设置点击监听，如果你用过xUtils，afinal，butterknife类的框架，你肯定不陌生~
　　我们挑两个做一下对比和源码分析，我们就挑xUtils和butterknife这两个代表：

2．1 xUtils的IOC注解使用

xutils如果大家使用过的话它里面的内容会比较多，包括网络，数据库，IOC注入，网络图片使用，那么我们这里主要看看xutils3.0的IOC注解：https://github.com/wyouflf/xUtils3

public class MainActivity extends AppCompatActivity {

    @ViewInject(R.id.icon)
    private ImageView mIconIv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        x.view().inject(this);

        mIconIv.setImageResource(R.drawable.icon);
    }

    /**
     * 1. 方法必须私有限定,
     * 2. 方法参数形式必须和type对应的Listener接口一致.
     * 3. 注解参数value支持数组: value={id1, id2, id3}
     * 4. 其它参数说明见{@link org.xutils.view.annotation.Event}类的说明.
     **/
    @Event(value = R.id.icon,
            type = View.OnClickListener.class/*可选参数, 默认是View.OnClickListener.class*/)
    private void iconIvClick(View view) {
        Toast.makeText(this, "图片被点击了", Toast.LENGTH_LONG).show();
    }
}

这里写图片描述

　　
　　我就是设置一张图片和一个点击事件而已，其实主要解决的就是我们不再需要findViewById()和setOnClickListener()，我们简单的来看一下源码到底是怎么实现的：
　　
　 2．2 xUtils的IOC注解源码解析　
　　
　　我就挑一些关键的代码来分析一下，视频里面会给大家讲得非常详细，我们主要看一下x.view().inject(this);到底是干了什么：

    @Override
    public void inject(Activity activity) {
        //获取Activity的ContentView的注解
        Class handlerType = activity.getClass();
        try {
            // 找到ContentView这个注解，在activity类上面获取
            ContentView contentView = findContentView(handlerType);
            if (contentView != null) {
                int viewId = contentView.value();
                if (viewId > 0) {
                　　 // 如果有注解获取layoutId的值，利用反射调用activity的setContentView方法注入视图
                    Method setContentViewMethod = 
                        handlerType.getMethod("setContentView", int.class);
                    setContentViewMethod.invoke(activity, viewId);
                }
            }
        } catch (Throwable ex) {
            LogUtil.e(ex.getMessage(), ex);
        }
        // 处理 findViewById和setOnclickListener的注解
        injectObject(activity, handlerType, new ViewFinder(activity));
    }

private static void injectObject(Object handler, Class handlerType, ViewFinder finder) {
　　　　　// .......

        // 从父类到子类递归
        injectObject(handler, handlerType.getSuperclass(), finder);

        // inject view  注入控件View
        Field[] fields = handlerType.getDeclaredFields();
        if (fields != null && fields.length > 0) {
            for (Field field : fields) {
            　　// ......
               // 获取viewInject 注解
                ViewInject viewInject = field.getAnnotation(ViewInject.class);
                if (viewInject != null) {
                    try {
                    　　 // 其实最终还是调用findViewById的方法
                        View view = finder.findViewById(viewInject.value(),
                             viewInject.parentId());
                        if (view != null) {
                            // 利用反射 把View注入到该属性中
                            field.setAccessible(true);
                            field.set(handler, view);
                        } else {
                           // ......
                        }
                    } catch (Throwable ex) {
                        LogUtil.e(ex.getMessage(), ex);
                    }
                }
            }
        } // end inject view

        // inject event  注入事件
        Method[] methods = handlerType.getDeclaredMethods();
        if (methods != null && methods.length > 0) {
            for (Method method : methods) {
　　　　　　　　　　// ......
                //检查当前方法是否是event注解的方法
                Event event = method.getAnnotation(Event.class);
                if (event != null) {
                    try {
                        // id参数
                        int[] values = event.value();
                        int[] parentIds = event.parentId();
                        int parentIdsLen = parentIds == null ? 0 : parentIds.length;
                        //循环所有id，生成ViewInfo并添加代理反射   主要使用了动态代理的设计模式
                        for (int i = 0; i < values.length; i++) {
                            int value = values[i];
                            if (value > 0) {
                                ViewInfo info = new ViewInfo();
                                info.value = value;
                                info.parentId = parentIdsLen > i ? parentIds[i] : 0;
                                method.setAccessible(true);
                                // EventListenerManager 动态代理执行相应的方法
                                EventListenerManager.addEventMethod(
                                    finder, info, event, handler, method);
                            }
                        }
                    } catch (Throwable ex) {
                        LogUtil.e(ex.getMessage(), ex);
                    }
                }
            }
        } // end inject event

    }

关键的源码大概就这么多，动态代理的部分没有贴出来，这个写可能写不清楚大家可以自己去看看源码或者自己去网上搜搜动态代理的设计模式分析，视频里面会给大家讲清楚。动态代理我记得我刚刚自学那会还真是一道坎但是这个坎我们得迈过去，后面我们讲Android的Hook技术以及插件开发会反复的讲到。
　　xutils相对来说应该不难理解吧，其实就是我们利用类的反射循环获取属性的注解值然后通过findViewById之后，动态的注入到控件属性里面；事件注入也是类似首先findViewById然后利用动态代理去反射执行方法。

2．3 butterknife的使用
　　
　　相比于xutils来讲它可能更受大家的欢迎，第一在性能方面xutils完全是利用的反射，butterknife是轻量级的反射使用的注解都是编译时注解，而且它还提供了一个Android Studio的插件不需要我们去写任何的代码，作者JakeWharton很出名的写过很多大型的第三方框架，https://github.com/JakeWharton/butterknife

public class MainActivity extends AppCompatActivity {

    @Bind(R.id.icon)
    ImageView icon;

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

    @OnClick(R.id.icon)
    public void onClick() {
        Toast.makeText(this, "图片点击了", Toast.LENGTH_LONG).show();
    }
}

上面是由插件给我们自动生成的代码，我们再也不用手动去写这些代码了。属性是不能private,onClick()方法也不能private,否则会报错的待会我们看源码的实现就知道为什么只能这样，插件自动生成的名字和方法总感觉怪怪的和我们的Android源码规范不一致，当然后面我们会自己去写一个Android Studio插件来配合我们自己的IOC注解框架。

2．4 butterknife的源码解析

源码阅读相对于xutils的也麻烦很多，如果我们按照常规的逻辑去找ButterKnife.bind(this);会发现里面好像没什么东西只有这个：

static void bind(Object target, Object source, Finder finder) {
    Class targetClass = target.getClass();
    try {
      if (debug) Log.d(TAG, "Looking up view binder for " + targetClass.getName());
      // 找到viewBinder
      ViewBinder