AutoJs6 文档 - 6.6.4

插件 (Plugins)#

在 AutoJs6 中, 插件分为 [ 应用插件 / 项目插件 / 内置扩展插件 ].

plugins 模块主要用于插件及扩展模块的加载并使其功能生效.

应用插件#

应用插件通常是一个由开发者编写的可安装的 APK 文件, 安装插件后可由 AutoJs6 通过 plugins.load 方法加载并使用插件.

应用插件的使用步骤:

  • 按需寻找或自行开发插件 (APK 格式)
  • 安装到指定设备
  • 脚本中将插件包名以字符串形式传入 plugins.load 方法并赋值给一个变量
  • 这个变量即指向插件的导出对象 (module.exports)

加载及使用方式:

let { exp } = plugins.load('org.autojs.autojs.plugin.demo');
exp.test('hello');

项目插件#

项目插件是依附于项目的一组 JavaScript 模块, 它们位于项目根目录的 plugins 文件夹中, 由 AutoJs6 通过 plugins.load 方法加载并使用.

例如项目结构 (部分) 如下:

┌ modules ┬ moduleA.js
│         └ moduleB.js
│         ┌ pluginA.js
├ plugins ┼ pluginB.js
│         └ pluginC.js
└ main.js

对于此项目, pluginA.js, pluginB.js 及 pluginC.js 均称为项目插件, 加载方式如下:

plugins.load('pluginA');
plugins.load('pluginA.js'); /* 同上. */

内置扩展插件#

内置扩展插件相当于内置的项目插件, 它们是内置于 AutoJs6 软件中的, 可通过调用 plugins.extend 等方法选择性地启用部分或全部内置扩展插件, 也称作内置扩展模块.

加载方式:

/* 启用 Array 内置扩展插件. */
plugins.extend('Arrayx');

/* 启用全部内置扩展插件. */
plugins.extendAll();

截至 2023 年 2 月, AutoJs6 内置了以下扩展插件:

plugins

[m] load#

load(appPluginPackageName)#

[6.2.0] Overload 1/2

  • packageName { string } - 应用插件的包名
  • returns { any }

加载 应用插件.

/* 一个可能的样例. */
plugins.load('org.autojs.autojs.plugin.demo');

load(projectPluginName)#

6.2.0 Overload 2/2

  • packageName { string } - 项目插件名称
  • returns { any }

加载 项目插件.

[m] extend#

extend(...moduleNames)#

6.2.0

加载指定的 内置扩展插件.

/* 启用 Array 内置扩展插件. */
plugins.extend('Arrayx');

/* 启用 Array 和 Number 内置扩展插件. */
plugins.extend('Arrayx', 'Numberx');

[m] extendAll#

extendAll()#

6.2.0

加载所有的 内置扩展插件.

plugins.extendAll();

如需在所有脚本均自动加载所有内置扩展插件, 而无需每次使用 plugins.extendAll(), 可对 AutoJs6 进行如下设置:

AutoJs6 应用设置 - 扩展性 - JavaScript 内置对象扩展 - [ 启用 ]

[m] extendAllBut#

extendAllBut(...moduleNames)#

6.2.0

加载所有的 内置扩展插件, 但排除指定的插件.

plugins.extendAllBut('Mathx'); /* 加载除 Math 外的全部内置扩展插件. */