一个Android事件注入框架详解

Github上有很多关于事件注入的框架，大致上原理都差不多，但很少详细介绍整个框架的各个组成部分以及实现原理，本文以作者[email protected]的xUtils为例详细介绍整个框架的实现。

首先读者需要了解几个知识点：

1、反射（http://blog.csdn.net/yongjian1092/article/details/7364451）   

2、注解 （http://www.cnblogs.com/linjiqin/archive/2011/02/16/1956426.html） 

3、动态代理 （http://www.cnblogs.com/xiaoluo501395377/p/3383130.html）

这方面的文章很多，大家可以搜一搜，都很容易弄明白，下面开始上代码：

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

	@ViewInject(R.id.text_view)
	TextView text_view;
	
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		
		ViewInjector.inject(this);
	}
	
	@Event(R.id.button)
	private void onClickButton(View view){
		text_view.setText("点击了按钮");
	}
}

如果大家使用过事件注入，相信上面这段代码都很熟悉，这里面有三个使用注解进行标注的地方。

@ContentView替代原来在onCreate函数中写的setContentView方法。

@ViewInject替换findViewById

@Event替换点击事件的注册

以下是三个注解的代码：

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject {

    int value();

    /* parent view id */
    int parentId() default 0;
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Event {

    int[] value();

    int[] parentId() default 0;

    Class type() default View.OnClickListener.class;

    String setter() default "";

    String method() default "";
}

注解是JDK1.5以后引入的新特性，写法就是在interface前加一个@，在编译之后会生成一个标准的interface，大家可以在代码运行时打个断点看一看。继续上代码

public static void inject(Activity activity) {
	//获取Activity的ContentView的注解
        Class handlerType = activity.getClass();
        try {
            ContentView contentView = findContentView(handlerType);
            if (contentView != null) {
                int viewId = contentView.value();
                if (viewId > 0) {
                    Method setContentViewMethod = handlerType.getMethod("setContentView", int.class);
                    setContentViewMethod.invoke(activity, viewId);
                }
            }
        } catch (Throwable ex) {
        }

        injectObject(activity, handlerType, new ViewFinder(activity));
}

private static ContentView findContentView(Class thisCls) {
        if (thisCls == null || Object.class.equals(thisCls)) {
            return null;
        }
        ContentView contentView = thisCls.getAnnotation(ContentView.class);
        if (contentView == null) {
            return findContentView(thisCls.getSuperclass());
        }
        return contentView;
}

这个findContentView用了递归，如果当前activity找不到@ContentView注解，则一直往上查找父类中的注解。找到注解的layout之后，用反射调用了activity的setContentView方法。至此对于layout布局文件的注入已经完成，接着往下分析View的注入。

Field[] fields = handlerType.getDeclaredFields();
    if (fields != null && fields.length > 0) {
        for (Field field : fields) {
            if (Modifier.isStatic(field.getModifiers()) || Modifier.isFinal(field.getModifiers())) {
            continue;
        }
        ViewInject viewInject = field.getAnnotation(ViewInject.class);
        if (viewInject != null) {
            try {
               View view = finder.findViewById(viewInject.value(), viewInject.parentId());
             if (view != null) {
                  field.setAccessible(true);
                 field.set(handler, view);
             }
           } catch (Throwable ex) {
           }
         } 
   }
}

public View findViewById(int id, int pid) {
        View pView = null;
        if (pid > 0) {
            pView = this.findViewById(pid);
        }


        View view = null;
        if (pView != null) {
            view = pView.findViewById(id);
        } else {
            view = this.findViewById(id);
        }
        return view;
}

这个地方其实也是通过activity的findViewById来获取到注解的View实例，然后使用反射将实例注入到activity里被注解对应的view上，需要注意的是通常在activity里申明的view都是private，而private的属性没法通过反射直接初始化，所以需要调用setAccessible函数设置为true，这样属性就可以被访问了，但调用该方法并不意味着原有属性的访问权限修饰已改变，也就是该属性仍然是private。

对layout和view的注入都比较简单，也很容易理解，接下来是重头戏，也就是点击事件的注入实现，需要用到动态代理，也就是AOP（面向切面编程）。做客户端的同学应该很少有接触这个的，通常在web项目中使用比较多。这部分知识大家也可以搜索一下，很多详细介绍，不废话了，上代码：

Method[] methods = handlerType.getDeclaredMethods();
        if (methods != null && methods.length > 0) {
            for (Method method : methods) {

                if (Modifier.isStatic(method.getModifiers())
                        || !Modifier.isPrivate(method.getModifiers())) {
                    continue;
                }

                //检查当前方法是否是event注解的方法
                Event event = method.getAnnotation(Event.class);
                if (event != null) {
                    method.setAccessible(true);
                    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++) {
                            ViewInfo info = new ViewInfo();
                            info.value = values[i];
                            info.parentId = parentIdsLen > i ? parentIds[i] : 0;
                            EventListenerManager.addEventMethod(finder, info, event, handler, method);
                        }
                    } catch (Throwable ex) {
                    }
                }
            }
}

同样的，查找整个Activity中@Event注解，将private的注解函数访问权限做一下设置。由于这里使用的是动态代理，所以被Event注解的方法参数必须跟对应的点击事件参数一模一样。比如注解一个onClick事件，那你被注解的方法参数就必须是（View view），如果注解的是AdapterView.OnItemClickListener，被注解的方法参数必须是（AdapterView parent, View view, int position, long id），后面会讲到为什么要这么写。下面是EventListenerManager整个类的代码，这里对多点击事件缓存，还有多次点击都做了相应处理：

public class EventListenerManager {

    private EventListenerManager() {
    }

    /**
     * k1: viewInjectInfo
     * k2: interface Type
     * value: listener
     */
    private final static DoubleKeyValueMap, Object>
            listenerCache = new DoubleKeyValueMap, Object>();


    public static void addEventMethod(
            //根据页面或view holder生成的ViewFinder
            ViewFinder finder,
            //根据当前注解ID生成的ViewInfo
            ViewInfo info,
            //注解对象
            Event event,
            //页面或view holder对象
            Object handler,
            //当前注解方法
            Method method) {
        try {
            View view = finder.findViewByInfo(info);

            if (view != null) {
                // 注解中定义的接口，比如Event注解默认的接口为View.OnClickListener
                Class listenerType = event.type();
                // 默认为空，注解接口对应的Set方法，比如setOnClickListener方法
                String listenerSetter = event.setter();
                if (TextUtils.isEmpty(listenerSetter)) {
                    listenerSetter = "set" + listenerType.getSimpleName();
                }


                String methodName = event.method();

                boolean addNewMethod = false;
                /*
                    根据View的ID和当前的接口类型获取已经缓存的接口实例对象，
                    比如根据View.id和View.OnClickListener.class两个键获取这个View的OnClickListener对象
                 */
                Object listener = listenerCache.get(info, listenerType);
                DynamicHandler dynamicHandler = null;
                /*
                    如果接口实例对象不为空
                    获取接口对象对应的动态代理对象
                    如果动态代理对象的handler和当前handler相同
                    则为动态代理对象添加代理方法
                 */
                if (listener != null) {
                    dynamicHandler = (DynamicHandler) Proxy.getInvocationHandler(listener);
                    addNewMethod = handler.equals(dynamicHandler.getHandler());
                    if (addNewMethod) {
                        dynamicHandler.addMethod(methodName, method);
                    }
                }

                // 如果还没有注册此代理
                if (!addNewMethod) {

                    dynamicHandler = new DynamicHandler(handler);

                    dynamicHandler.addMethod(methodName, method);

                    // 生成的代理对象实例，比如View.OnClickListener的实例对象
                    listener = Proxy.newProxyInstance(
                            listenerType.getClassLoader(),
                            new Class[]{listenerType},
                            dynamicHandler);

                    listenerCache.put(info, listenerType, listener);
                }

                Method setEventListenerMethod = view.getClass().getMethod(listenerSetter, listenerType);
                setEventListenerMethod.invoke(view, listener);
            }
        } catch (Throwable ex) {
        }
    }

    public static class DynamicHandler implements InvocationHandler {
        // 存放代理对象，比如Fragment或view holder
        private WeakReference