多语言 - 钩子扩展

多语言的 钩子扩展emqx-exhook 插件进行支持。它允许用户使用其它编程(例如:Python、Java 等)直接向 EMQX 挂载钩子,以接收并处理 EMQX 系统的事件,达到扩展和定制 EMQX 的目的。例如,用户可以使用其他编程语言来实现:

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

设计

emqx-exhook 使用 gRPC多语言 - 钩子扩展 - 图1 (opens new window) 作为 RPC 的通信框架。

架构如下图:

exhook_workflow

它表明:EMQX 作为一个 gRPC 客户端,将系统中的钩子事件发送到用户的 gRPC 服务端。

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

回调链(Callback Functions Chain)

接口设计

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

  1. syntax = "proto3";
  2. package emqx.exhook.v2;
  3. service HookProvider {
  4. rpc OnProviderLoaded(ProviderLoadedRequest) returns (LoadedResponse) {};
  5. rpc OnProviderUnloaded(ProviderUnloadedRequest) returns (EmptySuccess) {};
  6. rpc OnClientConnect(ClientConnectRequest) returns (EmptySuccess) {};
  7. rpc OnClientConnack(ClientConnackRequest) returns (EmptySuccess) {};
  8. rpc OnClientConnected(ClientConnectedRequest) returns (EmptySuccess) {};
  9. rpc OnClientDisconnected(ClientDisconnectedRequest) returns (EmptySuccess) {};
  10. rpc OnClientAuthenticate(ClientAuthenticateRequest) returns (ValuedResponse) {};
  11. rpc OnClientAuthorize(ClientAuthorizeRequest) returns (ValuedResponse) {};
  12. rpc OnClientSubscribe(ClientSubscribeRequest) returns (EmptySuccess) {};
  13. rpc OnClientUnsubscribe(ClientUnsubscribeRequest) returns (EmptySuccess) {};
  14. rpc OnSessionCreated(SessionCreatedRequest) returns (EmptySuccess) {};
  15. rpc OnSessionSubscribed(SessionSubscribedRequest) returns (EmptySuccess) {};
  16. rpc OnSessionUnsubscribed(SessionUnsubscribedRequest) returns (EmptySuccess) {};
  17. rpc OnSessionResumed(SessionResumedRequest) returns (EmptySuccess) {};
  18. rpc OnSessionDiscarded(SessionDiscardedRequest) returns (EmptySuccess) {};
  19. rpc OnSessionTakenover(SessionTakenoverRequest) returns (EmptySuccess) {};
  20. rpc OnSessionTerminated(SessionTerminatedRequest) returns (EmptySuccess) {};
  21. rpc OnMessagePublish(MessagePublishRequest) returns (ValuedResponse) {};
  22. rpc OnMessageDelivered(MessageDeliveredRequest) returns (EmptySuccess) {};
  23. rpc OnMessageDropped(MessageDroppedRequest) returns (EmptySuccess) {};
  24. rpc OnMessageAcked(MessageAckedRequest) returns (EmptySuccess) {};
  25. }

其中 HookProvider 部分:

  • OnProviderLoaded:定义 HookProvider 如何被加载,返回需要挂载的钩子列表。仅在该列表中的钩子会被回调到 HookProivder 服务。
  • OnProviderUnloaded:通知用户该 HookProvier 已经从 emqx 中卸载。

钩子事件部分:

  • OnClient*OnSession*OnMessage* 为前缀的方法与 钩子 的当中的方法一一对应。它们有着相同的调用时机和相似的参数列表。
  • OnClientAuthenticateOnClientCheckAclOnMessagePublish 允许携带返回值到 EMQX 系统,其它回调则不支持。

其中接口和参数数据结构的详情参考:exhook.proto多语言 - 钩子扩展 - 图3 (opens new window)

开发指南

用户在使用多语言扩展钩子的功能时,需要实现 HookProvider 的 gRPC 服务来接收 EMQX 的回调事件。

其步骤如下:

  1. 拷贝 lib/emqx_exhook-<x.y.z>/priv/protos/exhook.proto 文件到你的项目中。
  2. 使用对应编程语言的 gRPC 框架,生成 exhook.proto 的 gRPC 服务端的代码。
  3. 按需实现 exhook.proto 中定义的接口。

开发完成后,需将该服务部署到与 EMQX 能够通信的服务器上,并保证端口的开放。

你可以使用 EMQX Dashboard多语言 - 钩子扩展 - 图4 (opens new window) 来对 ExHook 服务进行管理和监控

其中各个语言的 gRPC 框架可参考:grpc-ecosystem/awesome-grpc多语言 - 钩子扩展 - 图5 (opens new window)

我们也提供了一些常见编程语言的示例程序:emqx-extension-examples多语言 - 钩子扩展 - 图6 (opens new window)