多语言扩展 - 钩子

多语言扩展 - 钩子

在 EMQX e4.2.0 中，我们提供了多语言扩展的支持。其中 多语言扩展钩子 模块允许使用其他编程语言（例如：Python，Java 等）直接向 EMQX 系统挂载钩子，以接收并处理 EMQX 系统的钩子事件，达到扩展和定制 EMQX 的目的。例如，用户可以使用其他编程语言来自定义：

客户端接入的认证授权
发布/订阅的 ACL 鉴权
消息的持久化，桥接
发布/订阅，或者客户端上下线事件的通知处理

设计

多语言扩展钩子 功能由 emqx-exhook 插件提供。它使用 gRPC (opens new window) 作为 RPC 的通信框架。

架构如下图：

  EMQX
+========================+                 +========+==========+
|    ExHook              |                 |        |          |
|   +----------------+   |      gRPC       | gRPC   |  User's  |
|   |   gRPC Client  | ------------------> | Server |  Codes   |
|   +----------------+   |    (HTTP/2)     |        |          |
|                        |                 |        |          |
+========================+                 +========+==========+

它表明：EMQX 中的 ExHook 模块作为一个 gRPC 客户端，将系统中所有的钩子事件发送到用户的 gRPC 服务端。

和 EMQX 原生的钩子一致，它也支持链式的方式计算和返回：

接口设计

作为事件的处理端，即 gRPC 的服务端。它需要用户自定义实现需要挂载的钩子列表，和每个钩子事件到达后如何去处理的回调函数。这些接口在 多语言扩展钩子 中被定义为一个名为 HookProvider的 gRPC 服务，其需要实现的接口的列表包含：

syntax = "proto3";
package emqx.exhook.v1;
service HookProvider {
  rpc OnProviderLoaded(ProviderLoadedRequest) returns (LoadedResponse) {};
  rpc OnProviderUnloaded(ProviderUnloadedRequest) returns (EmptySuccess) {};
  rpc OnClientConnect(ClientConnectRequest) returns (EmptySuccess) {};
  rpc OnClientConnack(ClientConnackRequest) returns (EmptySuccess) {};
  rpc OnClientConnected(ClientConnectedRequest) returns (EmptySuccess) {};
  rpc OnClientDisconnected(ClientDisconnectedRequest) returns (EmptySuccess) {};
  rpc OnClientAuthenticate(ClientAuthenticateRequest) returns (ValuedResponse) {};
  rpc OnClientCheckAcl(ClientCheckAclRequest) returns (ValuedResponse) {};
  rpc OnClientSubscribe(ClientSubscribeRequest) returns (EmptySuccess) {};
  rpc OnClientUnsubscribe(ClientUnsubscribeRequest) returns (EmptySuccess) {};
  rpc OnSessionCreated(SessionCreatedRequest) returns (EmptySuccess) {};
  rpc OnSessionSubscribed(SessionSubscribedRequest) returns (EmptySuccess) {};
  rpc OnSessionUnsubscribed(SessionUnsubscribedRequest) returns (EmptySuccess) {};
  rpc OnSessionResumed(SessionResumedRequest) returns (EmptySuccess) {};
  rpc OnSessionDiscarded(SessionDiscardedRequest) returns (EmptySuccess) {};
  rpc OnSessionTakeovered(SessionTakeoveredRequest) returns (EmptySuccess) {};
  rpc OnSessionTerminated(SessionTerminatedRequest) returns (EmptySuccess) {};
  rpc OnMessagePublish(MessagePublishRequest) returns (ValuedResponse) {};
  rpc OnMessageDelivered(MessageDeliveredRequest) returns (EmptySuccess) {};
  rpc OnMessageDropped(MessageDroppedRequest) returns (EmptySuccess) {};
  rpc OnMessageAcked(MessageAckedRequest) returns (EmptySuccess) {};
}

其中 HookProvider 部分：

OnProviderLoaded：定义 HookProvider 如何被加载，返回需要挂载的钩子列表。仅在该列表中的钩子会被回调到 HookProivder 服务。
OnProviderUnloaded：定义 HookProvider 如何被卸载，仅用作通知。

钩子事件部分：

OnClient*，OnSession*，OnMessage* 为前缀的方法与钩子的当中的方法一一对应。它们有着相同的调用时机和相似的参数列表。
仅 OnClientAuthenticate，OnClientCheckAcl，OnMessagePublish 允许携带返回值到 EMQX 系统，其它回调则不支持。
特定的，对于 message 类型的钩子：message.publish, message.delivered, message.acked, message.dropped，可以在返回钩子列表时，为这些钩子携带主题过滤器列表。那么在触发消息事件时，仅有主题能够匹配主题过滤器列表中任意过滤器的消息，会被发送到用户的 gRPC 服务端。
通过这样的方式，gRPC 服务端可以仅处理自己关心的主题下的消息，以避免多余的 gRPC 请求消耗。

其中接口和参数数据结构的详情参考：exhook.proto (opens new window)

提示

需要注意的是，EMQX 仅在 HookProvider 被加载时确认一次需要加载的钩子以及 message 钩子所配置的主题过滤器列表，之后的 gRPC 请求都以将以加载时的为准。
如果需要挂载的钩子列表有变更，或 message 类型钩子所关心的主题过滤器列表有变更，都需要重新加载。即需要在 EMQX 中重启 ExHook 插件/模块。