• 新浪微博:
  • 按键公众号 :
按键精灵电脑版
立即下载

软件版本:2014.06
软件大小:22.9M
更新时间:03-18

按键精灵安卓版
立即下载

软件版本:3.6.5
软件大小:46.2M
更新时间:03-02

按键精灵iOS版
立即下载

软件版本:1.7.6
软件大小:29.2M
更新时间:12-06

最新企业版UiBot
立即下载

软件版本:3.3
软件大小:282M
更新时间:08-06

快捷导航

登录 后使用快捷导航
没有帐号? 注册

发新话题 回复该主题

[紫猫] 按键精灵手机版插件的开发标准草案与简易教程 [复制链接]

1#
什么是按键精灵手机版插件?
按键精灵手机版可以通过Lua编程语言实现更加高级的功能扩展,例如大家熟知的紫猫插件就是通过Lua编程语言实现的。

为什么要制定插件开发标准草案?
一个优秀健壮的插件应该在不影响他人插件,不影响脚本自身等情况下提供可靠的功能扩展。
紫猫插件手机版在多年开发的过程中,踩过各种各样的坑,深知一个优秀插件开发的不易。
故本贴主旨是为了帮助大家少走弯路,通过统一的插件开发标准实现稳健的功能扩展。

本帖子适合哪些人阅读?
本帖子并非Lua编程教学,不适合对Lua编程语言完全不懂的人阅读。
如果你想要学习Lua编程,可以报名我们Lua课程学习,也可以查阅各种Lua文档资料学习。
本帖子主要以插件开发标准规范为主,适合已经会写一些Lua代码实现插件制作的人阅读。
如无特殊说明,本帖子中的代码均为Lua代码。




1. 按键精灵手机版插件开发简易教程

通过一个table类型的QMPlugin变量实现按键精灵调用Lua函数,例如
  1. -- Lua代码
  2. -- 实现两数相加求和
  3. function QMPlugin.Add(a, b)
  4. return a + b
  5. end
复制代码
将以上代码保存成.lua文件,例如test.lua后,放入按键精灵手机助手的plugin文件夹内。
再重启按键精灵手机助手或者刷新插件列表,即可看到自己写的test插件了。
在按键精灵中调用代码如下
  1. //按键精灵代码
  2. Import "test.lua" //导入插件

  3. Dim 结果 = test.Add(11, 22)
  4. TracePrint 结果 //输出结果为33
复制代码
插件开发模板在本贴最后面有提供下载链接,请继续阅读。

2. 函数作用域的标准草案

所有变量与函数均使用local关键字定义成局部作用域(除了自带的QMPlugin外)。

因为多个插件是共用同一个全局作用域,假如插件A定义了一个全局函数Add,然后插件B也定义了同名但不同功能的全局函数Add,当脚本里同时加载这两个插件时,有一定概率会造成某一个插件内部Add函数被覆盖,导致该插件功能异常。例如紫猫插件V1版时期与山海师插件就造成过函数覆盖冲突,当然,现在的紫猫插件是不会与任何插件冲突了,因为插件内部全是局部作用域的函数。

一个简易的冲突例子演示,一个是相加功能的add,一个是返回第一个参数的add,但是由于全局冲突原因,导致有一定概率只返回一个功能。如果两个add函数前面加上local关键字即可完美解决该问题。
  1. -- test1.lua插件代码
  2. function add(a, b)
  3. return a + b
  4. end

  5. function QMPlugin.add(a, b)
  6. return add(a, b)
  7. end
复制代码
  1. -- test2.lua插件代码
  2. function add(a)
  3. return a
  4. end

  5. function QMPlugin.add(a)
  6. return add(a)
  7. end
复制代码
按键精灵调用出现异常的截图。


3. 函数定义的标准草案

定义两个局部作用域的table数据,一个用来存放对外公开函数,一个用来存放对内私有函数,注意不要跟插件文件同名。

例如以下插件源码
  1. --插件文件名请勿保存为zimao.lua, 否则会无法调用函数
  2. local _zimao = {} --这是内部私有table函数
  3. local zimao = {} --这是对外公开table函数
  4. QMPlugin = zimao --通过这行代码, 实现将zimao表中所有函数对外公开

  5. _zimao.ver = "20220217" --内部私有变量赋值,

  6. function _zimao.add(a, b) --内部私有函数定义, 按键精灵中无法使用该函数
  7. return a + b
  8. end

  9. function zimao.LuaVer() --定义对外公开函数, 即插件命令
  10. return _VERSION --返回按键精灵使用的Lua版本5.2
  11. end
复制代码
尽可能的减少其他多余的插件级局部变量,这里的插件级局部变量是指与以上源码中_zimaozimao相同作用域的变量。因为同级局部变量最多只能存放200个,这是紫猫插件命令功能首次超过200个时,遇到了错误:too many local variables (limit is 200) in main function near '='后,查阅资料得知,Lua使用一个栈存放它的寄存器,每个运行中的函数都有各自的一份活动记录,这些活动记录保存在栈中,内部存放每一个函数对应的寄存器。每条指令中只有8个bit用来标志寄存器,所以每个函数最多能够使用250个寄存器。为了空间与执行效率,Lua在lpaser.c源文件中定义了默认最多200个局部变量。但通过借助table数据类型,可以突破整个限制,减少局部变量总数。

所以这里我们推荐通过两个table变量来存放数据,适当的减少局部变量。当然,function函数内部的局部变量一般不会超过200个,所以函数中不用担心这个问题。

4. 函数结构的标准草案

为了避免插件内部各种意外错误导致脚本终止运行,推荐使用保护运行模式执行函数代码。这里提供一份Lua版的自定义 try...catch...finally 函数,利用这三个函数可以实现异常捕获处理,下面是这3个函数的用法,可以单独只用try,也可以使用try+catch,也可以try+catch+finally
代码下载:
trycatchfinally.lua (, 下载次数:70)

代码截图:


我们把这个保护执行加到我们的插件代码中,以下是一个完整的插件例子。
更多插件Lua源码例子可以参考按键精灵手机助手Plugin目录下的zmFile.lua文件。

标准插件开发模板与例子的代码下载:
example.lua (, 下载次数:88)

代码截图:

按键精灵执行效果截图:


最后编辑紫猫 最后编辑于 2022-02-18 10:42:22
本主题由 超级版主 瑞祥幽冥狼 于 2022/2/21 12:24:14 执行 审核帖子 操作

【紫猫编程学院】火热招生中

教学涉及按键精灵(电脑版与手机版)、网页、游戏、办公、插件等。

报名咨询QQ: 345911220 微信:zimaoxy

紫猫学院免费教程

加入交流QQ群: 7333555


2#


3#

膜拜大佬~

紫猫学员236-斷橋
发新话题 回复该主题