# 多语言 - 钩子扩展

多语言的 钩子扩展 由 emqx-exhook 插件进行支持。它允许用户使用其它编程（例如：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)     |        |          |
|                        |                 |        |          |
+========================+                 +========+==========+

1
2
3
4
5
6
7
8

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

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

chain_of_responsiblity

# 接口设计

作为事件的处理端，即 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) {};
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

其中 HookProvider 部分：

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

钩子事件部分：

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 插件/模块。

# 开发指南

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

其步骤如下：

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

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

然后修改 etc/plugins/emqx_exhook.conf 中的服务器配置，例如：

exhook.server.default.url = http://127.0.0.1:9000

启动 emqx_exhook 插件，观察输出。

其中各个语言的 gRPC 框架可参考：grpc-ecosystem/awesome-grpc (opens new window)

我们也提供了一些常见编程语言的示例程序：emqx-extension-examples (opens new window)

← 简介协议接入 →