第42章 Quickstart 插件
Quickstart 插件 Quickstart 插件是由 NodeBB 团队开发的一个插件骨架,旨在为创建自定义插件提供一个功能完备的基础。 它包含最少的功能集,以及让 NodeBB 识别其为插件所需的所有样板代码。 结构分解 克隆仓库并检查文件本身可能会让人不知所措,因此本指南旨在引导你了解该插件的各个方面。 plugin.json → 在 GitHub 上查看此文件 第一站是 plugin.json 文件,这是该插件的主要配置区域。NodeBB 会检查此文件以确定插件名称、钩子监听器以及相关文件。 点击此处以了解文件格式和选项的详细信息 plugin.json 中有一个名为 library 的选项,定义为 library.js,让我们接下来看看它。 library.js → 在 GitHub 上查看此文件 代码的主体部分包含在此文件中,尽管额外逻辑被分离到 lib/ 目录下的其他文件中(例如 lib/controllers.js)。 plugin.json 中定义的每个钩子都映射到此文件中的导出方法。 例如,plugin.json 中定义的 static:app.load 钩子指向 init 方法。每当 NodeBB 启动时,该钩子会被调用,进而调用此监听器。 在这个特定的钩子中,我们设置了一些路由并将它们挂载到 express 路由器上。 你可以通过检查 NodeBB 数据库或查看不断更新的钩子列表来发现更多钩子。 有关插件钩子的更多信息,请点击此处。 客户端逻辑 上一节详细说明了如何创建新路由并将其挂载到 express 路由器,但如何定义自定义客户端逻辑呢? NodeBB 使用 require.js 按页面动态加载模块。 quickstart 插件为管理设置页面挂载了一个路由,位于 /admin/plugins/quickstart。检查控制器(位于 lib/controllers.js)可知,它试图加载模板 "admin/plugins/quickstart"。这一指定非常重要,因为它告诉我们要如何查找相关的客户端模块。 无论挂载点在哪里,NodeBB 都会尝试根据模板名称加载客户端库。在这种情况下,访问管理设置页面会导致 NodeBB 调用 require('admin/plugins/quickstart') 并执行 .init() 方法(如果该方法可用)。否则,它什么也不做。 注意 不在 admin 命名空间内的挂载页面会带有 forum/ 前缀。例如,如果你有一个挂载页面 /foobar 并加载模板 views/foobar,NodeBB 将尝试调用 require('forum/views/foobar')。 我们可以向 NodeBB 定义一个 require.js 模块并指定其名称,以便在直接调用时加载它。 → 在 GitHub 上查看此文件 (static/lib/admin.js) 此文件以 define 调用开始,模块名称(如上所述)作为第一个参数传入。 NodeBB 寻找导出的 .init() 方法,如果找到则执行它。 将此文件暴露给 NodeBB 有两种方式: 将其添加到 plugin.json 中的 scripts 或 acpScripts 数组中,或者 将其定义为 plugin.json 中 modules 部分下的自定义模块 样式 样式定义为一组通过 plugin.json 中的 scss 数组属性暴露给 NodeBB 的 SASS 文件。你可以随心所欲地定义和组织你的 SASS 文件。