插件开发基础
本指南涵盖 RabbitMQ 插件开发的基础知识。阅读本指南前，读者应基本了解 RabbitMQ 插件机制。
Learn You Some Erlang 是开始学习 Erlang 和 OTP 的绝佳途径。
为什么要开发插件？
编写 RabbitMQ 插件提供了许多有吸引力的可能性
- 使您的应用程序能够访问未通过受支持协议之一公开的 RabbitMQ 内部功能。
- 与 Broker 在同一个 Erlang VM 中运行可能会提高某些工作负载的性能。
- 插件可以实现原本必须由系统中每个应用程序（服务）实现的功能，从而减少重复并降低维护负担
为什么不开发插件
与任何插件机制一样，在开发功能时应考虑是否将其作为插件嵌入是最合适的途径。您可能不想将功能开发为插件的一些原因如下
- 依赖 RabbitMQ 内部 API 可能会导致您的应用程序在新的 RabbitMQ 版本发布时需要更改，包括补丁版本。如果可以在不使用 RabbitMQ 内部组件的情况下完成所需操作，则您的应用程序将具有更高的向前兼容性
- 编写不佳的插件可能导致整个节点变得不可用或行为异常
入门
要开发 RabbitMQ 插件，首先请确保满足以下要求
Erlang.mk 用于构建 RabbitMQ 及其插件。开始开发新插件的最简单方法可能是复制现有插件，例如rabbitmq-metronome，如下例所示。
在开发期间激活插件
要在开发期间测试插件，请使用以下 make 目标启动 RabbitMQ 节点，其中本地插件是从源代码构建并启用的
make run-broker
插件质量提示
编写不当的插件可能会对 Broker 的稳定性构成风险。为了确保您的插件能够安全运行而不会影响 RabbitMQ 核心，强烈建议采用以下几项安全最佳实践。
- 始终为您的应用程序使用顶级 Supervisor。
- 永远不要直接启动插件应用程序，而是选择创建一个（可能非常简单的）Supervisor，以防止 Erlang VM 因顶层应用程序崩溃而关闭。
Broker 和依赖项版本约束
可以使用插件应用程序环境中的 broker_version_requirements 键为插件指定 Broker 和依赖项版本要求。要求指定为每个发布系列中的最低版本列表。考虑以下示例
{application, my_plugin,[
%% ...
{broker_version_requirements, ["3.11.15", "3.10.22"]}
]}
以上要求 RabbitMQ 3.10.x 从 3.10.22 开始，以及 3.11.x 从 3.11.15 开始。请注意，当新的主要和次要（功能）RabbitMQ 版本发布时，插件维护者必须更新列表。
插件可以具有依赖项。也可以为依赖项指定受支持的版本系列。这与上述非常相似，但使用类似字典的数据结构（proplist）。
例如
{application, my_plugin, [
%% ...
{dependency_version_requirements, [{rabbitmq_management, ["3.11.0", "3.10.22"]}]}
]}
表示插件依赖于 rabbitmq_management 3.10.x 从 3.10.22 开始以及 3.11.x 系列中的所有版本。
插件示例：节拍器
鉴于没有 Hello World 示例的开发指南是不完整的，以下内容尝试提供构建您自己的 RabbitMQ 插件的基础知识。
以下示例详细说明了如何构建一个像节拍器一样的简单插件。
每秒，它都会向名为“metronome”的主题交换器发送一条消息，该消息的路由键格式为 yyyy.MM.dd.dow.hh.mm.ss（默认为此交换器）。应用程序可以将队列附加到此交换器，并使用各种路由键以便按规律的间隔调用。例如，要每秒接收一条消息，可以应用“......*”的绑定。要每分钟接收一条消息，可以改为应用“......00”的绑定。
GitHub 上的 rabbitmq-metronome 存储库包含此插件的代码副本。
下表应解释存储库中各种文件的用途。
| 文件名 | 用途 |
|---|---|
Makefile | 此顶级 Makefile 定义插件的名称及其依赖项。名称必须与 Erlang 应用程序名称匹配。依赖项使用 erlang.mk 的变量声明。紧随其后，Makefile 包括rabbitmq-components.mk和erlang.mk以及rabbitmq-plugins.mk使用 erlang.mk 插件工具。请参阅下文了解这些文件的描述。 |
erlang.mk | 本地副本erlang.mk。这不是香草副本，因为 RabbitMQ 依赖于一些修改，这些修改在撰写本文时尚未合并到上游。这就是为什么ERLANG_MK_REPO和ERLANG_MK_COMMIT目前被覆盖。 |
rabbitmq-components.mk | 本地副本rabbitmq-components.mk。原始文件位于rabbitmq-common您的插件将自动依赖于该文件。它包含其他 erlang.mk 扩展和帮助程序，必须在erlang.mk包含之前定义。此文件必须与rabbitmq-common保持同步：当它过时时，您将收到以下错误 在这种情况下，只需运行以下命令来更新您的副本 |
rabbitmq_metronome.schema | Cuttlefish 配置架构。用于将 配置文件 转换为 RabbitMQ 及其运行时使用的内部格式。 节拍器架构包含 启用插件后，将重新生成配置。如果插件尚未启用，则配置中的插件特定值将导致错误。 有关编写架构文件的更多信息，请参见 Cuttlefish 文档。 |
src/rabbit_metronome.erl | Erlang“应用程序”行为的实现。为 Erlang VM 提供启动和停止插件的方法。 |
src/rabbit_metronome_sup.erl | Erlang“Supervisor”行为的实现。监视工作进程并在其崩溃时重新启动它。 |
src/rabbit_metronome_worker.erl | 插件的核心。Worker 将在内部连接到 Broker，然后创建一个每秒触发一次的任务。 |
test/metronome_SUITE.erl | 插件的自动化测试。 |
开发过程
运行 make 构建插件
make
要启动一个节点，其中插件已构建并在以下位置启用
make run-broker
要确保新插件已启动并正在运行，请运行以下命令
rabbitmq-diagnostics status
如果您的插件已成功加载，您应该在已启用插件列表中看到它
# => Plugins
# =>
# => Enabled plugin file: /var/folders/gp/53t98z011678vk9rkcb_s6ph0000gn/T/rabbitmq-test-instances/rabbit@warp10/enabled_plugins
# => Enabled plugins:
# =>
# => * rabbitmq_metronome
# => * amqp_client
要运行 Common Test 测试套件，请使用
make tests
最后，您可以生成一个 .ez 文件，适合分发
DIST_AS_EZS=yes make dist
该文件出现在plugins存储库根目录下的目录中。