DataAnalyze-Plugins（HaEAnalyze-Engine Part）

Security Classification: 【C-1】 | Publish Time:2024-12-06 | Category:DataAnalyze | Edit
Old Version | Diff |
Expiry Notice: The article was published three months ago. Please independently assess the validity of the technical methods and code mentioned within. :)

AI Summary: 该仓库为DataAnalyze框架的分析引擎插件官方代码库，提供插件源码以供编译和引入。包含编写规则、函数说明、编译方法及插件提交流程，要求插件以数字前缀命名并放入Plugins目录以便自动加载。 --- (From Model:gpt-4o-mini-2024-07-18)

## 仓库地址

https://github.com/x0-Project/DataAnalyze-Plugins

## 介绍

仓库为DataAnalyze框架中的核心组件（HaEAnalyze-Engine - 分析引擎）的插件代码官方仓库。将提供开源的插件源码供用户编译引入插件。

## 编写规则

### 主程序代码克隆引入依赖

克隆主程序代码 https://git.rce.ink/depy/HaE-AnalyzeEngine

执行 go mod tidy ,引入缺少的依赖（必要时请科学上网）

### Demo代码编写

进入Tests目录，编写MyPlugin.go文件即可 以下为各函数名解释

| 函数  |  执行时间 |  可用参数释义 |
| ------------ | ------------ | ------------ |
|  Init |  插件引入时，用于打印插件信息、资源初始化、实例初始化等 | 无参调用  |
| ProcessBegin  | 获取最原始数据时,此时仅对数据进行反序列化与解压缩  |  参数1为消费的数据指针，存在属性如下图。参数2为map类型的断言数组，请通过主程序查看数组中所含参数，或自行添加数据传递 |
|  ProcessEnd |  数据经所有插件的ProcessBegin方法处理结束时（例如进行解密等操作），并进行了正则匹配拿到了匹配结果 |  参数1为消费的数据指针，存在属性如下图。参数2为map类型的断言数组，请通过主程序查看数组中所含参数，或自行添加数据传递 |
|Name   |  /  | /  |
|Version   | /  | /  |
|Author   |  / |  / |

依次分别为: 流量包原始数据、所属消息队列topic、traceid、请求方式、请求包方式、是否分块、服务host、服务端口、分块编号

![](https://img.meituan.net/imgupload/53940763761b6dd24166bc7da7d8299935376.png)

## 编译与最佳开发实践

### 一行代码进行编译

```
go build -buildmode=plugin -o 01xxx.so Tests/xxx.go
```

### 使用GoLand File Watcher

![](https://ipfs.rce.ink/bafkreicrxz7fn6wklgco3xwv2hiw5vqohkeymsj4cmyopg36ee36v3tbsq)

### 命名与载入规则

请注意，编译后的产物需要以两位数字作为前缀（01editor.so）。这决定了插件的加载顺序。

然后，请将其放置在与HaEAnalyze-Engine可执行文件同级的`Plugins`目录中。重新启动主程序将根据命名插件的前缀排序，自动加载插件。

## 插件提交

克隆官方插件地址后进行PR即可，我会review代码进行merge。

Comment List

Comment

© Copyright: This article is an original work and the copyright belongs to the X0 unless marked as Reproduced

Please contact the blogger for authorization to reprint

DataAnalyze-Plugins（HaEAnalyze-Engine Part）

© Copyright: This article is an original work and the copyright belongs to the X0 unless marked as ReproducedPlease contact the blogger for authorization to reprint

© Copyright: This article is an original work and the copyright belongs to the X0 unless marked as Reproduced

Please contact the blogger for authorization to reprint