Android注解——不用ButterKnife也能自己搞定findViewById和onClick事件绑定

  1. 云栖社区>
  2. 博客>
  3. 正文

Android注解——不用ButterKnife也能自己搞定findViewById和onClick事件绑定

懂音乐码虫 2018-04-10 13:17:00 浏览632
展开阅读全文

ButterKnife大家肯定都是用过啦,这是谷歌大神Jake Wharton写的一个开源的IOC框架,用起来很方便,帮我们省去了很多重复机械的代码。如果还有小伙伴,只会用findViewById的方法获取View实例,那就真的很Out咯!


img_a1320f7d8ebcb381de879342a9d7d92b.png
image.png

ButterKnife可以做很多事:绑定View(@BindView);绑定资源(@BindString);绑定监听(@OnClick( ))等等等等.........不过感觉项目里用得比较频繁的应该也就这几个了,今天我们就来花五分钟的时间,自己动手写一个,不用ButterKnife,轻松搞定注解。

注解和反射密不可分,注解的实现依赖于反射。接下来以使用注解的方式,实例化View为例,写一个类似ButterKnife的@BindView的注解:
(1)新建一个注解 ViewById


img_8281b91a81cb5db313ff1248dc20f169.png
image.png
@Retention(RetentionPolicy.RUNTIME)//CLASS 编译时注解  RUNTIME运行时注解 SOURCE 源码注解
@Target(ElementType.FIELD)//注解作用范围:FIELD 属性  METHOD方法  TYPE 放在类上
public @interface ViewById {  //@interface则是表明这个类是一个注解
    int value(); //表示@ViewById() 注解时,括号里面的编写的为int类型的值
}

(2)新建一个ViewBind的类,该类具体实现了如何通过反射,来给注解的变量创建实例。

public class ViewBind {
    public static void inJect(Activity activity) {
        findViewById(activity);
    }
    private static void findViewById(Activity activity) {
        //获取Activity的class
        Class<? extends Activity> clazz = activity.getClass();
        //获取该类中的所有声明的属性
        Field[] declaredFields = clazz.getDeclaredFields();
        //遍历所有属性,找到用@ViewById注解了的属性
        for (int i = 0; i < declaredFields.length; i++) {
            Field field = declaredFields[i];
            //获取属性上的注解对象
//            @ViewById(R.id.textView) R.id.textView--value
//            TextView textView;//属性
            ViewById annotation = field.getAnnotation(ViewById.class);
            if (annotation != null) {
                int viewId = annotation.value();
                View view = activity.findViewById(viewId);
                try {
                    //私有属性也可以动态注入(不写该句代码,private声明的属性会报异常)
                    field.setAccessible(true);
                    field.set(activity, view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

(3)测试代码:文本能正常显示,就说明牟问题啦!

public class TestActivity extends AppCompatActivity{
  @ViewById(R.id.textView)
  TextView textView;
  @Override
  protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.act_test);
        ViewBind.inJect(this);
        textView.setText("This is annotation test")
    }
}

按照以上思路,相信你已经知道怎么写一个事件绑定的注解啦!:
@OnClickView (点击事件)

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClickView {
    int[] value(); 
}

在前面的ViewBind类中添加方法,并在inJect()方法中调用onClick()

    /**
     * 处理OnClick注解
     */
    private static void onClick(final Activity activity) {
        // findViewById  setOnClick
        // 1.获取该Activity的所有方法
        Class<?> clazz = activity.getClass();

//        Method[] methods = clazz.getDeclaredMethods();

        // 2.遍历方法获取所有的值
//        for (final Method method:methods){
//            // 2.1 获取OnClick注解
//            OnClickView onClick = method.getAnnotation(OnClickView.class);
        try {
            final Method method = clazz.getMethod("onClick", View.class);
            OnClickView onClick = method.getAnnotation(OnClickView.class);
            // 2.2 该方法上是否有OnClick注解
            if (onClick != null) {
                // 2.3 获取OnClick里面所有的值
                int[] viewIds = onClick.value();// @OnClick({R.id.text_view,R.id.button})

                // 2.4 先findViewById , setOnclick
                for (int viewId : viewIds) {
                    // 先findViewById
                    final View view = activity.findViewById(viewId);
                    // 后设置setOnclick
                    view.setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View v) {
                            // 首先需要判断 方法是否需要检测网络
                            // 3.反射调用原来配置了OnClick的方法
                            method.setAccessible(true);// 私有的方法

                            try {
                                method.invoke(activity);// 调用无参的方法
                            } catch (Exception e) {
                                e.printStackTrace();
                                try {
                                    method.invoke(activity, view);// 调用有参的方法 view 代表当前点击的View
                                } catch (Exception e1) {
                                    e1.printStackTrace();
                                }
                            }
                        }
                    });
                }
//            }
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }

    }

测试View的点击事件:

  @OnClickView({R.id.button, R.id.textView})
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.textView:
                Toast.makeText(TestActivity.this, "点击了textView", Toast.LENGTH_SHORT).show();
                break;
            case R.id.button:
                Toast.makeText(TestActivity.this, "点击了button", Toast.LENGTH_SHORT).show();
                break;
        }
    }

至此,绑定View和绑定点击事件全部搞定,是不是很简单!!!
最后Demo运行结果:


img_b8bd0a6801515a410c8f17c78897f6c1.gif
Animation.gif

同理,你还可以绑定布局文件,下面给出InjectUtils类完整代码:

package com.example.jojo.mvp_kotlin.ioc;

import android.app.Activity;
import android.view.View;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * Created by JoJo on 2018/4/3.
 * wechat:18510829974
 * description:注解utils类
 */

public class InjectUtils {

    public static void inJect(Activity activity) {
        injectContentView(activity);
        findById(activity);
        onClick(activity);
    }
    //遍历类里面所有声明的方法,找到加了注解的方法
//    private static void onclick(final Activity activity) {
//        Class<? extends Activity> clazz = activity.getClass();
//        Method[] declaredMethods = clazz.getDeclaredMethods();
//        for (int i = 0; i < declaredMethods.length; i++) {
//
//            final Method method = declaredMethods[i];
//            if (method == null) {
//                return;
//            }
//            if (method != null) {
//                OnClickView annotation = method.getAnnotation(OnClickView.class);
//                if(annotation!=null) {
//                    int[] values = annotation.value();
//                    for (int j = 0; j < values.length; j++) {
//                        final View view = activity.findViewById(values[j]);
//                        if (view == null) {
//                            continue;
//                        }
//                        view.setOnClickListener(new View.OnClickListener() {
//                            @Override
//                            public void onClick(View v) {
//                                try {
//                                    method.invoke(activity);// 调用无参的方法
//                                } catch (Exception e) {
//                                    e.printStackTrace();
//                                    try {
//                                        method.invoke(activity, view);// 调用有参的方法 view 代表当前点击的View
//                                    } catch (Exception e1) {
//                                        e1.printStackTrace();
//                                    }
//                                }
//                            }
//                        });
//                    }
//                }
//
//            }
//        }
//
//    }

    /**
     * 处理OnClick注解:直接找到该类名称为onClick的方法,作为专属处理点击事件的方法
     */
    private static void onClick(final Activity activity) {
        // findViewById  setOnClick
        // 1.获取该Activity的所有方法
        Class<?> clazz = activity.getClass();

//        Method[] methods = clazz.getDeclaredMethods();

        // 2.遍历方法获取所有的值
//        for (final Method method:methods){
//            // 2.1 获取OnClick注解
//            OnClickView onClick = method.getAnnotation(OnClickView.class);
        try {
            final Method method = clazz.getMethod("onClick", View.class);
            OnClickView onClick = method.getAnnotation(OnClickView.class);
            // 2.2 该方法上是否有OnClick注解
            if (onClick != null) {
                // 2.3 获取OnClick里面所有的值
                int[] viewIds = onClick.value();// @OnClick({R.id.text_view,R.id.button})

                // 2.4 先findViewById , setOnclick
                for (int viewId : viewIds) {
                    // 先findViewById
                    final View view = activity.findViewById(viewId);
                    if (view == null) {
                        continue;
                    }
                    // 后设置setOnclick
                    view.setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View v) {
                            // 首先需要判断 方法是否需要检测网络
                            // 3.反射调用原来配置了OnClick的方法
                            method.setAccessible(true);// 私有的方法

                            try {
                                method.invoke(activity);// 调用无参的方法
                            } catch (Exception e) {
                                e.printStackTrace();
                                try {
                                    method.invoke(activity, view);// 调用有参的方法 view 代表当前点击的View
                                } catch (Exception e1) {
                                    e1.printStackTrace();
                                }
                            }
                        }
                    });
                }
//            }
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }

    }

    private static void findById(Activity activity) {
        //获取Activity的class
        Class<? extends Activity> clazz = activity.getClass();
        //获取该类中的所有声明的属性
        Field[] declaredFields = clazz.getDeclaredFields();
        for (int i = 0; i < declaredFields.length; i++) {
            Field field = declaredFields[i];
            //获取属性上的注解对象
//            @ViewById(R.id.textView) R.id.textView-value
//            TextView textView;//属性
            ViewById annotation = field.getAnnotation(ViewById.class);
            if (annotation != null) {
                int viewId = annotation.value();
                View view = activity.findViewById(viewId);
                try {
                    //私有属性也可以动态注入(不写该句代码,private声明的属性会报异常)
                    field.setAccessible(true);
                    field.set(activity, view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 注入主布局文件
     *
     * @param activity
     */
    private static void injectContentView(Activity activity) {
        Class<? extends Activity> clazz = activity.getClass();
        // 查询类上是否存在ContentView注解
        ContentView contentView = clazz.getAnnotation(ContentView.class);
        if (contentView != null)// 存在
        {
            int contentViewLayoutId = contentView.value();
            try {
                Method method = clazz.getMethod("setContentView",
                        int.class);
                method.setAccessible(true);
                method.invoke(activity, contentViewLayoutId);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

涉及到的注解类:

package com.example.jojo.mvp_kotlin.ioc;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by JoJo on 2018/4/11.
 * wechat:18510829974
 * description: 布局文件注解
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ContentView {
    int value();
}
package com.example.jojo.mvp_kotlin.ioc;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by JoJo on 2018/4/3.
 * wechat:18510829974
 * description: 绑定View的注解
 */
@Retention(RetentionPolicy.RUNTIME)//CLASS 编译时注解  RUNTIME运行时注解 SOURCE 源码注解
@Target(ElementType.FIELD)//注解作用范围:FIELD 属性  METHOD方法  TYPE 放在类上
public @interface ViewById {
    int value();
}
package com.example.jojo.mvp_kotlin.ioc;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by JoJo on 2018/4/3.
 * wechat:18510829974
 * description:点击事件注解
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClickView {
    int[] value();
}

使用的时候,在BaseActivity中初始化,就可以使用了。
oncreate()方法中初始化:

 InjectUtils.inJect(this)

读到这里,你对注解是不是多了一些理解呢,有关注解,你还有一些不得不了解的小知识:

IOC(Inversion of Control)——控制反转的意思。就是一个类里面需要很多成员变量,传统的写法:若需要用到这些成员变量,你需要new一个实例。IOC的处理是:我们不需要new,这样耦合度太高,你配置个xml文件,里面标明哪个类,里面用了哪些成员变量,等待加载这个类的时候,我帮你new出来。
你可能会问:“写个配置文件,这么麻烦?”于是又出现了另一种方案:在你需要注入的成员变量上面加个注解,例如:@Inject ,这样通过反射,就可以帮你new出来这个变量的实例,就是这么简单!(参考:IOC框架浅析https://www.jianshu.com/p/3968ffabdf9d

Java的反射机制及反射的作用:

概念:JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意一个方法和属性;这种动态获取的信息以及动态调用对象的方法的功能称为java语言的反射机制。

作用:

①可以在运行时获取任意一个类的所有属性和方法

②可以在运行时创建任意一个类的对象</br>

③可以在运行时得到任意一个对象所属的类</br>

④可以在运行时获取任意一个类型的构造方法,创建对象

⑤可以在运行时获取任意一个类型的父类或者父接口

⑥生成动态代理

网友评论

登录后评论
0/500
评论
懂音乐码虫
+ 关注