按键精灵手机版插件的开发标准草案与简易教程 _ 按键精灵脚本教程

查看: 43576\|回复: 114	[紫猫] 按键精灵手机版插件的开发标准草案与简易教程 [复制链接]

紫猫

[紫猫学院创始人]

组别按键认证导师
UID513852
帖子3624
精华47
鲜花4633 朵
铜币28052 个
银币6157 个
在线时间190000
注册时间2010-10-09

1^#

字体大小: t T

发表于 2022-02-17 21:18 | |只看楼主

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

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

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

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

通过一个table类型的QMPlugin变量实现按键精灵调用Lua函数，例如

-- Lua代码
-- 实现两数相加求和
function QMPlugin.Add(a, b)
return a + b
end

复制代码

将以上代码保存成.lua文件，例如test.lua后，放入按键精灵手机助手的plugin文件夹内。
再重启按键精灵手机助手或者刷新插件列表，即可看到自己写的test插件了。
在按键精灵中调用代码如下

//按键精灵代码
Import "test.lua" //导入插件
Dim 结果 = test.Add(11, 22)
TracePrint 结果 //输出结果为33

复制代码

插件开发模板在本贴最后面有提供下载链接，请继续阅读。

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

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

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

一个简易的冲突例子演示，一个是相加功能的add，一个是返回第一个参数的add，但是由于全局冲突原因，导致有一定概率只返回一个功能。如果两个add函数前面加上local关键字即可完美解决该问题。

-- test1.lua插件代码
function add(a, b)
return a + b
end
function QMPlugin.add(a, b)
return add(a, b)
end

复制代码

-- test2.lua插件代码
function add(a)
return a
end
function QMPlugin.add(a)
return add(a)
end

复制代码

按键精灵调用出现异常的截图。

3. 函数定义的标准草案

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

例如以下插件源码

--插件文件名请勿保存为zimao.lua, 否则会无法调用函数
local _zimao = {} --这是内部私有table函数
local zimao = {} --这是对外公开table函数
QMPlugin = zimao --通过这行代码, 实现将zimao表中所有函数对外公开
_zimao.ver = "20220217" --内部私有变量赋值,
function _zimao.add(a, b) --内部私有函数定义, 按键精灵中无法使用该函数
return a + b
end
function zimao.LuaVer() --定义对外公开函数, 即插件命令
return _VERSION --返回按键精灵使用的Lua版本5.2
end

复制代码

尽可能的减少其他多余的插件级局部变量，这里的插件级局部变量是指与以上源码中_zimao和zimao相同作用域的变量。因为同级局部变量最多只能存放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 (, 下载次数:242)

代码截图：

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

: example.lua (, 下载次数:290)

代码截图：

按键精灵执行效果截图：

【紫猫学园】《按键手机插件开发教程》目录
01. Lua中变量与数据类型的介绍	02. 数值、字符串、布尔、表、函数各大类型
03. 按键插件调试与判断循环结构	04. function函数的定义与调用
05. Lua自带函数命令语法	06. 优化按键TracePrint实现打印输出任何数据
07. 遍历获取LuaAuxLib函数库命令	08. 数组排序函数例子
09. 随机整数函数例子	点我访问紫猫学院官网

紫猫最后编辑于 2023-02-21 15:39:50

本主题由超级版主瑞祥幽冥狼于 2023/10/14 9:56:02 执行审核帖子操作

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

教学涉及按键精灵电脑版、按键精灵手机版、易语言、Lua编程。

包含网页、端游、手游、办公、模拟器、插件等。

报名咨询QQ:345911220 或 97682686 或 97682687;

报名咨询微信:zimaoxy; 点我在线交谈

紫猫学园免费教程

加入交流QQ群: 7333555

回顶部

发送短消息 UID 3328028 帖子 1497 精华 0 鲜花 199 朵铜币 3957 个银币 204 个性别在线时间 26840 注册时间 2015-06-28 最后登录 2024-03-09 查看公共资料搜索主题搜索帖子 zjcyjj zjcyjj 组别大学三年级 UID3328028 帖子1497 精华0 鲜花199 朵铜币3957 个银币204 个在线时间26840 注册时间2015-06-28 小红帽对论坛提出良好建议（可向管理员申请）	2^# 字体大小: t T 发表于 2022-02-17 23:31 \| \|只看该用户


	回顶部

发送短消息 UID 840940 帖子 712 精华 0 鲜花 30 朵铜币 1525 个银币 112 个性别在线时间 7360 注册时间 2011-10-26 最后登录 2022-02-28 505644332 查看公共资料搜索主题搜索帖子斷橋斷橋组别按键盒子会员 UID840940 帖子712 精华0 鲜花30 朵铜币1525 个银币112 个在线时间7360 注册时间2011-10-26 按键精灵开发者4级可通过提升认证等级来升级勋章：rz.anjian.com 学有所成学有所成勋章，新手步入按键学堂的第一枚勋章潜水员按键潜水员勋章幸运草勋章商业小精灵限时活动勋章。创业榜样参加暑期创业征文活动，成为创业榜样！双蛋勋章双蛋活动勋章	3^# 字体大小: t T 发表于 2022-02-21 10:23 \| \|只看该用户膜拜大佬~
	紫猫学员236-斷橋

	回顶部

发送短消息 UID 6197514 帖子 20 精华 0 鲜花 15 朵铜币 30 个银币 20 个性别在线时间 0 注册时间 2019-03-01 最后登录 2024-05-22 查看公共资料搜索主题搜索帖子 619556790 组别小学一年级 UID6197514 帖子20 精华0 鲜花15 朵铜币30 个银币20 个在线时间0 注册时间2019-03-01	4^# 字体大小: t T 发表于 2023-02-25 09:33 \| \|只看该用户 qqq555555555


	回顶部

发送短消息 UID 3663163 帖子 446 精华 0 鲜花 -4 朵铜币 671 个银币 -3 个性别在线时间 6360 注册时间 2015-12-23 最后登录 2024-05-12 查看公共资料搜索主题搜索帖子 369888155 369888155 组别初中三年级 UID3663163 帖子446 精华0 鲜花-4 朵铜币671 个银币-3 个在线时间6360 注册时间2015-12-23	5^# 字体大小: t T 发表于 2023-02-27 03:12 \| \|只看该用户 qq555555qq555555


	回顶部

发送短消息 UID 8979124 帖子 10 精华 0 鲜花 10 朵铜币 11 个银币 11 个性别在线时间 0 注册时间 2023-02-27 最后登录 2023-03-19 查看公共资料搜索主题搜索帖子微笑百年组别小学一年级 UID8979124 帖子10 精华0 鲜花10 朵铜币11 个银币11 个在线时间0 注册时间2023-02-27	6^# 字体大小: t T 发表于 2023-03-02 16:03 \| \|只看该用户向大佬学习


	回顶部

发送短消息 UID 8484107 帖子 2 精华 0 鲜花 1 朵铜币 11 个银币 1 个性别在线时间 0 注册时间 2021-09-30 最后登录 2024-03-18 查看公共资料搜索主题搜索帖子 lige3625922 组别幼儿园 UID8484107 帖子2 精华0 鲜花1 朵铜币11 个银币1 个在线时间0 注册时间2021-09-30	7^# 字体大小: t T 发表于 2023-03-02 23:10 \| \|只看该用户求教


	回顶部

发送短消息 UID 370806 帖子 188 精华 0 鲜花 3 朵铜币 285 个银币 4 个性别在线时间 3140 注册时间 2010-03-13 最后登录 2023-04-14 313364534 查看公共资料搜索主题搜索帖子 weifulong weifulong 组别初中一年级 UID370806 帖子188 精华0 鲜花3 朵铜币285 个银币4 个在线时间3140 注册时间2010-03-13	8^# 字体大小: t T 发表于 2023-03-03 14:49 \| \|只看该用户来学习咯


	回顶部

发送短消息 UID 8528640 帖子 36 精华 0 鲜花 17 朵铜币 28 个银币 28 个性别在线时间 0 注册时间 2021-11-07 最后登录 2024-08-25 12345 查看公共资料搜索主题搜索帖子 clj0414 clj0414 组别小学二年级 UID8528640 帖子36 精华0 鲜花17 朵铜币28 个银币28 个在线时间0 注册时间2021-11-07	9^# 字体大小: t T 发表于 2023-03-05 23:02 \| \|只看该用户水电费个地方个


	回顶部

发送短消息 UID 4463716 帖子 32 精华 0 鲜花 9 朵铜币 82 个银币 13 个性别在线时间 1220 注册时间 2017-05-13 最后登录 2023-04-08 539077070 查看公共资料搜索主题搜索帖子 539077070 539077070 组别小学二年级 UID4463716 帖子32 精华0 鲜花9 朵铜币82 个银币13 个在线时间1220 注册时间2017-05-13	10^# 字体大小: t T 发表于 2023-03-09 12:37 \| \|只看该用户 66666666666666666 66666666666666666


	回顶部

发送短消息 UID 1328747 帖子 136 精华 0 鲜花 8 朵铜币 258 个银币 24 个性别在线时间 5340 注册时间 2012-09-20 最后登录 2024-06-12 521175029 查看公共资料搜索主题搜索帖子 521175029 521175029 组别小学六年级 UID1328747 帖子136 精华0 鲜花8 朵铜币258 个银币24 个在线时间5340 注册时间2012-09-20	11^# 字体大小: t T 发表于 2023-03-11 10:07 \| \|只看该用户我来学习的


	回顶部

发送短消息 UID 5229186 帖子 41 精华 0 鲜花 18 朵铜币 131 个银币 24 个性别在线时间 1660 注册时间 2018-05-07 最后登录 2024-12-01 418577377 查看公共资料搜索主题搜索帖子 chenxiaobozhang chenxiaobozhang 组别小学二年级 UID5229186 帖子41 精华0 鲜花18 朵铜币131 个银币24 个在线时间1660 注册时间2018-05-07	12^# 字体大小: t T 发表于 2023-03-14 07:57 \| \|只看该用户学习学习


	回顶部

发送短消息 UID 4597425 帖子 10 精华 0 鲜花 5 朵铜币 20 个银币 10 个性别在线时间 20 注册时间 2017-08-21 最后登录 2023-04-17 147297081 查看公共资料搜索主题搜索帖子 wangli0078 wangli0078 组别小学一年级 UID4597425 帖子10 精华0 鲜花5 朵铜币20 个银币10 个在线时间20 注册时间2017-08-21	13^# 字体大小: t T 发表于 2023-03-15 09:21 \| \|只看该用户


	回顶部

发送短消息 UID 8766405 帖子 102 精华 0 鲜花 56 朵铜币 63 个银币 58 个性别在线时间 0 注册时间 2022-06-10 最后登录 2024-10-20 查看公共资料搜索主题搜索帖子 kel2022 组别小学五年级 UID8766405 帖子102 精华0 鲜花56 朵铜币63 个银币58 个在线时间0 注册时间2022-06-10	14^# 字体大小: t T 发表于 2023-03-15 22:20 \| \|只看该用户 34534t


	回顶部

发送短消息 UID 3126719 帖子 88 精华 0 鲜花 24 朵铜币 241 个银币 50 个性别在线时间 1560 注册时间 2015-03-14 最后登录 2024-11-05 查看公共资料搜索主题搜索帖子 756988630 756988630 组别小学四年级 UID3126719 帖子88 精华0 鲜花24 朵铜币241 个银币50 个在线时间1560 注册时间2015-03-14 按键精灵开发者1级可通过提升认证等级来升级勋章：rz.anjian.com	15^# 字体大小: t T 发表于 2023-03-17 13:09 \| \|只看该用户 11111111111111


	回顶部

发送短消息 UID 4125915 帖子 32 精华 0 鲜花 20 朵铜币 109 个银币 24 个性别在线时间 1240 注册时间 2016-09-19 最后登录 2024-06-10 查看公共资料搜索主题搜索帖子 lwj5168 组别小学二年级 UID4125915 帖子32 精华0 鲜花20 朵铜币109 个银币24 个在线时间1240 注册时间2016-09-19	16^# 字体大小: t T 发表于 2023-03-17 13:33 \| \|只看该用户 ua编程教学，不适合对Lua编程语言完全不懂的人阅读。如果你想要学习Lua编程，可以报名我们Lua课程学习，也可以查阅各种Lua文档资料学习。本帖子主要以插件开发标准规范为主，适合已经会写一些Lua代码实现插件制作的人阅读。如无特殊说明，本帖子中的代码均为Lua代码。


	回顶部

发送短消息 UID 3001417 帖子 9 精华 0 鲜花 26 朵铜币 18 个银币 13 个性别在线时间 0 注册时间 2015-01-11 最后登录 2023-03-27 查看公共资料搜索主题搜索帖子 feng1781 feng1781 组别小学一年级 UID3001417 帖子9 精华0 鲜花26 朵铜币18 个银币13 个在线时间0 注册时间2015-01-11	17^# 字体大小: t T 发表于 2023-03-18 22:30 \| \|只看该用户 66666666666666666666666666666666666666666


	回顶部

发送短消息 UID 8817755 帖子 8 精华 0 鲜花 6 朵铜币 9 个银币 9 个性别在线时间 0 注册时间 2022-08-08 最后登录 2023-06-01 2811638027 查看公共资料搜索主题搜索帖子 qiumoqi qiumoqi 组别小学一年级 UID8817755 帖子8 精华0 鲜花6 朵铜币9 个银币9 个在线时间0 注册时间2022-08-08	18^# 字体大小: t T 发表于 2023-03-19 16:01 \| \|只看该用户学习学习


	回顶部

发送短消息 UID 8638288 帖子 162 精华 0 鲜花 120 朵铜币 158 个银币 158 个性别在线时间 0 注册时间 2022-02-23 最后登录 2024-05-20 查看公共资料搜索主题搜索帖子海中岛组别初中一年级 UID8638288 帖子162 精华0 鲜花120 朵铜币158 个银币158 个在线时间0 注册时间2022-02-23	19^# 字体大小: t T 发表于 2023-03-20 16:28 \| \|只看该用户嘻嘻嘻


	回顶部

发送短消息 UID 6396700 帖子 7 精华 0 鲜花 5 朵铜币 17 个银币 7 个性别在线时间 0 注册时间 2019-04-19 最后登录 2023-04-11 253215621 查看公共资料搜索主题搜索帖子 17392763244 17392763244 组别小学一年级 UID6396700 帖子7 精华0 鲜花5 朵铜币17 个银币7 个在线时间0 注册时间2019-04-19	20^# 字体大小: t T 发表于 2023-03-23 00:43 \| \|只看该用户 666666666666


	回顶部

上一主题| 下一主题

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

66666666666666666