新版Glance发布,更好用的Android数据库调试助手

时间:2022-02-14 20:52:09

新版Glance发布,更好用的Android数据库调试助手

Glance是一个由我开发的用于调试Android数据库的开源库,无须借助电脑和数据线,直接在手机上就可以查看当前App中数据库的内容。

Glance的1.0版本于去年12月份推出,具体功能可以参考这篇文章 我又开发了一个非常好用的开源库 。

然而自从首个版本推出之后,Glance就再也没有更新过。主要还是因为我实在是太忙了,平时只能用零散的业余时间写写博客,还有3个开源项目要同时维护,能分配到Glance上的时间实在有限。

然而就这样零零散散地写了8个多月的代码,Glance确实变得比之前更加优秀了。虽然增加的一些新功能看上去并不是很重要,但累积多了之后,我认为这已经足以发布一个全新的版本了。

那么Glance 1.1.0版本今天正式发布,就让我来带着大家看看新版的Glance到底多了哪些新功能吧。

/ 支持显示Room数据库 /

之前有不少朋友在使用Glance的时候向我反馈,说有些数据库Glance是显示不出来的,包括使用Room创建的数据库。

新版Glance发布,更好用的Android数据库调试助手

新版Glance发布,更好用的Android数据库调试助手

之所以会出现这样的情况,是因为Glance在搜索数据库文件时只是简单地以.db后缀名来作为判断条件。这种方式优点是效率非常高,但缺点也很明显,搜索的结果不准。因为有些数据库文件并不是以.db为后缀的,比如说Room创建的数据库默认都是无后缀的。

因此,在新版的Glance当中,我将搜索规则进行了修改,不再是简单地以后缀名来进行判断,而是真正地去判断该文件是不是一个数据库文件。

Android上的数据库文件如果以二进制的方式去读取它,它的头部一定是以"SQLite format 3"开始的,所以通过以下代码就能够准确地判断出一个文件是不是数据库文件:

  1. /** 
  2.  * Check this file is valid SQLite db file or not
  3.  */ 
  4. fun File.isValidDBFile() = try { 
  5.     val reader = FileReader(this) 
  6.     val buffer = CharArray(16) 
  7.     reader.read(buffer, 0, 16) 
  8.     val str = String(buffer) 
  9.     reader.close() 
  10.     str == "SQLite format 3\u0000" 
  11. } catch (e: Exception) { 
  12.     e.printStackTrace() 
  13.     false 

虽然对所有文件都执行这样的判断必然会影响一定的搜索效率,但是Glance还同时拥有对数据库文件的缓存机制,之前搜索过的结果会迅速展示出来,因此在这方面能弥补一些效率的问题。

/ 允许横向纵向同时滚动 /

Glance查看数据库表内容的界面做得还算是比较精美的,如下图所示:

新版Glance发布,更好用的Android数据库调试助手

这个界面是使用横向ScrollView加纵向RecyclerView的方式来实现的,所以支持在横向和纵向两个方向上滑动。

但是同一时刻,我们只能进行横向滑动或纵向滑动,不支持在横向和纵向上同时滑动。

这里我要特别感谢ultimateHandsomeBoy666这位网友,他向Glance提交了一个Pull request,使得我们可以在横向和纵向上同时滑动来查看数据。

新版Glance发布,更好用的Android数据库调试助手

至于实现的原理也很简单:

  1. /** 
  2.  * deal with the motion event to scroll, while passing the event downwards 
  3.  */ 
  4. override fun dispatchTouchEvent(ev: MotionEvent?): Boolean { 
  5.     onTouchEvent(ev) 
  6.     return super.dispatchTouchEvent(ev) 
  7.  
  8. /** 
  9.  * do not intercept touch event so that child scrollable view can also receive event to scroll 
  10.  */ 
  11. override fun onInterceptTouchEvent(ev: MotionEvent?): Boolean = false 

就是在外层的横向ScrollView当中,我们不使用默认的onInterceptTouchEvent拦截机制,而是让它不要拦截。

然后在dispatchTouchEvent的时候,我们除了自己处理这个Touch事件之外,同时也将事件分发出去,这样RecyclerView就可以一起处理这个事件了。

最终的效果如下图所示:

新版Glance发布,更好用的Android数据库调试助手

/ 支持多应用入口区分 /

Glance的入口是会在手机桌面创建一个Glance的图标,点击该图标即可查看你的应用中包含的数据库文件。

新版Glance发布,更好用的Android数据库调试助手

然而,我没想到的一个问题是,假如一个手机上安装了很多个应用,而这些应用都引入了Glance库,那么会导致你完全分不清楚每个Glance图标到底对应的是哪个应用。

这个问题也是由一位热心网友提出我才意识到的:

新版Glance发布,更好用的Android数据库调试助手

可以看到,桌面上一堆Glance图标,已经完全不知道哪个是哪个了。

刚看到这个Bug时,我还没想好要怎么修,因为那个时候正在忙着写另外一个功能。没想到几天之后发现ultimateHandsomeBoy666这位网友又提了一个Pull request,将这个问题给修复了。

ultimateHandsomeBoy666采取的方案是,桌面Glance的入口图标不再命名成Glance,而是命名成和主App一样的名字,但是图标仍然保持Glance的样式,以和主App做区分。这样即使有再多的App引用Glance,也不会造成混乱了。

新版Glance发布,更好用的Android数据库调试助手

我认为这种修改方式非常恰当,再次感谢ultimateHandsomeBoy666这位朋友的帮助。

/ 允许修改数据库内容 /

好吧,我这8个月的主要工作应该都在这个功能上了。

之前Glance的主要功能是帮助你查找出当前应用中所包含的所有数据库,并将它们的内容展示出来。

也就是说,你只能看一看里面的数据而已。但如果想要对其中的数据进行修改,这是不可以的。

而修改数据是一个非常有用的功能,也是长期以来不少朋友的呼声。因此Glance 1.1.0版本最重磅的一个功能就是,允许开发者直接在手机中对当前应用的数据库数据进行修改。

至于修改数据的方式也非常简单,直接在你想要修改的那条数据上双击即可,如下图所示:

新版Glance发布,更好用的Android数据库调试助手

这种便捷的可视化界面修改数据的方式相信许多开发者朋友都是非常需要的,你完全不需要借助电脑,全部在手机上就可以完成。

另外我想说的是,Glance展示数据库内容的功能是使用Paging 3实现的。之前我在写讲解Paging 3用法文章的时候,有不少朋友问我在Paging 3中要如何才能修改数据,听上去像是一个非常难以完成的事情。由于我当时确实没有尝试过修改数据这个功能,所以也回答不上来这些朋友的问题。

但是这次在Glance中实现修改数据功能之后,我发现Paging 3在修改数据上并没有什么无法实现或难理解的地方,和正常使用RecyclerView时修改数据的方法几乎是差不多的。因此以后如果还有朋友在使用Paging 3时有修改数据的疑问,不妨可以参考下Glance的源码实现。

最后,使用Glance来修改数据还有一个限制,就是表中一定要有主键,否则是无法修改的。因为主键是对一行数据的唯一约束,如果没有主键的话,Glance是无法知道用户想要修改哪一行数据的。

/ 如何升级 /

关于Glance新版本的内容变化就介绍到这里,升级的方式非常简单,修改一下dependencies当中的版本号即可:

  1. repositories { 
  2.   google() 
  3.   mavenCentral() 
  4.  
  5. dependencies { 
  6.     debugImplementation 'com.guolindev.glance:glance:1.1.0' 

注意现在一定要使用mavenCentral仓库,而不能再使用jcenter了。至于原因,可以参考我的这篇文章 浅谈JCenter即将被停止服务的事件 。

如果你对Glance的源码感兴趣,可以访问Glance的项目主页:https://github.com/guolindev/Glance

原文地址:https://mp.weixin.qq.com/s/sqANJWY4dUgBhpbWCNmygQ