制作自己的 @OnClick、@OnLongClick(告别 setOnClickListener,使用注解、反射和动态代理)

前言

前面我们说过 ButterKnife 这个库,这个库实现不仅实现了 View 的绑定,而且还提供了大量的注解如 @BindView@OnClick@OnLongClick 等来简化开发过程中事件绑定。而这些功能的实现是通过 APT 也就是注解处理器,在编译期间生成 Java 代码来实现的。
关于这一部分,大家请看前面的这篇文章,这篇文章将 ButterKnife 讲解的非常好,可以跟着一步一步实现一个自己的简易版本:
制作自己的 ButterKnife(使用 AutoService 和 APT 注解处理器在编译期生成 Java 代码)

不过这一次,我们不再使用 APT,而是利用注解和反射的巧妙结合,在运行时进行事件和 View 的绑定,让我们告别 setOnClickListener 这类的方法 。这里我们拿 @OnClick@OnLongClick 这两个注解为例,自己实现这两个注解的功能。

不过想要实现自己的绑定注解还是有一些前置条件的,需要学习注解,反射和动态代理这三个方面的知识,此处推荐下面的三篇文章,建议看完,并对刚说的三个知识点有一定认识,再来看本文。

  • 由浅入深 带你了解 JAVA 注解
  • Java Reflection 反射使用 完全指南
  • 代理模式与静态代理、动态代理的实现(Proxy.newProxyInstance、InvocationHandler)

这里插播一下我的公众号,也是最近开始弄,希望多多关注,以后我会发更多的高质量内容:
微信公众号二维码

确定目标

首先我们确定要实现的是两个注解的功能:@OnClick@OnLongClick。在没有这两个注解时,我们做事件绑定的代码如下:

public class MainActivity extends AppCompatActivity {@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);//为 id 为 button_1 的 View 设置 点击事件findViewById(R.id.button_1).setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) {Toast.makeText(MainActivity.this, "点击", Toast.LENGTH_SHORT).show();}});//为 id 为 button_2 的 View 设置 长按事件findViewById(R.id.button_2).setOnLongClickListener(new View.OnLongClickListener() {@Overridepublic boolean onLongClick(View v) {Toast.makeText(MainActivity.this, "长按", Toast.LENGTH_LONG).show();return true;}});}
}

而有了这两个事件绑定注解时,我们会将上面的代码改为下面这样,这也是我们最终效果的代码:

public class MainActivity extends AppCompatActivity {@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);InjectUtils.inject(this);            //在此处处理此类中的时间绑定注解}@OnClick({R.id.button_1})                //为 id 为 button_1 的 View 设置 点击事件,public void click(View view) {           //当 button_1 点击时,将触发此函数Toast.makeText(this, "点击", Toast.LENGTH_SHORT).show();}@OnLongClick({R.id.button_2})            //为 id 为 button_2 的 View 设置 长按事件public boolean longClick(View view) {    当 button_2 长按时,将触发此函数Toast.makeText(this, "长按", Toast.LENGTH_LONG).show();return true;}
}

确定了目标之后,我们就一步一步来实现这两个功能。这里可以看到,有三个地方需要我们去实现:

  • @OnClick 注解
  • @OnLongClick 注解
  • InjectUtils.inject(this) 代码

这三个只是我们现在看到的,如果要实现这个功能,要写的代码肯定只多不少。

风景_稻田

实现 @OnClick@OnLongClick 注解

我们先拿 @OnClick 来举个例子,正常情况下,根据要求,我们会写如下的注解:

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

这是没问题的,Target 设置为 METHOD 表明了这个注解是放到方法上的,RUNTIME 保证了我们能够在运行时拿到这个注解,里面设置了 int[] 类型的方法,使得其可以指定多个 View 的 ID。

到现在看似没什么问题,但是这里还是有问题。想象一下后续我们会使用反射来进行 View 的事件绑定,那么在事件的绑定时,需要什么信息呢?需要的信息有两个:

  • 事件绑定的方法,例如 View.setOnClickListener() 这个方法
  • 设置的事件的类型,例如 View.OnClickListener 这个类型

这里说需要者两个信息大家可能会一知半解,那么先放在这里,只知道需要这两个信息就行了。等看到后面自然就明白了。

现在知道需要这两个信息,那么我们添加这两个信息不就可以了?确实是这样的,但是问题又来了,这两个信息添加到哪里呢?如果我们直接添加到 @OnClick 这个注解的方法中,就像这样:

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

也不是不行,但是这样外层在用的时候,还需要指定这两个参数。这会对使用方造成误解,而且对于每一个注解,这两个信息是固定的,外面再指定是多余的,即使用 default 设置默认值,外边再重新指定这两个参数,也是我们不想看到的。

那最好的办法是怎样的呢?那就是注解多态,也就是使用自定义元注解。此处我们为 @OnClick@OnLongClick 自定义一个元注解 @EventBase

自定义元注解 @EventBase

上面我们知道那两个额外的信息是跟注解相关的,也就是说相同的注解这两个值是相同的,这种情况,自定义一个元注解,然后来修饰这两个注解是最合适不过了。如下,我自定义了一个 @EventBase 的元注解,这个注解只能放到注解上,且两个属性值对应着上面的两个信息:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface EventBase {String listenerSetter();    //绑定事件的方法,例如 "setOnClickListener"Class<?> listenerType();    //绑定的事件的类型,例如 View.OnClickListener.class
}

那么后面我们用这个注解来修改 @OnClick@OnLongClick 注解。

最终的 @OnClick 注解:

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@EventBase(listenerSetter = "setOnClickListener", listenerType = View.OnClickListener.class)
public @interface OnClick {int[] value();
}

最终的 @OnLongClick 注解:

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@EventBase(listenerSetter = "setOnLongClickListener", listenerType = View.OnLongClickListener.class)
public @interface OnLongClick {int[] value();
}

注意这两个注解虽然都使用了 @EventBase 来修改,但是传递给 @EventBase 的两个参数是不同的,都是与自己这个事件相关的方法和参数类型。

现在,这两个注解已经确定下来了,接下来我们就要去实现 InjectUtils 这个类,而且这个类也是实现这个功能的关键所在。

利用反射和动态代理绑定事件初期器

有人会问,你这个绑定的功能为什么会起个名字叫 InjectUtils,大家不要在意这个细节,只要知道这个类里的方法是实现 setOnClickListener 这个方法的就行,而且一般情况下,是在 MainActivity.onCreate 方法中调用的。

在最开始,我们确定了,这个类里面有 InjectUtils.inject(this) 方法,我们将会在 onCreate 中调用这个方法,就像调用 ButterKnife.bind(this) 一样。那么怎么写这个方法呢?我们一步一步来。
薰衣草

找到有 @OnClick@OnLongClick 注解的函数

既然我么要处理带有绑定注解的函数,那我们肯定就要找到有哪些函数被标记了自定义的 @OnClick@OnLongClick 注解。

这一步分的代码很简单,因为我们在 MainActivity.onCreate 方法中调用了 InjectUtils.inject(this),而这个 this 就表示需要进行注解解析的类,通过它的 Class对象,我们就能够找到哪些函数添加了需要处理的注解。

这部分的代码如下:

public class InjectUtils {public static void inject(Object context) {Class<?> clazz = context.getClass();Method[] methods = clazz.getDeclaredMethods();for(Method method: methods) {Annotation[] annotations = method.getAnnotations();for(Annotation annotation : annotations) {Class<? extends Annotation> annotationClass = annotation.annotationType();EventBase eventBase = annotationClass.getAnnotation(EventBase.class);//判断这个注解有没有被 @EventBase 标记,如果标记了,那么就能获取到。是我们应该处理的注解if(eventBase == null)continue;//走到这里就表示,这个方法是被 @OnClick 或 @OnLongClick 标记过的,应该处理绑定//TODO: binding}}}
}

这里主要有两个循环,外层循环是对这个类的所有方法循环,内层循环是对方法上的注解的循环。另外判断这个函数是否是事件处理的方法,则是判断注解是否被 @EventBase 注解标记,如果被这个注解标记,那么就是我们需要处理的方法了。

找到 View 并调用 setOnClickListener

接下来,走到上面 TODO 的地方,就是处理事件绑定。这里快到了全文的重点了,我们慢慢来看。

后面我们要做的其实就是调用 View.setOnClickListener(new OnClickListener()),那么用反射完成这个调用需要分几步呢?很简单,这就像要把大象装冰箱,总共要分三步:

  1. 首先要找到 View 对象
  2. 再找到 setOnClickListener 方法
  3. 通过反射 invoke 这个方法

是不是很简单,下面就是代码了:

try {Method valueMethod = annotationClass.getMethod("value");int[] viewIds = (int[]) valueMethod.invoke(annotation);        //获取传递给 @OnClick 的所有 View 的 IDif(viewIds == null)continue;for(int viewId: viewIds) {                                    // 每一个 View 都要调用 setOnClickListenerMethod findViewByIdMethod = clazz.getMethod("findViewById", int.class);View view = (View) findViewByIdMethod.invoke(context, viewId);         // 找到这个 viewId 对应的 View 对象if(view == null)continue;String listenerSetter = eventBase.listenerSetter();Class<?> listenerType = eventBase.listenerType();Method setListenerMethod = view.getClass().getMethod(listenerSetter, listenerType);    //找到 setOnClickListener 方法setListenerMethod.invoke(view, /*TODO*/);            //通过反射 invoke 这个方法}} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException exception) {exception.printStackTrace(System.err);
}

对于这一段代码,如果看了 Java Reflection 反射使用 完全指南,就很容易看懂。简单来说,就是上面的三步,这里需要注意的一点就是,获取 setOnClickListener 这个方法的地方,因为我们有两个注解,一个处理点按 @OnClick,一个处理长按 @OnLongClick,因此这里不能写死。

那么怎么获取对应的方法呢?还记得上面说的 @EventBase 这个注解么,这个注解就是提供这两个信息的。这两个信息是在写 @OnClick@OnLongClick 注解时就传递给 @EventBase 注解的,现在大家知道了为什么还要添加 @EventBase 这个注解了吧。一是能够通过它来判断哪些是我们写的注解,二是提供了这两个信息。

这样我们就拿到了对应的 setListenerMethod 方法,那么调用它即可。不过我们在调用时会发现一个很严重的问题(即代码中的 TODO 部分):传什么参数过去?第一个参数当然是 View 对象,那第二个参数呢?是不是需要实现一个 OnClickListener 的对象?答案是否定的,这个时候,我们需要动态代理!

创建动态代理处理事件

在这里我们确实需要一个 OnClickListener 实例,但在这个地方是不可能的,我们只能使用动态代理来做这个事情。

为什么要用动态代理呢?因为这里需要代理掉 OnClickListener 中的 onClick 方法。
为什么能用动态代理?因为目标对象是 OnClickListener 接口的实例。

这里我先将代码贴上,咱们再解释。另外,强烈建议在看这一部分之前看完 代理模式与静态代理、动态代理的实现(Proxy.newProxyInstance、InvocationHandler)
这篇文章,否则再怎么解释也很难理解的。

Object proxy = Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{listenerType}, new InvocationHandler() {@Overridepublic Object invoke(Object proxy, Method proxyMethod, Object[] args) throws Throwable {return method.invoke(context, args);}}
);setListenerMethod.invoke(view, proxy);

创建动态代理的三个参数,第一个选择当前 ActivityClassLoader;第二个是要设置的对应的接口,@OnClickOnClickListener 接口,@OnLongClickOnLongClickListener 接口;重点是第三个 InvocationHandler

当需要我们真的点击这个按钮的时候,点击事件会触发到 InvocationHandler.invoke 的方法,在这个方法中,我们必须通过反射调用被 @OnClick 或是 @OnLongClick 标记的函数,也就是在第一遍遍历中找到的那个 method

这个 Proxy.newProxyInstance 返回的是一个 Object 对象,但由于我们传入的是 listenerType 这个接口,因此其实际返回的就是一个 OnClickListener 或是 OnLongClickListener 接口的对象。而这个返回的对象,就是我们要设置到 setListenerMethod.invoke 中的参数。
风景_晚霞_海岸
至此,大功告成。上面是三个代码片段,下面我把 inject 整个方法的代码全部贴出来,大家看看。

public static void injectClick(Object context) {Class<?> clazz = context.getClass();Method[] methods = clazz.getDeclaredMethods();for(Method method: methods) {Annotation[] annotations = method.getAnnotations();for(Annotation annotation : annotations) {Class<? extends Annotation> annotationClass = annotation.annotationType();EventBase eventBase = annotationClass.getAnnotation(EventBase.class);if(eventBase == null)continue;try {Method valueMethod = annotationClass.getMethod("value");int[] viewIds = (int[]) valueMethod.invoke(annotation);if(viewIds == null)continue;for(int viewId: viewIds) {Method findViewByIdMethod = clazz.getMethod("findViewById", int.class);View view = (View) findViewByIdMethod.invoke(context, viewId);if(view == null)continue;String listenerSetter = eventBase.listenerSetter();Class<?> listenerType = eventBase.listenerType();Object proxy = Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{listenerType},(proxy1, method1, args) -> method.invoke(context, args));Method setListenerMethod = view.getClass().getMethod(listenerSetter, listenerType);setListenerMethod.invoke(view, proxy);}} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException exception) {exception.printStackTrace(System.err);}}}
}

总结

通过自定义 @OnClick@OnLongClick 注解以及使用反射和动态代理技术,我们成功地简化了点击事件的处理代码。这样的实现不仅提高了代码的可读性和维护性,还展示了高级编程技术在实际项目中的应用。

虽然这种技术看起来很牛逼,但是里面使用了大量的反射,会慢一些。而且这种代码交接别人维护的话,肯定是一脸懵逼。所以我总结一下:

不如 setOnClickListener ,也就自己装逼用。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/853145.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

MyBatis 的注解式开发

1. MyBatis 的注解式开发 文章目录 1. MyBatis 的注解式开发2. 准备工作3. Insert 插入/添加4. Delete 删除5. Update 更新/修改6. Select 查询7. 总结&#xff1a;8. 最后&#xff1a; MyBatis 中也提供了注解式开发方式&#xff0c;采用注解可以减少Sql映射文件的配置。 当然…

【React】useMemo

什么是 useMemo&#xff1f; useMemo 是 React 中的一个 Hook&#xff0c;它可以用来缓存计算结果&#xff0c;并在后续的渲染中重复利用这些计算结果。useMemo 接收两个参数&#xff1a;一个函数和一个依赖数组。当依赖数组中的任何一个值发生变化时&#xff0c;useMemo 会重新…

redis设计与实现(五)RDB与AOF持久化

RDB持久化 因为Redis是内存数据库&#xff0c;它将自己的数据库状态储存在内存里面&#xff0c;所以如果不想办法将储存在内存中的数据库状态保存到磁盘里面&#xff0c;那么一旦服务器进程退出&#xff0c;服务器中的数据库状态也会消失不见。 为了解决这个问题&#xff0c;…

如何定位检查不到的元素

光标离开输入框时&#xff0c;输入框立刻消失&#xff0c;导致无法查看该元素的html标签属性&#xff0c;如何定位这种元素呢&#xff1f;有两种方法&#xff0c;一种是通过事件监听器&#xff0c;另一种是通过网络接口抓包 1、首先定位到搜索按钮 这个搜索的按钮&#xff0c;当…

鸿蒙低代码开发的局限性

在版本是DevEco Studio 3.1.1 Release&#xff0c;SDK是3.1.0(API9) 的基础上。 1、低代码插件没有WebView组件。 2、低代码插件没有空白的自定义组件&#xff0c;当前提供的所谓自定义组件&#xff0c;只能用列表中提供的组件来拼接新的组件。 3、使用ets代码自定义的组件&…

PyTorch 张量数据类型

【数据类型】Python 与 PyTorch 常见数据类型对应&#xff1a; 用 a.type() 获取数据类型&#xff0c;用 isinstance(a, 目标类型) 进行类型合法化检测 >>> import torch >>> a torch.randn(2,3) >>> a tensor([[-1.7818, -0.2472, -2.0684],[ 0.…

(Javascript)AI数字人mp4转canvas播放并去除背景绿幕

1、需求介绍 H5页面嵌入AI数字人播报&#xff0c;但生成的数字人是mp4格式且有绿幕背景&#xff0c;需要转成canvas并去除背景&#xff1b; 2、效果&#xff1a; 去除前&#xff1a; 去除后&#xff1a; 3、代码 <!DOCTYPE html> <html lang"en"><…

上位机能不能替代PLC实现控制?为什么一定要学上位机?

上位机是一个广泛用于自动化控制系统的术语&#xff0c;它通常指的是在自动化控制系统中&#xff0c;用于监控和控制下位机&#xff08;通常是嵌入式系统或者是PLC等&#xff09;的计算机系统。上位机可以通过各种通信协议&#xff08;如RS232、RS485、以太网等&#xff09;与下…

C端设计师去做B端界面设计易犯哪些?要不要给他提个醒。

2024-03-29 17:03大美B端工场 很多C端设计师初涉B端设计&#xff0c;思路转变不过来&#xff0c;还用C端思想指导B端设计&#xff0c;结果就是总感觉不舒服&#xff0c;大美B端工场&#xff0c;为大家详细解读一下。 当C端设计师去设计B端界面时&#xff0c;可能会经常犯以下…

C++面向对象程序设计 - 函数库

C语言程序中各种功能基本上都是由函数来实现的&#xff0c;在C语言的发展过程中建立了功能丰富的函数库&#xff0c;C从C语言继承了些函数功能。如果要用函数库中的函数&#xff0c;就必须在程序文件中包含文件中有关的头文件&#xff0c;在不同的头文件中&#xff0c;包含了不…

时间复杂度与空间复杂度题目讲解

前言&#xff1a; 在前面我们了解到了时间复杂度与空间复杂度&#xff0c;这里我们就可以尝试一下做一些关于时间复杂度与空间复杂度的题目。 1. 数组篇 题目一&#xff1a;消失的数字 消失的数字&#xff1a;. - 力扣&#xff08;LeetCode&#xff09; 思路&#xff1a; 看…

Elixir学习笔记——进程(Processes)

在 Elixir 中&#xff0c;所有代码都在进程内运行。进程彼此隔离&#xff0c;彼此并发运行并通过消息传递进行通信。进程不仅是 Elixir 中并发的基础&#xff0c;而且还提供了构建分布式和容错程序的方法。 Elixir 的进程不应与操作系统进程混淆。Elixir 中的进程在内存和 CPU…

进程的创建和管理

一. 实验内容 1&#xff0e; 编写一个程序&#xff0c;程序中创建一个子进程。然后父、子进程各自独立运行&#xff0c;父进程不断地在标准输出设备&#xff08;即显示器&#xff09;上输出字母p和回车&#xff08;输出30次或以上&#xff09;&#xff0c;子进程不断地在标准输…

[面试题]Java【并发】

[面试题]Java【基础】[面试题]Java【虚拟机】[面试题]Java【并发】[面试题]Java【集合】[面试题]MySQL 因为 Java 并发涉及到的内容会非常多&#xff0c;本面试题可能很难覆盖到所有的知识点&#xff0c;所以推荐 《Java并发编程的艺术》 。 Java 线程 线程 通知 等待 线…

植物ATAC-seq文献集锦(三)——果实发育篇

ATAC-seq在植物研究领域的应用我们已经介绍2期了&#xff0c;本期我们聚焦ATAC-seq技术在果实发育方向的应用案例。 植物ATAC-seq文献集锦&#xff08;一&#xff09;——基因组篇 植物ATAC-seq文献集锦&#xff08;二&#xff09;——生长发育篇 文献一&#xff1a;Ident…

Linux 内核 (十二)进程间通讯 之 消息队列

前言 这个系列的上一篇介绍了进程间通讯关于管道相关的内容及代码实例,本章要介绍关于消息队列相关的内容. 消息队列交互图示 函数原型 #include <sys/msg.h> #include <sys/ipc.h> //创建 or 打开队列 成功返回队列ID,失败返回-1 int msgget(key_t key,int fla…

商城小程序系统:一站式搭建,轻松上线

前言 近年来&#xff0c;商城小程序系统以其便捷、高效的特点&#xff0c;正逐渐成为商品买卖的新宠。这类小程序&#xff0c;类似于我们熟知的京东、淘宝等电商巨头&#xff0c;为商家提供了一个全新的销售渠道&#xff0c;让商品买卖更加智能化、便捷化。 一、商城小程序有什…

【Linux】从零开始配置新的服务器的机器学习环境

终端远程登录 ssh -p [端口号] [服务器用户名][服务器IP]或者 ssh [用户名][主机地址]第二种的前提是在.ssh\config中配置了host 安装文本编辑器vim 主要用于后续的文本编辑&#xff0c;个人比较习惯用vim&#xff0c;根据自己喜好选择 更新apt sudo apt update安装文本编辑…

MyBatis使用 PageHelper 分页查询插件的详细配置

1. MyBatis使用 PageHelper 分页查询插件的详细配置 文章目录 1. MyBatis使用 PageHelper 分页查询插件的详细配置2. 准备工作3. 使用传统的 limit 关键字进行分页4. PageHelper 插件&#xff08;配置步骤&#xff09;4.1 第一步&#xff1a;引入依赖4.2 第二步&#xff1a;在m…

在VMware中安装CentOS7(超详细的图文教程)

1、CentOS7的下载 官网下载地址&#xff1a;Download。 进入CentOS下载官网&#xff0c;找到64位的CentOS7版本。 点进来后&#xff0c;发现它给我们列出了所在区域可用镜像源&#xff08;可以说是非常的良心的&#xff09;&#xff0c;我们随便选择一个&#xff0c;这里以阿…