tmp connect

2026-07-20 23:25:35 +08:00 · 2021-03-22 07:44:11 +08:00
parent b6d1f724e9
commit 0ff4e52ed3
26 changed files with 812 additions and 212 deletions
--- a/docs/advanced/inside-class.md
+++ b/docs/advanced/inside-class.md
@@ -27,3 +27,44 @@
 TODO：先放一放。
 ```

+## ZM\Entity\MatchObject
+
+此类是调用方法 `MessageUtil::matchCommand()` 返回的对象体，含有匹配成功与否和匹配到的注解相关的信息。
+
+### 属性
+
+- `$match`：`bool` 类型，返回匹配是否成功
+- `$object`：`CQCommand` 注解类，如果匹配成功则返回对应的 `@CQCommand` 信息
+- `match`：`array` 类型，如果匹配成功则返回匹配到的参数
+
+```php
+// 假设我有一个注解事件 @CQCommand(match="你好")，绑定的函数是 \Module\Example\Hello 下的 hello123()
+
+$obj = MessageUtil::matchCommand("你好 我叫顺溜 我今年二十八", ctx()->getData());
+/* 以下是返回信息，仅供参考
+$obj->match ==> true
+$obj->object ==> \ZM\Annotation\CQ\CQCommand: (
+	match: "你好",
+    pattern: "",
+    regex: "",
+    start_with: "",
+    end_with: "",
+    keyword: "",
+    alias: [],
+    message_type: "",
+    user_id: 0,
+    group_id: 0,
+    discuss_id: 0,
+    level: 20,
+    method: "hello123",
+    class: \Module\Example\Hello::class
+)
+$obj->match ==> [
+	"我叫顺溜",
+	"我今年二十八"
+]
+*/
+```
+
+
+
--- a/docs/component/global-functions.md
+++ b/docs/component/global-functions.md
@@ -134,10 +134,6 @@ set_coroutine_params(["data" => [

 别名：`context()`，获取当前协程的上下文，见 [上下文](/component/context/)。

-## zm_debug()
-
-同 `Console::debug($msg)`。
-
 ## zm_sleep()

 协程版 `sleep()` 函数。
@@ -255,4 +251,58 @@ bot()->sendPrivateMsg(123456, "你好啊！！");

 定义：`getAllFdByConnectType(string $type = 'default'): array`

-当 `$type` 为 `qq` 时，则返回所有 OneBot 机器人接入的 WebSocket 连接号。
+当 `$type` 为 `qq` 时，则返回所有 OneBot 机器人接入的 WebSocket 连接号。
+
+## zm_dump()
+
+更漂亮地输出变量值，可替代 `var_dump()`。
+
+```php
+class Pass {
+    public $foo = 123;
+    public $bar = ["a", "b"];
+}
+$pass = new Pass();
+$pass->obj = true;
+zm_dump($pass);
+```
+
+<img src="../assets/img/image-20210321193956832.png" alt="image-20210321193956832" style="zoom:50%;" />
+
+## zm_config()
+
+同 `ZMConfig::get()`。
+
+定义：`zm_config($name, $key = null)`。
+
+有关 ZMConfig 模块的说明，见 [指南 - 基本配置](/guide/basic-config/)。
+
+```php
+zm_config("global"); //等同于 ZMConfig::get("global");
+zm_config("global", "swoole"); //等同于 ZMConfig::get("global", "swoole");
+```
+
+## zm_info()
+
+同 `Console::info($msg)`。
+
+## zm_debug()
+
+同 `Console::debug($msg)`。
+
+## zm_warning()
+
+同 `Console::warning($msg)`。
+
+## zm_success()
+
+同 `Console::success($msg)`。
+
+## zm_error()
+
+同 `Console::error($msg)`。
+
+## zm_verbose()
+
+同 `Console::verbose($msg)`。
+
--- a/docs/component/zmutil.md
+++ b/docs/component/zmutil.md
@@ -21,3 +21,47 @@ class ASD{
 ZMUtil::getModInstance(ASD::class)->test = 5;
 ```

+## ZMUtil::getReloadableFiles()
+
+返回可通过热重启（reload）来重新加载的 php 文件列表。
+
+以下是示例模块下的例子（直接拉取最新的框架源码并运行框架后获取的）。
+
+```php
+array:31 [
+  94 => "src/ZM/Context/Context.php"
+  95 => "src/ZM/Context/ContextInterface.php"
+  96 => "src/ZM/Annotation/AnnotationParser.php"
+  97 => "src/Custom/Annotation/Example.php"
+  98 => "src/ZM/Annotation/Interfaces/CustomAnnotation.php"
+  99 => "src/Module/Example/Hello.php"
+  100 => "src/ZM/Annotation/Swoole/OnStart.php"
+  101 => "src/ZM/Annotation/CQ/CQCommand.php"
+  102 => "src/ZM/Annotation/Interfaces/Level.php"
+  103 => "src/ZM/Annotation/Command/TerminalCommand.php"
+  104 => "src/ZM/Annotation/Http/RequestMapping.php"
+  105 => "src/ZM/Annotation/Http/RequestMethod.php"
+  106 => "src/ZM/Annotation/Http/Middleware.php"
+  107 => "src/ZM/Annotation/Interfaces/ErgodicAnnotation.php"
+  108 => "src/ZM/Annotation/Swoole/OnOpenEvent.php"
+  109 => "src/ZM/Annotation/Swoole/OnSwooleEventBase.php"
+  110 => "src/ZM/Annotation/Interfaces/Rule.php"
+  111 => "src/ZM/Annotation/Swoole/OnCloseEvent.php"
+  112 => "src/ZM/Annotation/Swoole/OnRequestEvent.php"
+  113 => "src/ZM/Http/RouteManager.php"
+  114 => "vendor/symfony/routing/RouteCollection.php"
+  115 => "vendor/symfony/routing/Route.php"
+  116 => "src/Module/Middleware/TimerMiddleware.php"
+  117 => "src/ZM/Http/MiddlewareInterface.php"
+  118 => "src/ZM/Annotation/Http/MiddlewareClass.php"
+  119 => "src/ZM/Annotation/Http/HandleBefore.php"
+  120 => "src/ZM/Annotation/Http/HandleAfter.php"
+  121 => "src/ZM/Annotation/Http/HandleException.php"
+  122 => "src/ZM/Event/EventManager.php"
+  123 => "src/ZM/Annotation/Swoole/OnSwooleEvent.php"
+  124 => "src/ZM/Event/EventDispatcher.php"
+]
+```
+
+> 为什么不能重载所有文件？因为框架是多进程模型，而重载相当于只重新启动了一次 Worker 进程，Manager 和 Master 进程未重启，所以被 Manager、Master 进程已经加载的 PHP 文件无法使用 reload 命令重新加载。详见 [进阶 - 进程间隔离](/advanced/multi-process/#_5)。
+
--- a/docs/event/framework-annotations.md
+++ b/docs/event/framework-annotations.md
@@ -262,6 +262,27 @@

 无。

+## TerminalCommand()
+
+添加一个远程终端的自定义命令。（2.4.0 版本起可用）
+
+### 属性
+
+| 类型       | 值                                      |
+| ---------- | --------------------------------------- |
+| 名称       | `@TerminalCommand`                      |
+| 触发前提   | 连接到远程终端可触发                    |
+| 命名空间   | `ZM\Annotation\Command\TerminalCommand` |
+| 适用位置   | 方法                                    |
+| 返回值处理 | 无                                      |
+
+### 注解参数
+
+| 参数名称    | 参数范围                       | 默认 |
+| ----------- | ------------------------------ | ---- |
+| command     | `string`，**必填**，命令字符串 |      |
+| description | `string`，要显示的帮助文本     | 空   |
+
 ## 示例1（机器人连接框架后输出信息）

 ```php
@@ -406,3 +427,6 @@ public function onCrawl() {
 }
 ```

+## 示例6（创建一个远程终端命令并调试框架）
+
+> 开个坑，以后填。（__填坑标记__）
--- a/docs/update/v2.md
+++ b/docs/update/v2.md
@@ -1,5 +1,19 @@
 # 更新日志（v2 版本）

+## v2.4.0（390）
+
+> 更新时间：2021.3.18
+
+- 新增：全局方法（`zm_dump()`，`zm_error()`，`zm_warning()`，`zm_info()`，`zm_success()`，`zm_verbose()`，`zm_debug()`，`zm_config()`）
+
+- 修复：部分内部存储存在的内存泄漏问题
+- 新增：remote_terminal（远程终端）内置模块，可以用 nc 直接远程连接框架（弥补原先删除掉的终端输入）
+- 新增：`DataProvider::getReloadableFiles()` 返回可通过热重启（reload）来重新加载的 php 文件列表（多用于调试）
+- 兼容性变更：**要求最低 Swoole 版本为 4.5.0**
+- 优化：reload 和 stop 重载和停止框架的逻辑，防止卡死
+- 新增：远程终端命令支持自定义添加（`@TerminalCommand` 注解）
+- 
+
 ## v2.3.2

 > 更新时间：2021.3.18