update docs

安装命令、操作命令强化

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.entry.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-if [ ! -d "/app/zhamao-framework/bin" ]; then
-	cp -r /app/zhamao-framework-bak/* /app/zhamao-framework/
-fi
-php /app/zhamao-framework/bin/start framework --disable-console-input

.github/ISSUE_TEMPLATE/1_Bug_report.yaml

@@ -0,0 +1,38 @@
+name: 🐛 漏洞（BUG）报告
+description: ⚠️ 请不要直接在此提交安全漏洞
+labels: bug
+
+body:
+  - type: input
+    id: affected-versions
+    attributes:
+      label: 受影响版本
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 描述
+      description: 请详细地描述您的问题
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce-steps
+    attributes:
+      label: 复现步骤
+      description: |
+        请尽可能地提供可以复现此步骤的漏洞。
+        如果步骤过长或难以描述，您可以自行建立一个用于复现漏洞的仓库。
+    validations:
+      required: true
+  - type: textarea
+    id: possible-solution
+    attributes:
+      label: 解决方案
+      description: 如果您对这个漏洞的成因或修复有任何意见的话，请在此提出
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: 附加信息
+      description: 其他可能有帮助的信息，如日志、截图等

.github/ISSUE_TEMPLATE/2_Feature_request.yaml

@@ -0,0 +1,19 @@
+name: 🚀 功能建议
+description: 新功能、改进的意见、草案
+labels: enhancement
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 描述
+      description: 请提供简洁清楚的描述
+    validations:
+      required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: 例子
+      description: |
+        一个简单的例子，展示该功能将如何被使用（包括代码、配置文件等）
+        如果这是针对已有功能的改进，请展示改进前后使用方式（或效能）的对比

.github/workflows/increment-build-number.yml

@@ -0,0 +1,69 @@
+name: Increment Build Number
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - closed
+    paths:
+      - 'src/**.php'
+
+jobs:
+  incremental-build-number:
+    if: github.event.pull_request.merged == true
+    name: Incremental Build Number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: '8.1'
+          extensions: swoole, posix, json
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer Dependencies
+        run: "composer install --prefer-dist --no-progress --optimize-autoloader"
+
+      - name: Generate API Docs
+        id: generate-api-docs
+        continue-on-error: true
+        run: bin/gendoc
+
+      - name: Commit api docs
+        if: steps.generate-api-docs.outcome == 'success'
+        continue-on-error: true
+        run: |
+          git config --global user.name 'Github Build Bot'
+          git config --global user.email 'noreply@github.com'
+          git add docs
+          git commit -m "update api docs"
+          git push
+
+      - name: Increment build number
+        run: sed -i -r 's/(.*)(\VERSION_ID\s=\s)([0-9]+)(.*)/echo "\1\2$((\3+1))\4"/ge' src/ZM/ConsoleApplication.php
+
+      - name: Commit build number
+        run: |
+          BUILD_ID=$(cat src/ZM/ConsoleApplication.php | grep "VERSION_ID = " | sed 's/[^0-9]//g')
+          git config --global user.name 'Github Build Bot'
+          git config --global user.email 'noreply@github.com'
+          git add src/ZM/ConsoleApplication.php
+          git commit -m "increment build number (build $BUILD_ID)"
+          git push

.github/workflows/integration-test.yml

@@ -0,0 +1,101 @@
+name: Integration and Style Test
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '**/**.php'
+  pull_request:
+    branches:
+      - master
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - review_requested
+    paths:
+      - '**/**.php'
+
+jobs:
+  integration:
+    name: Integration Test (PHP ${{ matrix.php-versions }}) (OS ${{ matrix.operating-system }})
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ "ubuntu-latest", "macos-latest" ]
+        php-versions: [ "7.2", "7.3", "7.4", "8.0", "8.1" ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: swoole, posix, json
+        env:
+          SWOOLE_CONFIGURE_OPTS: --enable-openssl
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Validate composer.json
+        run: "composer validate --strict"
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer Dependencies
+        run: "composer install --prefer-dist --no-progress --optimize-autoloader"
+
+      - name: Run Static Analysis
+        run: "composer analyse"
+
+      - name: Run PHPUnit
+        run: "composer test"
+
+  cs-check:
+    name: PHP CS Fixer Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP 7.2
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "7.2"
+          extensions: swoole, posix, json
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Validate composer.json
+        run: "composer validate --strict"
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer Dependencies
+        run: "composer install --prefer-dist --no-progress --optimize-autoloader"
+
+      - name: Run PHP CS Fixer Check
+        run: "composer cs-fix -- --dry-run --diff"

.github/workflows/vuepress-deploy.yml

@@ -0,0 +1,43 @@
+name: Docs and Script Auto Deploy
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - 'ext/**'
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v2
+
+      - name: Deploy docs to GitHub Pages
+        uses: jenkey2011/vuepress-deploy@master
+        env:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BUILD_SCRIPT: yarn && yarn docs:build
+          BUILD_DIR: docs/.vuepress/dist/
+      - name: Copy deployment to current folder
+        run: |
+          cp -r "${GITHUB_WORKSPACE}/docs/.vuepress/dist" "./deploy"
+      - name: Deploy to Zhamao Server
+        uses: easingthemes/ssh-deploy@main
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.ZHAMAO_XIN_PRIVATE_KEY }}
+          ARGS: "-rltgoDzvO --delete"
+          SOURCE: "deploy/"
+          REMOTE_HOST: ${{ secrets.ZHAMAO_XIN_HOST }}
+          REMOTE_USER: ${{ secrets.ZHAMAO_XIN_USER }}
+          TARGET: ${{ secrets.ZHAMAO_XIN_TARGET }}
+      - name: deploy script file
+        uses: wlixcc/SFTP-Deploy-Action@v1.0
+        with:
+          username: ${{ secrets.ZHAMAO_XIN_USER }}
+          server: ${{ secrets.ZHAMAO_XIN_HOST }}
+          ssh_private_key: ${{ secrets.ZHAMAO_XIN_PRIVATE_KEY }}
+          local_path: './ext/go.sh'
+          remote_path: ${{ secrets.ZHAMAO_XIN_MAIN_TARGET }}

.gitignore

@@ -1,7 +1,80 @@
-.idea/
-/src/test/
-/src/webconsole/config/
-/vendor/
-zm.json
+### Zhamao Framework ###
 /zm_data/
-composer.lock
+/resources/server.phar
+/distribute/
+/resources/zhamao.service
+/runtime/
+/tmp/
+/temp/
+/site/
+
+# 框架审计文件
+audit.log
+
+# 进程锁文件
+.daemon_pid
+.zm_worker_*.pid
+
+### Composer ###
+composer.phar
+/vendor/
+composer.lock
+
+### Go CQHTTP ###
+/ext/go-cqhttp/data/
+/ext/go-cqhttp/logs/
+/ext/go-cqhttp/config.hjson
+/ext/go-cqhttp/device.json
+/ext/go-cqhttp/go-cqhttp
+/ext/go-cqhttp/session.token
+
+### Git ###
+# 备份文件
+*.orig
+
+# 解决 Merge 冲突时可能会自动生成的文件
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+# Git Hooks
+cghooks.lock
+
+### VuePress ###
+/node_modules/
+/docs/.vuepress/dist/
+package-lock.json
+
+### PHPUnit ###
+
+# 生成的文件
+/bin/.phpunit.result.cache
+.phpunit.result.cache
+.phpunit.cache
+
+# 本地配置
+/phpunit.xml
+
+# 构建目录
+/build/
+
+### PhpStorm ###
+# 兼容 PHPStorm 及其他 Jetbrains IDE
+
+# 除了代码格式配置和运行配置之外的所有文件
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+### Phive ###
+/.phive/
+/tools/
+
+### ASDF ###
+/.tool-version

.php-cs-fixer.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @since 2.7.0
+ */
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR12' => true,
+        '@Symfony' => true,
+        '@PhpCsFixer' => true,
+        'array_syntax' => [
+            'syntax' => 'short',
+        ],
+        'list_syntax' => [
+            'syntax' => 'short',
+        ],
+        'concat_space' => [
+            'spacing' => 'one',
+        ],
+        'blank_line_before_statement' => [
+            'statements' => [
+                'declare',
+            ],
+        ],
+        'ordered_imports' => [
+            'imports_order' => [
+                'class',
+                'function',
+                'const',
+            ],
+            'sort_algorithm' => 'alpha',
+        ],
+        'single_line_comment_style' => [
+            'comment_types' => [
+            ],
+        ],
+        'yoda_style' => [
+            'always_move_variable' => false,
+            'equal' => false,
+            'identical' => false,
+        ],
+        'multiline_whitespace_before_semicolons' => [
+            'strategy' => 'no_multi_line',
+        ],
+        'constant_case' => [
+            'case' => 'lower',
+        ],
+        'class_attributes_separation' => true,
+        'combine_consecutive_unsets' => true,
+        'declare_strict_types' => true,
+        'linebreak_after_opening_tag' => true,
+        'lowercase_static_reference' => true,
+        'no_useless_else' => true,
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => false,
+        'not_operator_with_space' => false,
+        'ordered_class_elements' => true,
+        'php_unit_strict' => false,
+        'phpdoc_separation' => false,
+        'single_quote' => true,
+        'standardize_not_equals' => true,
+        'multiline_comment_opening_closing' => true,
+        'phpdoc_summary' => false,
+        'php_unit_test_class_requires_covers' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__ . '/src')
+            ->in(__DIR__ . '/tests')
+    )
+    ->setUsingCache(false);

.run/Reload Zhamao Server.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Reload Zhamao Server" type="ShConfigurationType">
+    <option name="SCRIPT_TEXT" value="./zhamao server:reload &amp;&amp; exit" />
+    <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
+    <option name="SCRIPT_PATH" value="" />
+    <option name="SCRIPT_OPTIONS" value="" />
+    <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
+    <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
+    <option name="INTERPRETER_PATH" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
+    <option name="EXECUTE_SCRIPT_FILE" value="false" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.run/Run Zhamao Server.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Zhamao Server" type="ShConfigurationType">
+    <option name="SCRIPT_TEXT" value="./zhamao server" />
+    <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
+    <option name="SCRIPT_PATH" value="./zhamao" />
+    <option name="SCRIPT_OPTIONS" value="server" />
+    <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
+    <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
+    <option name="INTERPRETER_PATH" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
+    <option name="EXECUTE_SCRIPT_FILE" value="false" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.run/Run watcher.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run watcher" type="ShConfigurationType">
+    <option name="SCRIPT_TEXT" value="bin/watcher" />
+    <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
+    <option name="SCRIPT_PATH" value="" />
+    <option name="SCRIPT_OPTIONS" value="" />
+    <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
+    <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
+    <option name="INTERPRETER_PATH" value="/bin/zsh" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
+    <option name="EXECUTE_SCRIPT_FILE" value="false" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.run/Stop Zhamao Server.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Stop Zhamao Server" type="ShConfigurationType">
+    <option name="SCRIPT_TEXT" value="./zhamao server:stop &amp;&amp; exit" />
+    <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
+    <option name="SCRIPT_PATH" value="" />
+    <option name="SCRIPT_OPTIONS" value="" />
+    <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
+    <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
+    <option name="INTERPRETER_PATH" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
+    <option name="EXECUTE_SCRIPT_FILE" value="false" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

Dockerfile

@@ -1,15 +0,0 @@
-FROM phpswoole/swoole:4.4.15-php7.3
-WORKDIR /app/
-RUN echo "Asia/Shanghai" > /etc/timezone
-#RUN dpkg-configure -f noninteractive tzdata
-ENV LANG C.UTF_8
-
-VOLUME ["/app/zhamao-framework/"]
-ADD . /app/zhamao-framework
-ADD . /app/zhamao-framework-bak
-#RUN cd /app/zhamao-framework && composer update && composer clearcache
-#RUN mv zhamao-framework-master zhamao-framework
-WORKDIR /app/zhamao-framework
-
-EXPOSE 20001
-CMD ["bash", "/app/zhamao-framework-bak/.entry.sh"]

README.md

@@ -1,87 +1,172 @@
-# zhamao-framework
+<div align="center">
+  <img src="https://cdn.jsdelivr.net/gh/zhamao-robot/zhamao-framework/resources/images/logo_trans.png" width = "150" height = "150" alt="炸毛框架"><br>
+  <h2>炸毛框架</h2>
+  炸毛框架 (zhamao-framework) 是一个协程高性能的聊天机器人 + Web 服务器开发框架<br><br>
 
-[![作者QQ](https://img.shields.io/badge/作者QQ-627577391-orange.svg)]()
-[![zhamao License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/zhamao-robot/zhamao-framework/blob/master/LICENSE)
-[![版本](https://img.shields.io/badge/version-1.2-green.svg)]()
+<p align="center">
+  <a href="https://onebot.dev/">
+    <img src="https://img.shields.io/badge/OneBot-11-black?style=flat-square" alt="OneBot">
+  </a>
 
-[![stupid counter](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/stupid.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=stupid)
-[![TODO counter](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/TODO.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=TODO)
+  <a href="https://github.com/zhamao-robot/zhamao-framework/actions">
+    <img src="https://img.shields.io/github/workflow/status/zhamao-robot/zhamao-framework/Integration%20and%20Style%20Test?label=Test&style=flat-square" alt="Integration Test">
+  </a>
 
-一个异步、多平台兼容的 **聊天机器人** 框架。
+  <a href="https://packagist.org/packages/zhamao/framework">
+    <img src="https://img.shields.io/packagist/dt/zhamao/framework?label=Downloads&style=flat-square" alt="下载数">
+  </a>
 
-<img src="https://avatars0.githubusercontent.com/u/48620312" height = "200" alt="炸毛框架" align=center/>
+  <a href="https://github.com/zhamao-robot/zhamao-framework/releases">
+    <img src="https://img.shields.io/packagist/v/zhamao/framework?include_prereleases&label=Release&style=flat-square" alt="最新版本">
+  </a>
+
+  <a href="https://github.com/zhamao-robot/zhamao-framework/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/zhamao-robot/zhamao-framework?label=License&style=flat-square" alt="开源协议">
+  </a>
+
+  <a href="https://wpa.qq.com/msgrd?v=3&uin=627577391&site=qq&menu=yes">
+    <img src="https://img.shields.io/badge/作者QQ-627577391-orange?style=flat-square" alt="作者QQ">
+  </a>
+
+  <br>
+  <br>
+
+  <a href="https://github.com/zhamao-robot/zhamao-framework/search?q=AnnotationBase">
+    <img src="https://img.shields.io/github/search/zhamao-robot/zhamao-framework/AnnotationBase?label=Annotations&style=flat-square" alt="注解数量">
+  </a>
+
+  <a href="https://github.com/zhamao-robot/zhamao-framework/search?q=TODO">
+    <img src="https://img.shields.io/github/search/zhamao-robot/zhamao-framework/TODO?label=TODO&style=flat-square" alt="TODO">
+  </a>
+</p>
+
+</div>
+
+开发者 QQ 群：**670821194** [点击加入群聊](https://jq.qq.com/?_wv=1027&k=YkNI3AIr)
+
+**如果有愿意一起开发框架本身的开发者，请提出 PR 或 Issue 参与开发！如果对框架本身的核心设计有更好的想法，可与作者成立开发组（目前仅 2 人），参与 OneBot V12 生态和框架本身的开发。**
+
+**相关正在进行的版本任务见 Projects 一栏！**
 
 ## 简介
-zhamao-framework 是一个基于 酷Q 的 PHP Swoole 的机器人框架，它会对 QQ 机器人收到的消息进行解析处理，并以模块化的形式进行开发，来完成机器人的自然语言对话等功能。
 
-框架对接 酷Q 的桥梁是 **CQHTTP** 插件，这里是它的[项目地址](https://github.com/richardchien/coolq-http-api/)。
+炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（OneBot 兼容的 QQ 机器人对接），包含 Websocket、HTTP
+等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。
 
-除了起到解析消息的作用，炸毛框架 还提供了完整的 WebSocket + HTTP 服务器，你还能用此框架构建出高性能的 API 接口服务器。
+框架主要用途为 HTTP 服务器，机器人搭建框架。尤其对于 QQ 机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。
+
+```php
+/**
+ * @CQCommand("你好")
+ */
+public function hello() {
+  ctx()->reply("你好，我是炸毛！"); // 简单的命令式回复
+}
+/**
+ * @RequestMapping("/index")
+ */
+public function index() {
+  return "<h1>hello!</h1>"; // 快速的 HTTP 服务开发
+}
+```
+
+> 从 2.7.0 版本开始，框架已支持同时使用 Annotation 和原生 Attribute 注解，供开发者根据需要自由选用。
 
 ## 开始
-你可以使用 GitHub 的 `Use This Template` 功能快速将本项目克隆到你的公开或私有仓库，也可以从 `release` 中下载本项目的最新版本到本地私有开发。
+
+框架目前支持 Linux、WSL、macOS 环境直接运行，上述环境可直接使用下方一键安装脚本。
+
+> 如果你想在其他环境安装部署，可使用 Docker、Cygwin，详见文档。
+
+```bash
+# 检测PHP环境、安装框架
+bash <(curl -fsSL https://zhamao.xin/go.sh)
+
+# 启动框架
+cd zhamao-app
+./zhamao server
+```
+
+一键安装脚本还有可以自定义参数的方式，比如：
+
+```bash
+# 脚本默认会检测系统的PHP，如果想直接跳过检测，安装独立的PHP版本，则添加此环境变量
+export ZM_NO_LOCAL_PHP="yes"
+# 脚本如果安装独立版本PHP，默认版本为8.0，如果想使用其他版本，则添加此环境变量指定版本
+export ZM_DOWN_PHP_VERSION="8.1"
+# 脚本默认会将框架在当前目录下的 `zhamao-app` 目录进行安装，如果想使用其他目录，则添加此环境变量
+export ZM_CUSTOM_DIR="my-custom-app"
+# 脚本默认会对本项目使用阿里云国内加速镜像，如果想使用packagist源，则添加此环境变量
+export ZM_COMPOSER_PACKAGIST="yes"
+# 执行完前面的环境变量再执行一键安装脚本，就可以实现自定义参数！
+bash <(curl -fsSL https://zhamao.xin/go.sh)
+```
+
+关于其他安装方式，请参阅[文档](https://framework.zhamao.xin/guide/installation.html) 。
 
 ## 文档
-本项目文档正在努力编写中。
 
-Pages：[https://framework.zhamao.xin/](https://framework.zhamao.xin/)
+查看文档（国内自建）：<https://framework.zhamao.xin/>
 
-如果上面的访问较慢，可以访问国内服务器：[https://framework2.zhamao.xin/](https://framework2.zhamao.xin/)
+备用链接（国外托管）：<https://framework.zhamao.me/>
 
 ## 特点
-- 支持多账号
-- 灵活的注解事件绑定机制
-- 采用模块化编写，功能之间高内聚低耦合
-- 常驻内存，全局缓存变量随处使用
-- 自带 MySQL 查询器、数据库连接池等数据库连接方案
-- 自带 HTTP 服务器、WebSocket 服务器可复用，可以构建属于自己的 HTTP API 接口
-- 静态文件服务器
 
-## 炸毛特色模块
+- 原生支持多个机器人客户端同时连接
+- 使用 Swoole 多工作进程机制和协程加持，尽可能简单的情况下提升了性能
+- 灵活的注解事件绑定机制，可同时使用 Annotation 和原生 Attribute 注解
+- 易用的上下文，模块内随处可用
+- 采用模块化编写，可自由搭配其他 Composer 组件，也可单文件面向过程编写
+- 支持模块打包、热加载，分享模块更方便
+- 常驻内存，全局缓存变量随处使用，提供多种缓存方案
+- 自带 MySQL、Redis 等数据库连接池等数据库连接方案
+- 本身为 HTTP 服务器、WebSocket 服务器，可以构建属于自己的 HTTP API 接口
+- 静态文件服务器，可将前端合并到一起
+- 自带 PHP + Swoole 环境，无需手动编译安装，by [crazywhalecc/static-php-cli](https://github.com/crazywhalecc/static-php-cli)
 
-| 模块名称           | 说明                             | 模块地址                                                     |
-| ------------------ | -------------------------------- | ------------------------------------------------------------ |
-| 微信公众号兼容模块 | 为框架提供微信公众号订阅号兼容层 | [zhamao-wechat-patch](https://github.com/zhamao-robot/zhamao-wechat-patch) |
-| 通用模块 | 图片上传和下载模块 | [zhamao-general-tools](https://github.com/zhamao-robot/zhamao-general-tools) |
+## 下载源码
 
-## 计划开发内容
-- [ ] WebSocket测试脚本（客户端）
-- [X] Session 和中间层管理模块
-- [ ] 支持本地和远程两种方式的定时器（计划任务）
-- [X] 常驻服务脚本
-- [ ] 一些常用的通用 API 例如经济（用户积分、亲密度等）的模块
-- [ ] 图灵机器人/腾讯AI 聊天模块
-- [ ] 分词模块（可能会放弃计划，因为目前好用的分词都是其他语言的）
-- [ ] HTTP 过滤器、Auth 模块、完整的 MVC 兼容（可能会放弃计划，因为框架主打机器人开发）
-- [ ] Redis 连接池或开箱即用的相应功能内置
-- [ ] 2.0 版本抛弃 `ModBase` 继承结构，完全使用上下文代替
-- [X] 更好的 Logger，稳定和漂亮的控制台输出
-- [ ] 日志服务
-- [ ] 模块支持 Phar 打包（可能会比较靠后支持）
-- [ ] 兼容面向过程的模块编写方案（可能会比较靠后支持）
-- [ ] 完整的单元测试（如果有需求则尽快开发）
-- [X] 静态文件服务器
+框架源码可直接克隆本仓库进行编辑，如果你在国内，访问 GitHub 和克隆仓库比较慢，可以将 `github.com` 替换为 `fgit.zhamao.me` 进行加速。
 
-## 从 cqbot-swoole 升级
-目前新的框架采用了全新的注解机制，所以旧版的框架上写的模块到新框架需要重新编写。当然为了减少工作量，新的框架也最大限度地保留了旧版框架编写的风格，一般情况下根据新版框架的文档仅需修改少量地方即可完成重写。
-
-旧版框架并入了 `old` 分支，如果想继续使用旧版框架请移步分支。升级过程中如果遇到问题可以找作者。
+例如：`git clone https://fgit.zhamao.me/zhamao-robot/zhamao-framework.git --depth 1`。
 
 ## 贡献和捐赠
-如果你在使用过程中发现任何问题，可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。目前项目仅一人维护，耗费精力较大，所以非常欢迎对框架的贡献。
+
+如果你在使用过程中发现任何问题，可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。
+
+目前项目仅一人维护，耗费精力较大，所以非常欢迎对框架的贡献。
 
 本项目为作者闲暇时间开发，如果觉得好用，不妨进行捐助～你的捐助会让我更加有动力完善插件，感谢你的支持！
 
-我们会将捐赠的资金用于本项目驱动的炸毛机器人和框架文档的服务器开销上。
+我们会将捐赠的资金用于本项目驱动的炸毛机器人和框架文档的服务器开销上。[捐赠列表](https://github.com/zhamao-robot/thanks)
+
+如果您不想直接参与框架的开发，也可以分享你编写的模块，帮助完善框架生态。
 
 ### 支付宝
-![支付宝二维码](/resources/images/alipay_img.jpg)
+
+![支付宝二维码](https://cdn.jsdelivr.net/gh/zhamao-robot/zhamao-framework/resources/images/alipay_img.jpg)
 
 ## 关于
-框架和 SDK 是 炸毛机器人 项目的核心框架开源部分。炸毛机器人（3276124472）是作者写的一个高性能机器人，曾获全国计算机设计大赛一等奖。
 
-欢迎随时在 HTTP-API 插件群里提问，当然更好的话可以加作者 QQ（627577391）或提交 Issue 进行疑难解答。
+框架和 SDK 是 炸毛机器人 项目的核心框架开源部分。炸毛机器人是作者写的一个高性能机器人，曾获全国计算机设计大赛一等奖。
 
-本项目在更行内容时，请及时关注 GitHub 动态，更新前请将自己的模块代码做好备份。
+作者的炸毛机器人已从2018年初起稳定运行了**四年半**，并且持续迭代。
+
+欢迎随时在 HTTP-API 插件群里提问，当然更好的话可以加作者 QQ（[627577391](http://wpa.qq.com/msgrd?v=3&uin=627577391&site=qq&menu=yes)）
+或提交 [Issue](https://github.com/zhamao-robot/zhamao-framework/issues/new/choose) 进行疑难解答。
+
+本项目在更新内容时，请及时关注 GitHub 动态，更新前请将自己的模块代码做好备份。
 
 项目框架采用 Apache-2.0 协议开源，在分发或重写修改等操作时需遵守协议。项目模块部分(`Module` 文件夹) 在非借鉴框架内代码时可不遵守 Apache-2.0 协议进行分发和修改(声明版权)。
+
+**注意**：在你使用 mirai 等 `AGPL-3.0` 协议的机器人软件与框架连接时，使用本框架需要将你编写或修改的部分使用 `AGPL-3.0` 协议重新分发。
+
+在贡献代码时，请保管好自己的全局配置文件中的敏感信息，请勿将带有个人信息的配置文件上传 GitHub 等网站。
+
+感谢 JetBrains 为此开源项目提供 PhpStorm 开发工具支持：
+
+<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/PhpStorm.svg" width="300">
+
+感谢 [php-libonebot](https://github.com/botuniverse/php-libonebot) 开发者 @sunxyw 中为项目开发规范化提出的一些建议。
+
+<!-- ![star](https://starchart.cc/zhamao-robot/zhamao-framework.svg) -->

SECURITY.md

@@ -1,13 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.2 | :white_check_mark: |
-| 1.1.x   | :x: |
-| 1.0.x   | :x:                |
-
-## Reporting a Vulnerability
-
-If you find a bug which is safety related, you should post a new issue named **Security Issue**, and I will check it as soon as possible.

bin/gendoc

@@ -0,0 +1,401 @@
+#!/usr/bin/env php
+<?php
+
+/**
+ * 决定是否忽略该类
+ *
+ * @param ReflectionClass $class 准备生成的类的反射类
+ */
+function should_ignore_class(ReflectionClass $class): bool
+{
+    // 注解类
+    if (($doc = $class->getDocComment()) && strpos($doc, '@Annotation') !== false) {
+        return true;
+    }
+    if (str_ends_with($class->getName(), 'Exception')) {
+        return true;
+    }
+    if (str_contains($class->getName(), '_')) {
+        return true;
+    }
+    return false;
+}
+
+if (PHP_VERSION_ID < 70400) {
+    echo 'PHP 版本必须为 7.4 或以上';
+    exit(1);
+}
+
+function check_composer_executable(string $composer): bool
+{
+    passthru($composer . ' --version 2>/dev/null', $exit_code);
+    return $exit_code === 0;
+}
+
+function find_valid_root(string $current_dir, int $max_loop): string
+{
+    if ($max_loop <= 0) {
+        return '';
+    }
+    if (!file_exists($current_dir . '/composer.json')) {
+        return find_valid_root(dirname($current_dir), $max_loop - 1);
+    }
+    return $current_dir;
+}
+
+$root = find_valid_root(getcwd(), 3);
+if (empty($root)) {
+    echo '找不到有效的根目录';
+    exit(1);
+}
+echo '根目录: ' . $root . PHP_EOL;
+
+chdir($root);
+
+if (!is_dir($root . '/src/ZM')) {
+    echo '源码目录不存在';
+    exit(1);
+}
+
+$phpdoc_package_temp_installed = false;
+if (file_exists($root . '/vendor/jasny/phpdoc-parser/composer.json')) {
+    echo '正在使用现有的 PHPDoc 解析库' . PHP_EOL;
+} else {
+    echo 'PHPDoc 解析库不存在，正在尝试安装...' . PHP_EOL;
+    echo '本次生成完成后将会自动移除' . PHP_EOL;
+    $composers = [
+        'runtime/composer', 'composer', 'php composer.phar',
+    ];
+    foreach ($composers as $composer) {
+        if (check_composer_executable($composer)) {
+            echo '正在使用 ' . $composer . ' 安装 PHPDoc 解析库，请稍候...' . PHP_EOL;
+            passthru("{$composer} require --quiet jasny/phpdoc-parser", $exit_code);
+            if ($exit_code === 0) {
+                $phpdoc_package_temp_installed = true;
+                break;
+            }
+        }
+    }
+    if (!$phpdoc_package_temp_installed) {
+        echo '安装失败，请手动安装：composer require jasny/phpdoc-parser' . PHP_EOL;
+        exit(1);
+    }
+}
+
+// 从这里开始是主要生成逻辑
+
+require_once $root . '/vendor/autoload.php';
+
+use Jasny\PhpdocParser\PhpdocParser;
+use Jasny\PhpdocParser\Set\PhpDocumentor;
+use Jasny\PhpdocParser\Tag\Summery;
+use ZM\Console\Console;
+
+$opts = getopt('', ['show-warnings', 'show-debug']);
+
+if (array_key_exists('show-warnings', $opts)) {
+    $show_warnings = true;
+} else {
+    $show_warnings = false;
+}
+
+Console::init(array_key_exists('show-debug', $opts) ? 4 : 2);
+
+$errors = [];
+$warnings = [];
+
+// 获取源码目录的文件遍历器
+$fs = new \RecursiveDirectoryIterator($root . '/src/ZM', FilesystemIterator::SKIP_DOTS);
+
+// 初始化文档解析器
+$parser = new PhpdocParser(PhpDocumentor::tags()->with([
+    new Summery(),
+]));
+
+$metas = [];
+$class_count = 0;
+$method_count = 0;
+
+function error(string $message)
+{
+    global $errors;
+    $errors[] = $message;
+    Console::error($message);
+}
+
+function warning(string $message)
+{
+    global $warnings, $show_warnings;
+    $warnings[] = $message;
+    if ($show_warnings) {
+        Console::warning($message);
+    }
+}
+
+/**
+ * 获取类的元数据
+ *
+ * 包括类的注释、方法的注释、参数、返回值等
+ */
+function get_class_metas(string $class_name, PhpdocParser $parser): array
+{
+    // 尝试获取反射类
+    try {
+        $class = new \ReflectionClass($class_name);
+    } catch (\ReflectionException $e) {
+        error('无法获取类 ' . $class_name . ' 的反射类');
+        return [];
+    }
+
+    // 判断是否略过该类
+    if (should_ignore_class($class)) {
+        return [];
+    }
+
+    $metas = [];
+
+    // 遍历类方法
+    foreach ($class->getMethods() as $method) {
+        if ($method->getDeclaringClass()->getName() !== $class_name) {
+            continue;
+        }
+
+        Console::verbose('正在解析方法：' . $class_name . '::' . $method->getName());
+
+        // 获取方法的注释并解析
+        $doc = $method->getDocComment();
+        if (!$doc) {
+            warning('找不到文档：' . $class_name . '::' . $method->getName());
+            continue;
+        }
+        try {
+            $meta = $parser->parse($doc);
+        } catch (\Exception $e) {
+            error('解析失败：' . $class_name . '::' . $method->getName() . '，' . $e->getMessage());
+            continue;
+        }
+        // 少数情况解析后会带有 */，需要去除
+        array_walk_recursive($meta, static function (&$item) {
+            if (is_string($item)) {
+                $item = trim(str_replace('*/', '', $item));
+            }
+        });
+
+        // 对比反射方法获取的参数和注释声明的参数
+        $parameters = $method->getParameters();
+        $params_in_doc = $meta['params'] ?? [];
+
+        foreach ($parameters as $parameter) {
+            $parameter_name = $parameter->getName();
+            // 不存在则添加进参数列表中
+            if (!isset($params_in_doc[$parameter_name])) {
+                $params_in_doc[$parameter_name] = [
+                    'type' => $parameter->getType()?->getName(),
+                    'description' => '',
+                ];
+            }
+        }
+        // 确保所有参数都有对应的类型和描述
+        foreach ($params_in_doc as &$param) {
+            if (!isset($param['type'])) {
+                $param['type'] = 'mixed';
+            }
+            if (!isset($param['description'])) {
+                $param['description'] = '';
+            }
+        }
+        // 清除引用
+        unset($param);
+        $meta['params'] = $params_in_doc;
+
+        // 设定方法默认返回值
+        if (!isset($meta['return'])) {
+            $meta['return'] = [
+                'type' => $method->getReturnType()?->getName() ?: 'mixed',
+                'description' => '',
+            ];
+        }
+
+        // 设定默认描述
+        if (!isset($meta['return']['description'])) {
+            $meta['return']['description'] = '';
+        }
+
+        $metas[$method->getName()] = $meta;
+    }
+
+    return $metas;
+}
+
+/**
+ * 将方法的元数据转换为 Markdown 格式
+ *
+ * @param string $method 方法名
+ * @param array  $meta   元数据
+ */
+function convert_meta_to_markdown(string $method, array $meta): string
+{
+    // 方法名作为标题
+    $markdown = '## ' . $method . "\n\n";
+
+    // 构造方法代码块
+    $markdown .= '```php' . "\n";
+    // TODO: 适配 private 等修饰符
+    $markdown .= 'public function ' . $method . '(';
+    $params = [];
+    // 添加参数
+    foreach ($meta['params'] as $param_name => $param_meta) {
+        $params[] = sprintf('%s $%s', $param_meta['type'] ?? 'mixed', $param_name);
+    }
+    $markdown .= implode(', ', $params) . ')';
+    // 添加返回值
+    $markdown .= ': ' . $meta['return']['type'];
+    $markdown .= "\n```\n\n";
+
+    // 方法描述
+    $markdown .= '### 描述' . "\n\n";
+    $markdown .= ($meta['description'] ?? '作者很懒，什么也没有说') . "\n\n";
+
+    // 参数
+    if (count($meta['params'])) {
+        $markdown .= '### 参数' . "\n\n";
+        $markdown .= '| 名称 | 类型 | 描述 |' . "\n";
+        $markdown .= '| -------- | ---- | ----------- |' . "\n";
+        foreach ($meta['params'] as $param_name => $param_meta) {
+            $markdown .= '| ' . $param_name . ' | ' . $param_meta['type'] . ' | ' . $param_meta['description'] . ' |' . "\n";
+        }
+        $markdown .= "\n";
+    }
+
+    // 返回值
+    $markdown .= '### 返回' . "\n\n";
+    $markdown .= '| 类型 | 描述 |' . "\n";
+    $markdown .= '| ---- | ----------- |' . "\n";
+    $markdown .= '| ' . $meta['return']['type'] . ' | ' . $meta['return']['description'] . ' |' . "\n";
+
+    return $markdown;
+}
+
+function generate_sidebar_config(string $title, array $items): array
+{
+    return [
+        'title' => $title,
+        'collapsable' => true,
+        'children' => $items,
+    ];
+}
+
+Console::info('开始生成！');
+
+// 遍历类并将元数据添加至数组中
+foreach (new \RecursiveIteratorIterator($fs) as $file) {
+    if (!$file->isFile()) {
+        continue;
+    }
+    $path = $file->getPathname();
+
+    // 过滤不包含类的文件
+    $tokens = token_get_all(file_get_contents($path));
+    $found = false;
+    foreach ($tokens as $k => $token) {
+        if (!is_array($token)) {
+            continue;
+        }
+        if ($token[0] === T_CLASS && $tokens[$k - 2][0] !== T_NEW) {
+            $found = true;
+            break;
+        }
+        if ($k >= 100) {
+            break;
+        }
+    }
+    if (!$found) {
+        continue;
+    }
+
+    // 获取完整类名
+    $path = ltrim($path, $root . '/');
+    $class = str_replace(['.php', 'src/', '/'], ['', '', '\\'], $path);
+    Console::verbose('正在解析类：' . $class);
+    $meta = get_class_metas($class, $parser);
+    // 忽略不包含任何方法的类
+    if (empty($meta)) {
+        continue;
+    }
+    $metas[$class] = $meta;
+    ++$class_count;
+    $method_count += count($meta);
+}
+
+// 将元数据转换为 Markdown
+$markdown = [];
+foreach ($metas as $class => $class_metas) {
+    $markdown[$class] = [];
+    // 将类名作为页面大标题
+    $markdown[$class]['class'] = '# ' . $class;
+    foreach ($class_metas as $method => $meta) {
+        $markdown[$class][$method] = convert_meta_to_markdown($method, $meta);
+    }
+}
+
+// 生成文档
+$docs = $root . '/docs/api/';
+foreach ($markdown as $class => $methods) {
+    $file = $docs . str_replace('\\', '/', $class) . '.md';
+    // 确保目录存在
+    if (!file_exists(dirname($file)) && !mkdir($concurrent_directory = dirname($file), 0777, true) && !is_dir($concurrent_directory)) {
+        throw new \RuntimeException(sprintf('无法建立目录 %s', $concurrent_directory));
+    }
+    Console::verbose('正在生成文档：' . $file);
+    $text = implode("\n\n", $methods);
+    file_put_contents($file, $text);
+}
+
+// 生成文档目录
+$children = array_keys($markdown);
+$children = str_replace('\\', '/', $children);
+$class_tree = [];
+foreach ($children as $child) {
+    $parent = dirname($child);
+    $class_tree[$parent][] = $child;
+}
+ksort($class_tree);
+$config = 'module.exports = [';
+foreach ($class_tree as $parent => $children) {
+    $encode = json_encode(generate_sidebar_config($parent, $children));
+    $encode = str_replace('\/', '/', $encode);
+    $config .= $encode . ',';
+}
+$config = rtrim($config, ',');
+$config .= ']';
+
+$file = $root . '/docs/.vuepress/api.js';
+file_put_contents($file, $config);
+
+if (count($warnings)) {
+    Console::warning('生成过程中发现 ' . count($warnings) . ' 次警告');
+    if (!$show_warnings) {
+        Console::info('生成器默认忽略了警告，你可以通过 gendoc --show-warnings 来查看警告');
+    }
+}
+if (count($errors)) {
+    Console::error('生成过程中发现错误：');
+    foreach ($errors as $error) {
+        Console::error($error);
+    }
+}
+
+Console::success('API 文档生成完毕');
+Console::success(sprintf('共生成 %d 个类，共 %d 个方法', $class_count, $method_count));
+
+// 完成生成，进行善后
+
+if ($phpdoc_package_temp_installed) {
+    echo '正在移除 PHPDoc 解析库，请稍候...' . PHP_EOL;
+    passthru('composer remove --quiet jasny/phpdoc-parser', $exit_code);
+    if ($exit_code !== 0) {
+        echo '移除失败，请手动移除：composer remove jasny/phpdoc-parser' . PHP_EOL;
+    }
+    echo '移除完成';
+}
+exit(0);

bin/phpunit-swoole

@@ -0,0 +1,111 @@
+#!/usr/bin/env php
+<?php
+/** For Swoole coroutine tests */
+
+// 如果改成 true，则会在终端显示所有炸毛框架的 Log
+const ZM_TEST_LOG_DEBUG = false;
+
+use PHPUnit\Runner\Version;
+use PHPUnit\TextUI\TestRunner;
+use Swoole\Coroutine;
+use ZM\Annotation\Swoole\OnStart;
+use ZM\Command\RunServerCommand;
+use ZM\Console\Console;
+use ZM\ConsoleApplication;
+use ZM\Event\EventManager;
+use ZM\Framework;
+use ZM\Store\ZMAtomic;
+use ZM\Utils\ZMUtil;
+
+$root = dirname(__DIR__);
+
+Coroutine::set([
+    'log_level' => SWOOLE_LOG_INFO,
+    'trace_flags' => 0,
+]);
+
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (PHP_VERSION_ID <= 70100) {
+    fwrite(
+        STDERR,
+        sprintf(
+            'This version of PHPUnit is supported on PHP 7.1 and above.' . PHP_EOL .
+            'You are using PHP %s (%s).' . PHP_EOL,
+            PHP_VERSION,
+            PHP_BINARY
+        )
+    );
+
+    exit(1);
+}
+
+if (!ini_get('date.timezone')) {
+    ini_set('date.timezone', 'Asia/Shanghai');
+}
+
+require $root . '/vendor/autoload.php';
+
+const ZM_VERSION_ID = ConsoleApplication::VERSION_ID;
+const ZM_VERSION = ConsoleApplication::VERSION;
+
+// 模拟define
+const ZM_PROCESS_MASTER = 1;
+const ZM_PROCESS_MANAGER = 2;
+const ZM_PROCESS_WORKER = 4;
+const ZM_PROCESS_USER = 8;
+const ZM_PROCESS_TASKWORKER = 16;
+
+define('FRAMEWORK_ROOT_DIR', $root);
+define('WORKING_DIR', $root);
+const SOURCE_ROOT_DIR = WORKING_DIR;
+define('LOAD_MODE', is_dir(SOURCE_ROOT_DIR . '/src/ZM') ? 0 : 1);
+chdir(__DIR__ . '/../');
+
+$options = array_map(function ($x) {
+    return $x->getDefault();
+}, RunServerCommand::exportDefinition()->getOptions());
+$options['disable-safe-exit'] = true;
+$options['worker-num'] = 1;
+$options['private-mode'] = true;
+$options['log-error'] = true;
+
+spl_autoload_register(static function ($class) {
+    $map = [
+        TestRunner::class => 'vendor/phpunit/phpunit/src/TextUI/TestRunner.php',
+        Version::class => 'vendor/phpunit/phpunit/src/Runner/Version.php',
+    ];
+    if (isset($map[$class])) {
+        $source = file_get_contents(SOURCE_ROOT_DIR . '/' . $map[$class]);
+        $source = str_replace(['#StandWith', 'Ukraine', 'declare(strict_types=1);'], '', $source);
+        eval('?>' . $source);
+    }
+}, true, true);
+
+Console::setLevel(0);
+$framework = new Framework($options);
+$start = new OnStart();
+$start->method = function () {
+    try {
+        Console::setLevel(ZM_TEST_LOG_DEBUG ? 4 : 0);
+        $retcode = PHPUnit\TextUI\Command::main(false);
+    } finally {
+        Console::setLevel(0);
+        ZMUtil::stop(($retcode ?? 1) !== 0);
+    }
+};
+EventManager::addEvent(OnStart::class, $start);
+
+$framework->start();
+
+Swoole\Event::wait();
+if (ZMAtomic::get('stop_signal')->get() === 2) {
+    exit(1);
+}

bin/start

@@ -1,51 +1,34 @@
-#!/usr/bin/env php
-<?php
+#!/bin/sh
 
-use Framework\FrameworkLoader;
-use Scheduler\Scheduler;
+# shellcheck disable=SC2068
+# shellcheck disable=SC2181
+# author: crazywhalecc
+# since: 2.5.0
 
-require __DIR__ . '/../src/Framework/FrameworkLoader.php';
-require __DIR__ . '/../src/Scheduler/Scheduler.php';
+if [ -f "$(pwd)/runtime/php" ]; then
+    executable="$(pwd)/runtime/php"
+    echo "* Framework started with built-in php."
+else
+    which php >/dev/null 2>&1
+	if [ $? -eq 0 ]; then
+	    executable=$(which php)
+	else
+	    echo '[ErrCode:E00014] Cannot find any PHP runtime, please use command "./install-runtime.sh" or install PHP manually!'
+	    exit 1
+	fi
+fi
 
-Swoole\Coroutine::set([
-    'max_coroutine' => 30000,
-]);
+result=$(echo "$1" | grep -E "module|build")
 
-date_default_timezone_set("Asia/Shanghai");
-
-switch ($argv[1] ?? '') {
-    case 'scheduler':
-    case 'timer':
-        go(function () {
-            try {
-                new Scheduler(Scheduler::REMOTE);
-            } catch (Exception $e) {
-                die($e->getMessage());
-            }
-        });
-        break;
-    case '':
-    case 'framework':
-    case 'server':
-        if(!is_dir(__DIR__.'/../vendor/')){
-            echo "Warning: you have not update composer!\n";
-            exec("composer update", $out, $var);
-            if($var != 0) {
-                echo "You need to run \"composer update\" at root of zhamao-framework!\n";
-                die;
-            }
-        }
-        $loader = new FrameworkLoader($argv);
-        break;
-    case '--help':
-    case '-h':
-        echo "\nUsage: ".$argv[0]." [OPTION]\n";
-        echo "\nzhamao-framework start script, provides several startup arguments.";
-        echo "\n\n  -h, --help\t\tShow this help menu";
-        echo "\n  framework, server\tstart main framework, this is default option\n\n";
-        break;
-    default:
-        echo "Unknown option \"{$argv[1]}\"!\n\"--help\" for more information\n";
-        break;
-}
+if [ "$result" != "" ]; then
+    executable="$executable -d phar.readonly=off"
+fi
 
+if [ -f "$(pwd)/src/entry.php" ]; then
+    $executable "$(pwd)/src/entry.php" $@
+elif [ -f "$(pwd)/vendor/zhamao/framework/src/entry.php" ]; then
+    $executable "$(pwd)/vendor/zhamao/framework/src/entry.php" $@
+else
+    echo "[ErrCode:E00015] Cannot find zhamao-framework entry file!"
+    exit 1
+fi

bin/systemd

@@ -1,26 +0,0 @@
-#!/usr/bin/env php
-<?php /** @since 1.2 */
-switch ($argv[1] ?? '') {
-    case '--generate':
-        generate();
-        break;
-    case '--help':
-    case '-h':
-    default:
-        echo "\nUsage: " . $argv[0] . " [OPTION]\n";
-        echo "\nzhamao-framework systemd generator.";
-        echo "\n\n  -h, --help\t\tShow this help menu";
-        echo "\n  --generate\tGenerate a systemd service file\n\n";
-        break;
-}
-
-function generate() {
-    $s = "[Unit]\nDescription=zhamao-framework Daemon\nAfter=rc-local.service\n\n[Service]\nType=simple";
-    $s .= "\nUser=" . exec("whoami");
-    $s .= "\nGroup=" . exec("groups | awk '{print $1}'");
-    $s .= "\nWorkingDirectory=" . getcwd();
-    $s .= "\nExecStart=" . getcwd() . "/bin/start server --disable-console-input";
-    $s .= "\nRestart=always\n\n[Install]\nWantedBy=multi-user.target\n";
-    file_put_contents(getcwd() . "/resources/zhamao.service", $s);
-    echo "File successfully generated. Path: " . getcwd() . "/resources/zhamao.service\n";
-}

bin/update-composer

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-composer update

bin/watcher

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+
+_red="\e[33m"
+_green="\e[32m"
+_reset="\e[0m"
+
+unix_s=$(uname -s)
+
+unix_release=$(
+    marked_release=""
+    if [ "$unix_s" = "Linux" ]; then
+        echo $HOME | grep com.termux >/dev/null
+        if [ $? == 0 ]; then
+            marked_release="termux"
+        elif [ -f "/etc/redhat-release" ]; then
+            if [ "$(cat /etc/redhat-release | awk '{print $1}' | grep -v '^$')" = "CentOS" ]; then
+                marked_release="CentOS"
+            else
+                marked_release="unknown"
+            fi
+        elif [ -f "/etc/os-release" ]; then
+            cat /etc/os-release | grep Alpine > /dev/null
+            if [ $? == 0 ]; then
+                marked_release="Alpine"
+            fi
+        fi
+        if [ "$marked_release" = "" ]; then
+            if [ -f "/etc/issue" ]; then
+                marked_release=$(cat /etc/issue | grep -v '^$' | awk '{print $1}')
+            else
+                marked_release="unknown"
+            fi
+        fi
+    elif [ "$unix_s" = "Darwin" ]; then
+        marked_release=$(sw_vers | grep ProductName | awk '{print $2" "$3" "$4}')
+    fi
+    echo $marked_release
+)
+unix_release=$(echo $unix_release | xargs)
+
+function echo_error() {
+    echo -e "${_red}$1${_reset}"
+}
+
+function echo_info() {
+    echo -e "${_green}$1${_reset}"
+}
+
+function install_test() {
+    which fswatch >/dev/null
+    if [ $? != 0 ]; then
+        operate_confirm "fswatch还没有安装，是否确认安装？" && install_fswatch
+    fi
+}
+function install_fswatch() {
+    if [ "$unix_s" = "Linux" ]; then
+        case $unix_release in
+        "Kali" | "Ubuntu" | "Debian" | "Raspbian" | 'Pop!_OS')
+            sudo apt-get install fswatch -y ;;
+        #"termux") pkg install $1 -y ;;
+        "CentOS")
+            curl -o fswatch.tgz https://download.fastgit.org/emcrisostomo/fswatch/releases/download/1.16.0/fswatch-1.16.0.tar.gz && \
+                tar -xzf fswatch.tgz && \
+                cd fswatch-1.16.0 && \
+                ./configure && \
+                make && \
+                sudo make install && \
+                cd .. && \
+                rm -rf fswatch.tgz fswatch-1.16.0
+                ;;
+        #"Alpine") apk add $1 ;;
+        *)
+            echo_error "不支持的 Linux 发行版：$unix_release"
+            exit 1
+            ;;
+        esac
+    elif [ "$unix_s" = "Darwin" ]; then
+        brew install fswatch
+    else
+        echo_error "不支持的操作系统：$unix_s"
+        exit 1
+    fi
+}
+function operate_confirm() {
+    echo -n $(echo_info "$1 [Y/n]  ")
+    read operate
+    operate=$(echo $operate | tr A-Z a-z)
+    if [[ "$operate" = "y" || "$operate" = "" ]]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+echo_info "当前系统：$unix_release"
+install_test
+if [ $? -ne 0 ]; then
+    exit 1
+else
+    echo_info "程序路径：$(which fswatch)"
+fi
+watch_dir="./src"
+if [ ! -d "$watch_dir" ]; then
+    echo_error "src目录不存在！"
+    exit 1
+else
+    echo_info "监听目录：$watch_dir"
+fi
+_pid=$(cat .daemon_pid | awk -F"\"pid\": " '{print $2}' | grep -v ^$ | sed 's/,//g')
+if [ "$_pid" = "" ]; then
+    echo_error "未检测到框架进程"
+    exit 1
+fi
+fswatch $watch_dir | while read file
+do
+    echo "Detect file change: $file"
+    kill -USR1 $_pid
+done

composer.json

@@ -1,33 +1,107 @@
 {
     "name": "zhamao/framework",
-    "description": "high-performance intelligent assistant",
-    "minimum-stability": "stable",
-    "license": "proprietary",
-    "version": "1.2.0",
+    "description": "High performance chat robot and web server development framework",
+    "license": "Apache-2.0",
     "authors": [
         {
-            "name": "whale",
-            "email": "crazysnowcc@gmail.com"
+            "name": "jerry",
+            "email": "admin@zhamao.me"
         },
         {
-            "name": "swift",
-            "email": "hugo_swift@yahoo.com"
+            "name": "sunxyw",
+            "email": "dev@sunxyw.xyz"
         }
     ],
     "require": {
-        "swoole/ide-helper": "@dev",
-        "ext-mbstring": "*",
-        "swlib/saber": "^1.0",
-        "doctrine/annotations": "<1.10.2",
+        "php": "^7.2 || ^7.3 || ^7.4 || ^8.0 || ^8.1",
         "ext-json": "*",
         "ext-posix": "*",
-        "ext-ctype": "*",
-        "ext-pcntl": "*"
+        "doctrine/dbal": "^2.13.1",
+        "dragonmantank/cron-expression": "^3.3",
+        "jelix/version": "^2.0",
+        "koriym/attributes": "^1.0",
+        "psr/container": "^2.0",
+        "psy/psysh": "^0.11.2",
+        "symfony/console": "~6.0 || ~5.0 || ~4.0 || ~3.0",
+        "symfony/polyfill-ctype": "^1.19",
+        "symfony/polyfill-mbstring": "^1.19",
+        "symfony/polyfill-php80": "^1.16",
+        "symfony/routing": "~6.0 || ~5.0 || ~4.0 || ~3.0",
+        "zhamao/config": "^1.0",
+        "zhamao/connection-manager": "^1.0",
+        "zhamao/console": "^1.0",
+        "zhamao/request": "^1.1"
     },
-    "repositories": {
-        "packagist": {
-            "type": "composer",
-            "url": "https://mirrors.aliyun.com/composer/"
+    "require-dev": {
+        "brainmaestro/composer-git-hooks": "^2.8",
+        "friendsofphp/php-cs-fixer": "^3.2 != 3.7.0",
+        "jetbrains/phpstorm-attributes": "^1.0",
+        "phpstan/phpstan": "^1.1",
+        "phpunit/phpunit": "^8.5 || ^9.0",
+        "roave/security-advisories": "dev-latest",
+        "swoole/ide-helper": "^4.5"
+    },
+    "suggest": {
+        "ext-ctype": "Use C/C++ extension instead of polyfill will be more efficient",
+        "ext-mbstring": "Use C/C++ extension instead of polyfill will be more efficient",
+        "ext-pdo_mysql": "If you use mysql in framework, you will need this extension",
+        "ext-redis": "If you use Redis in framework, you will need this extension",
+        "league/climate": "Display columns and status in terminal"
+    },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "autoload": {
+        "psr-4": {
+            "ZM\\": "src/ZM"
+        },
+        "files": [
+            "src/ZM/global_functions.php"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Module\\": "src/Module",
+            "Custom\\": "src/Custom",
+            "Tests\\": "tests"
         }
+    },
+    "bin": [
+        "bin/gendoc",
+        "bin/phpunit-swoole",
+        "bin/start"
+    ],
+    "config": {
+        "optimize-autoloader": true,
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
+    },
+    "extra": {
+        "hooks": {
+            "post-merge": "composer install",
+            "pre-commit": [
+                "echo committing as $(git config user.name)",
+                "composer cs-fix -- --diff"
+            ],
+            "pre-push": [
+                "composer cs-fix -- --dry-run --diff",
+                "composer analyse"
+            ]
+        },
+        "zm": {
+            "exclude-annotation-path": [
+                "src/ZM",
+                "tests"
+            ]
+        }
+    },
+    "scripts": {
+        "post-install-cmd": [
+            "[ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/cghooks add"
+        ],
+        "analyse": "phpstan analyse --memory-limit 300M",
+        "cs-fix": "php-cs-fixer fix",
+        "test": "bin/phpunit-swoole --no-coverage"
     }
 }

config/console_color.json

@@ -0,0 +1,29 @@
+{
+    "default": {
+        "success": "green",
+        "info": "lightblue",
+        "warning": "yellow",
+        "error": "red",
+        "verbose": "blue",
+        "debug": "gray",
+        "trace": "gray"
+    },
+    "white-term": {
+        "success": "green",
+        "info": "",
+        "warning": "yellow",
+        "error": "red",
+        "verbose": "blue",
+        "debug": "gray",
+        "trace": "gray"
+    },
+    "no-color": {
+        "success": "",
+        "info": "",
+        "warning": "",
+        "error": "",
+        "verbose": "",
+        "debug": "",
+        "trace": ""
+    }
+}

config/global.php

@@ -1,79 +1,152 @@
 <?php
-global $config;
 
-/** bind host */
+/** @noinspection PhpComposerExtensionStubsInspection */
+
+declare(strict_types=1);
+
+/* bind host */
 $config['host'] = '0.0.0.0';
 
-/** bind port */
+/* bind port */
 $config['port'] = 20001;
 
-/** 框架开到公网或外部的HTTP访问链接，通过 DataProvider::getFrameworkLink() 获取 */
-$config['http_reverse_link'] = "http://127.0.0.1:".$config['port'];
+/* 框架开到公网或外部的HTTP访问链接，通过 DataProvider::getFrameworkLink() 获取 */
+$config['http_reverse_link'] = 'http://127.0.0.1:' . $config['port'];
 
-/** 存放框架内文件数据的目录 */
-$config['zm_data'] = WORKING_DIR.'/zm_data/';
+/* 框架是否启动debug模式，当debug模式为true时，启用热更新（需要安装inotify扩展） */
+$config['debug_mode'] = false;
 
-/** 存放各个模块配置文件的目录 */
-$config['config_dir'] = $config['zm_data'].'config/';
+/* 存放框架内文件数据的目录 */
+$config['zm_data'] = realpath(WORKING_DIR) . '/zm_data/';
 
-/** 存放崩溃和运行日志的目录 */
-$config['crash_dir'] = $config['zm_data'].'crash/';
+/* 存放各个模块配置文件的目录 */
+$config['config_dir'] = $config['zm_data'] . 'config/';
 
-/** 对应swoole的server->set参数 */
+/* 存放崩溃和运行日志的目录 */
+$config['crash_dir'] = $config['zm_data'] . 'crash/';
+
+/* 对应swoole的server->set参数 */
 $config['swoole'] = [
-    'log_file' => $config['crash_dir'].'swoole_error.log',
-    'worker_num' => 1,
-    'dispatch_mode' => 2,
-    'task_worker_num' => 0
+    'log_file' => $config['crash_dir'] . 'swoole_error.log',
+    // 'worker_num' => swoole_cpu_num(), //如果你只有一个 OneBot 实例连接到框架并且代码没有复杂的CPU密集计算，则可把这里改为1使用全局变量
+    'dispatch_mode' => 2, // 包分配原则，见 https://wiki.swoole.com/#/server/setting?id=dispatch_mode
+    'max_coroutine' => 300000,
+    'max_wait_time' => 5,
+    // 'task_worker_num' => 4,
+    // 'task_enable_coroutine' => true
 ];
 
-/** MySQL数据库连接信息，host留空则启动时不创建sql连接池 */
-$config['sql_config'] = [
-    'sql_host' => '',
-    'sql_port' => 3306,
-    'sql_username' => 'name',
-    'sql_database' => 'db_name',
-    'sql_password' => '',
-    'sql_enable_cache' => true,
-    'sql_reset_cache' => '0300'
+/* 一些框架与框架运行时设置的调整 */
+$config['runtime'] = [
+    'swoole_coroutine_hook_flags' => SWOOLE_HOOK_ALL & (~SWOOLE_HOOK_CURL),
+    'swoole_server_mode' => SWOOLE_PROCESS,
+    'middleware_error_policy' => 1,
+    'reload_delay_time' => 800,
+    'global_middleware_binding' => [],
+    'save_console_log_file' => false, // 改为目标路径，则将 Console 输出的日志保存到文件
+    'annotation_reader_ignore' => [ // 设置注解解析器忽略的注解名或命名空间，防止解析到不该解析的
+        'name' => [
+            'mixin',
+        ],
+        'namespace' => [],
+    ],
 ];
 
-/** CQHTTP连接约定的token */
-$config["access_token"] = "";
+/* 轻量字符串缓存，默认开启 */
+$config['light_cache'] = [
+    'size' => 512,                       // 最多允许储存的条数（需要2的倍数）
+    'max_strlen' => 32768,               // 单行字符串最大长度（需要2的倍数）
+    'hash_conflict_proportion' => 0.6,   // Hash冲突率（越大越好，但是需要的内存更多）
+    'persistence_path' => $config['zm_data'] . '_cache.json',
+    'auto_save_interval' => 900,
+];
 
-/** HTTP服务器固定请求头的返回 */
+/* 大容量跨进程变量存储（2.2.0可用） */
+$config['worker_cache'] = [
+    'worker' => 0,
+    'transaction_timeout' => 30000,
+];
+
+/* MySQL数据库连接信息，host留空则启动时不创建sql连接池 */
+$config['mysql_config'] = [
+    'host' => '',
+    'port' => 3306,
+    'unix_socket' => null,
+    'username' => 'root',
+    'password' => '123456',
+    'dbname' => '',
+    'charset' => 'utf8mb4',
+    'pool_size' => 64,
+    'options' => [
+        PDO::ATTR_STRINGIFY_FETCHES => false,
+        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
+    ],
+];
+
+/* Redis连接信息，host留空则启动时不创建Redis连接池 */
+$config['redis_config'] = [
+    'host' => '',
+    'port' => 6379,
+    'timeout' => 1,
+    'db_index' => 0,
+    'auth' => '',
+];
+
+/* onebot连接约定的token */
+$config['access_token'] = '';
+
+/* HTTP服务器固定请求头的返回 */
 $config['http_header'] = [
-    'X-Powered-By' => 'zhamao-framework',
-    'Content-Type' => 'text/html; charset=utf-8'
+    'Server' => 'zhamao-framework',
+    'Content-Type' => 'text/html; charset=utf-8',
 ];
 
-/** HTTP服务器在指定状态码下回复的页面（默认） */
+/* HTTP服务器在指定状态码下回复的页面（默认） */
 $config['http_default_code_page'] = [
-    '404' => '404.html'
+    '404' => '404.html',
 ];
 
-/** zhamao-framework在框架启动时初始化的atomic们 */
+/* zhamao-framework在框架启动时初始化的atomic们 */
 $config['init_atomics'] = [
-    'in_count' => 0,        //消息接收message的统计数量
-    'out_count' => 0,       //消息发送（调用send_*_msg的统计数量）
-    'reload_time' => 0,     //调用reload功能统计数量
-    'wait_msg_id' => 0,     //协程挂起id自增
-    'info_level' => 2,      //终端显示的log等级
+    // 'custom_atomic_name' => 0, //自定义添加的Atomic
 ];
 
-/** 自动保存的缓存保存时间（秒） */
-$config['auto_save_interval'] = 900;
+/* 终端日志显示等级（0-4） */
+$config['info_level'] = 2;
 
-/** 上下文接口类 implemented from ContextInterface */
+/* 上下文接口类 implemented from ContextInterface */
 $config['context_class'] = \ZM\Context\Context::class;
 
-/** 静态文件访问 */
+/* 静态文件访问 */
 $config['static_file_server'] = [
     'status' => false,
-    'document_root' => WORKING_DIR . '/resources/html',
+    'document_root' => realpath(__DIR__ . '/../') . '/resources/html',
     'document_index' => [
-        'index.html'
-    ]
+        'index.html',
+    ],
+];
+
+/* 机器人解析模块，关闭后无法使用如CQCommand等注解(上面的modules即将废弃) */
+$config['onebot'] = [
+    'status' => true,
+    'single_bot_mode' => false,
+    'message_level' => 99,
+    'message_convert_string' => true,
+    'message_command_policy' => 'interrupt',
+];
+
+/* 一个远程简易终端，使用nc直接连接即可，但是不建议开放host为0.0.0.0(远程连接) */
+$config['remote_terminal'] = [
+    'status' => false,
+    'host' => '127.0.0.1',
+    'port' => 20002,
+    'token' => '',
+];
+
+/* 模块(插件)加载器的相关设置 */
+$config['module_loader'] = [
+    'enable_hotload' => false,
+    'load_path' => $config['zm_data'] . 'modules',
 ];
 
 return $config;

config/motd.txt

@@ -0,0 +1,6 @@
+   ______
+  |__  / |__   __ _ _ __ ___   __ _  ___
+    / /| '_ \ / _` | '_ ` _ \ / _` |/ _ \
+   / /_| | | | (_| | | | | | | (_| | (_) |
+  /____|_| |_|\__,_|_| |_| |_|\__,_|\___/
+

docs/.vuepress/api.js

@@ -0,0 +1 @@
+module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/GoCqhttpAPIV11","ZM/API/ZMRobot","ZM/API/CQ","ZM/API/TuringAPI","ZM/API/OneBotV11"]},{"title":"ZM/API/Proxies/Bot","collapsable":true,"children":["ZM/API/Proxies/Bot/AbstractBotProxy","ZM/API/Proxies/Bot/AllGroupsProxy","ZM/API/Proxies/Bot/AllBotsProxy"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModulePackCommand","ZM/Command/Module/ModuleListCommand"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/Container","ZM/Container/WorkerContainer","ZM/Container/BoundMethod"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/Table","ZM/DB/SelectBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventTracer","ZM/Event/EventDispatcher","ZM/Event/EventManager"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnTask","ZM/Event/SwooleEvent/OnMessage"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModulePacker","ZM/Module/ModuleUnpacker","ZM/Module/ModuleBase"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLStatementWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCache","ZM/Store/ZMAtomic","ZM/Store/LightCacheInside"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/ReflectionUtil","ZM/Utils/HttpUtil","ZM/Utils/DataProvider","ZM/Utils/ZMUtil","ZM/Utils/SignalListener","ZM/Utils/CommandInfoUtil","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}]

docs/.vuepress/components/ChatBox.vue

@@ -0,0 +1,141 @@
+<template>
+<div class="doc-chat-container">
+  <div class="doc-chat-content">
+    <div v-for="i in chat" v-bind="i">
+      <div class="doc-chat-row" v-if="i.type === 0">
+        <div class="doc-chat-box">{{ i.content }}</div>
+        <img class="doc-chat-avatar" src="https://api.btstu.cn/sjtx/api.php"  alt=""/>
+      </div>
+      <div class="doc-chat-row doc-chat-row-robot" v-else-if="i.type === 1">
+        <img class="doc-chat-avatar" src="https://docs-v1.zhamao.xin/logo.png" alt=""/>
+        <div class="doc-chat-box doc-chat-box-robot">
+          <span v-for="(p,index) in i.content.split('\n')">{{p}}<br v-if="index !== i.content.length - 1"></span>
+        </div>
+      </div>
+      <div class="doc-chat-row doc-chat-banner" v-else-if="i.type === 2">
+        {{ i.content }}
+      </div>
+      <div class="doc-chat-row doc-chat-row-robot" v-else-if="i.type === 3">
+        <img class="doc-chat-avatar" src="https://docs-v1.zhamao.xin/logo.png" alt=""/>
+        <div class="doc-chat-box doc-chat-box-robot">
+          <img :src="i.content" alt="" />
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+</template>
+
+<!--
+type:
+  0: 我方发送消息
+  1: 机器人回复消息
+  2: 显示一个横幅系统消息
+  3: 机器人回复一个图片
+-->
+
+<script>
+export default {
+  name: "ChatBox",
+  props: ['myChats'],
+  data() {
+    return {
+      chat: this.myChats,
+      multiline: ''
+    }
+  }
+}
+</script>
+
+<style scoped>
+.doc-chat-content {
+  padding: 12px;
+}
+.doc-chat-container {
+  border-radius: 6px;
+  max-width: 550px;
+  min-height: 30px;
+  /*noinspection CssUnresolvedCustomProperty*/
+  background-color: #f2f4f5;
+
+  margin-bottom: 1em;
+  box-shadow: 0 3px 1px -2px rgba(0,0,0,.2), 0 2px 2px 0 rgba(0,0,0,.14), 0 1px 5px 0 rgba(0,0,0,.12);
+}
+
+.doc-chat-row {
+  margin: 0;
+  display: flex;
+  flex-wrap: wrap;
+  flex: 1 1 auto;
+  justify-content: flex-end;
+}
+
+.doc-chat-banner {
+  justify-content: center;
+  background: rgba(0,0,0,0.1);
+  width: max-content;
+  margin: 8px auto;
+  padding: 4px 14px;
+  border-radius: 8px;
+  color: gray;
+  font-size: 14px;
+}
+
+.doc-chat-row-robot {
+  justify-content: flex-start !important;
+}
+
+.doc-chat-box {
+  color: #000000de;
+  position: relative;
+  width: fit-content;
+  max-width: 55%;
+  border-radius: .5rem;
+  padding: .4rem .6rem;
+  margin: .4rem .8rem;
+  background-color: #fff;
+  line-height: 1.5;
+  font-size: 16px;
+  outline: none;
+  overflow-wrap: break-word;
+  white-space: normal;
+  box-shadow: 0 2px 12px 0 rgba(0,0,0,.1);
+}
+
+.doc-chat-box:after {
+  content: "";
+  position: absolute;
+  right: auto;
+  top: 0;
+  width: 8px;
+  height: 12px;
+  color: #fff;
+  border: 0 solid transparent;
+  border-bottom: 7px solid;
+  border-radius: 0 0 8px 0;
+  left: calc(100% - 4px);
+  box-sizing: inherit;
+}
+
+.doc-chat-box-robot:after {
+  content: "";
+  position: absolute;
+  right: calc(100% - 4px);
+  top: 0;
+  width: 8px;
+  height: 12px;
+  color: #fff;
+  border: 0 solid transparent;
+  border-bottom: 7px solid;
+  border-radius: 0 0 0 8px;
+  left: auto;
+  box-sizing: inherit;
+}
+
+.doc-chat-avatar {
+  background-color: aquamarine;
+  width: 36px !important;
+  height: 36px !important;
+  border-radius: 18px;
+}
+</style>

docs/.vuepress/config.js

@@ -0,0 +1,192 @@
+const apiConfig = require('./api')
+
+module.exports = {
+    title: '炸毛框架',
+    description: '一个高性能聊天机器人 + Web 框架',
+    theme: 'antdocs',
+    markdown: {
+        lineNumbers: true
+    },
+    head: [
+        ['link', { rel: 'icon', href: '/logo_trans.png' }],
+        ['script', {}, `
+        var _hmt = _hmt || [];
+(function () {
+    var hm = document.createElement("script");
+    hm.src = "https://hm.baidu.com/hm.js?f0f276cefa10aa31a20ae3815a50b795";
+    var s = document.getElementsByTagName("script")[0];
+    s.parentNode.insertBefore(hm, s);
+})();
+    `]
+    ],
+    themeConfig: {
+        repo: 'zhamao-robot/zhamao-framework',
+        logo: '/logo_trans.png',
+        docsDir: 'docs',
+        editLinks: true,
+        lastUpdated: '上次更新',
+        activeHeaderLinks: false,
+        nav: [
+            { text: '指南', link: '/guide/' },
+            { text: '事件和注解', link: '/event/' },
+            { text: '组件', link: '/component/' },
+            { text: '进阶', link: '/advanced/' },
+            { text: 'API', link: '/api/' },
+            { text: 'FAQ', link: '/faq/' },
+            { text: '更新日志', link: '/update/v2/' },
+            { text: '炸毛框架 v1', link: 'https://docs-v1.zhamao.xin/' }
+        ],
+        sidebar: {
+            '/guide/': [
+                {
+                    title: '指南',
+                    collapsable: false,
+                    sidebarDepth: 1,
+                    children: [
+                        '',
+                        'installation',
+                        'quickstart-robot',
+                        'quickstart-http',
+                        'onebot-choose',
+                        'basic-config',
+                        'write-module',
+                        'register-event',
+                        'upgrade',
+                        'errcode'
+                    ]
+                }
+            ],
+            '/event/': [
+                {
+                    title: '事件和注解',
+                    collapsable: false,
+                    sidebarDepth: 1,
+                    children: [
+                        '',
+                        'robot-annotations',
+                        'route-annotations',
+                        'framework-annotations',
+                        'middleware',
+                        'custom-annotations',
+                        'event-dispatcher'
+                    ]
+                }
+            ],
+            '/component/': [
+                '',
+                {
+                    title: '聊天机器人组件',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'bot/robot-api-12',
+                        'bot/robot-api',
+                        'bot/cqcode',
+                        'bot/message-util',
+                        'bot/access-token',
+                        'bot/turing-api',
+                        'bot/help-generator.md',
+                    ]
+                },
+                {
+                    title: '存储组件',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'store/light-cache',
+                        'store/mysql',
+                        'store/mysql-db',
+                        'store/redis',
+                        'store/atomics',
+                        'store/spin-lock',
+                        'store/data-provider'
+                    ]
+                },
+                {
+                    title: '通用组件',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'common/context',
+                        'common/coroutine-pool',
+                        'common/singleton-trait',
+                        'common/zmutil',
+                        'common/global-functions',
+                        'common/console',
+                        'common/task-worker',
+                        'common/remote-terminal',
+                        'common/event-tracer'
+                    ]
+                },
+                {
+                    title: 'HTTP 组件',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'http/zmrequest',
+                        'http/route-manager'
+                    ]
+                },
+                {
+                    title: '模块/插件管理',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'module/module-pack',
+                        'module/module-unpack'
+                    ]
+                }
+            ],
+            '/advanced/': [
+                '',
+                {
+                    title: '框架高级开发',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'framework-structure',
+                        'custom-start',
+                        'manually-install',
+                        'inside-class',
+                        'multi-process',
+                        'task-worker'
+                    ]
+                },
+                {
+                    title: '开发实战教程',
+                    collapsable: true,
+                    sidebarDepth: 2,
+                    children: [
+                        'connect-ws-client',
+                        'example/admin',
+                        'example/integrate-qingyunke-chatbot',
+                        'example/weather-bot'
+                    ]
+                },
+            ],
+            '/api/': apiConfig,
+            '/faq/': [
+                '',
+                'to-v2',
+                'usual-question',
+                'address-already-in-use',
+                'display-deadlock',
+                'light-cache-wrong',
+                'wait-message-cqbefore'
+            ],
+            '/update/': [
+                {
+                    title: '更新日志',
+                    collapsable: true,
+                    sidebarDepth: 0,
+                    children: [
+                        'v2',
+                        'v1',
+                        'build-update'
+                    ]
+                },
+                'config'
+            ]
+        }
+    }
+}

docs/.vuepress/public/CNAME

@@ -0,0 +1 @@
+framework.zhamao.me

docs/.vuepress/public/robots.txt

@@ -0,0 +1 @@
+User-agent: *

docs/.vuepress/styles/palette.less

@@ -0,0 +1 @@
+@accentColor: #3665aa;

docs/CNAME

@@ -0,0 +1 @@
+docs-v2.zhamao.me

docs/README.md

@@ -0,0 +1,39 @@
+---
+home: true
+heroImage: ./logo_trans.png
+actionBtn:
+  text: 快速上手
+  link: /guide/
+  type: primary
+  size: large
+features:
+- title: 高性能
+  details: 基于 PHP 的 Swoole 高性能扩展，利用 WebSocket 进行与 OneBot 协议兼容的聊天机器人软件的通信，还有数据库连接池、内存缓存、多任务进程等特色，大幅增强性能。
+- title: 易于开发
+  details: 所有功能采用模块化设计，除特殊情况外几乎所有功能都不需要修改框架内任意代码，框架采用灵活的注解进行各类事件绑定，同时支持下断点调试。
+- title: 接口直观
+  details: 支持命令、普通文本、正则匹配、自然语言处理等多种对话解析方式，利用协程巧妙实现了直观的交互式会话模式，同时支持多种富文本的处理。
+footer: |
+  Apache-2.0 Licensed &nbsp;|&nbsp; Copyright © 2019-2022 Zhamao Developer Team &nbsp;|&nbsp; <a href="http://beian.miit.gov.cn">沪ICP备2021010446号-1</a>
+---
+
+# 快速上手
+
+## 安装框架和环境
+
+此命令可一键以模板安装框架！（仅限 Linux 和 macOS）
+
+```bash
+bash <(curl -fsSL https://zhamao.xin/go.sh)
+```
+
+## 运行框架
+
+```bash
+cd zhamao-app/
+./zhamao server
+```
+
+## 效果图
+
+![index_demo](/index_demo.png)

docs/advanced/README.md

@@ -0,0 +1,4 @@
+# 进阶开发
+在本章，下面的部分将详细说明一些具体的案例和自定义框架的操作。
+
+> 更多进阶教程敬请期待....（或者你可以选择提 Issue 到框架 GitHub，有需求就写入文档）

docs/advanced/connect-ws-client.md

@@ -0,0 +1,144 @@
+# 接入 WebSocket 客户端
+
+炸毛框架其实从本质上讲，就是一个 HTTP + WebSocket 服务器，所以框架也支持对接其他任何 HTTP 客户端和 WebSocket 客户端，实际上炸毛框架非常适合用 WebSocket 做在线的 IM 聊天通讯，也可以方便地进行 WS 通信。这里主要说明如何对接一个自定义的 WebSocket 客户端。
+
+## 类型指定
+
+由于 WebSocket 连接都具有同样的性质，没有状态，所以在建立 WebSocket 连接的时候，需要客户端表明自己的身份和类型。指定客户端连接类型的方式有两种：
+
+- `GET` 参数传递，在连接的时候，加上 GET 参数 `type` 即可。比如 js 中 WebSocket 建立时地址写：`ws://127.0.0.1:20001/?type=foo`，这时传入的连接就是 `foo` 类型。
+- `Header` 传递，用户需要在建立连接时指定 HTTP 的头部信息 `X-Client-Role`，例如 `X-Client-Role: foo`，这时传入的连接就是 `foo` 类型。
+
+以上两种方式，`Header` 方式比 `GET` 方式优先级要高，如果两者均没有指定，框架会将此连接当作 `default` 类型接入。
+
+::: tip 提示
+
+对于对接 OneBot 标准的机器人客户端，只要符合 OneBot 标准，即 `X-Client-Role` 会自动带上 `universal`、`qq` 等字样，就会自动标记为 `qq` 类型。
+
+:::
+
+## 逻辑编写
+
+传入连接后，我们就能通过注解事件绑定来做我们自己想做的事情了！比如下方是传入类型为 foo 连接要做的事情
+
+```php
+<?php
+namespace Module\Example;
+use ZM\Annotation\Swoole\OnOpenEvent;
+use ZM\Console\Console;
+use ZM\ConnectionManager\ConnectionObject;
+class Hello {
+	/**
+ 	 * @OnOpenEvent("foo")
+ 	 */
+	public function onFooConnect(ConnectionObject $conn) {
+	    Console::info($conn->getName()." 已连接！");
+	}
+```
+
+以上作用就是在终端输出 `foo 已连接！` 这个提示的。关于 `ConnectionObject` 对象，见下方。
+
+## WS 连接对象
+
+对于每一个 WebSocket 连接，框架内都有一个专属的操作类，有获取类型名称、保存链接参数和属性以及获取文件标识符等功能。
+
+### getFd()
+
+获取文件标示符，用于发送消息、接收消息等。这个参数获取的 `fd` 是 Swoole 指定的，用于发送信息等。
+
+```php
+$fd = $conn->getFd();
+server()->send($fd, "hello world");
+```
+
+> WebSocket 是全双工的，所以发送和接收其实是互不干扰的，你可以不仅仅在 WebSocket 相关的上下文中，还可以比如在 HTTP 或者机器人上下文中给别的 WebSocket 客户端发请求。
+
+### getName()
+
+获取连接对象绑定的连接类型，例如上方提到的 `foo`、`default` 等。
+
+```php
+Console::info("当前连接类型：".$conn->getName()); //当前连接类型：foo
+```
+
+### setName()
+
+改变连接对象绑定的连接类型，例如从 `foo` 改为 `bar`。
+
+```php
+$s = $conn->getName(); // foo
+$conn->setName("bar");
+$s = $conn->getName(); // bar
+```
+
+### getOptions()
+
+获取此连接存储的所有参数，以数组形式。存储内容见下方 `setOption()`。
+
+格式：`["参数1" => {参数1的值}, "参数2" => {参数2的值}]`
+
+### getOption()
+
+获取此连接存储的参数，获取指定名称的，此方法拥有一个参数 `$key`，指定即可获取。
+
+如果没有对应参数，则返回 `null`。
+
+我们在前面的机器人部分知道，框架主要是用于机器人的连接，那么机器人客户端在连接后，比如我们想知道这个机器人的 WS 连接对应的是哪个 QQ 号的机器人，我们就可以用 `getOption("connect_id")` 来获取。这个 `connect_id` 是 OneBot 标准的客户端接入后自动填入的一个参数。例如，我们想在机器人接入后打出接入机器人的 QQ 号：
+
+```php
+/**
+ * @OnOpenEvent("qq")
+ */
+public function onQQConnect($conn) {
+    Console::success("机器人 ".$conn->getOption("connect_id")." 已连接！"); // 机器人 123456 已连接！
+}
+```
+
+### setOption()
+
+设置连接存储的参数。参数：`setOption($key, $value)`。`$key` 限定为 `connect_id` 一种。（因为目前有了 LightCache，所以这里暂时不提供别的 key 设定）
+
+```php
+$conn->setOption("connect_id", "asdasdasd"); // $value 最长长度为 29
+```
+
+## 发送到 WebSocket 客户端
+
+很简单，从上面获取到 `fd` 后使用下面的方式就可以了～
+
+```php
+server()->push($conn->getFd(), "hello"); // 第二个为 string 类型的参数
+```
+
+## 从客户端接收
+
+接收消息必须从 `@OnMessageEvent` 注解事件下接收，使用上下文 `ctx()->getFrame()` 获取消息帧。
+
+从这里获取的 `Frame` 对象，见 [Swoole 文档 - Frame](https://wiki.swoole.com/#/websocket_server?id=swoolewebsocketframe)。
+
+Frame 对象有四个参数：
+
+- `$frame->fd`：获取发来帧的 fd
+- `$frame->data`：数据本体
+- `$frame->opcode`：数据类型 int 值，见 [Swoole 文档 - 数据帧类型](https://wiki.swoole.com/#/websocket_server?id=%e6%95%b0%e6%8d%ae%e5%b8%a7%e7%b1%bb%e5%9e%8b)
+- `$frame->finish`：是否发送完毕，bool
+
+下面以接收一个 json 字符串为例，并进行后续的解析：
+
+```php
+/**
+ * @OnMessageEvent("foo")
+ */
+public function onMessage() {
+    $frame = ctx()->getFrame();
+    $json_str = $frame->data; // 假设传入的是 {"key1":"value1","k2":"v2"}
+    $json = json_decode($json_str, true);
+    Console::info("key1 的值是:" . $json["key1"]);
+}
+```
+
+## 关闭连接
+
+```php
+server()->close($conn->getFd());
+```

docs/advanced/custom-start.md

@@ -0,0 +1,136 @@
+# 框架高级启动
+
+## 框架下载方式
+
+从前面的几章中，我们了解到框架有多种下载到本地的方式。
+
+- Composer 依赖模式
+- Starter 从模板创建模式（等同于 Composer 模式）
+- 源码模式
+- Phar Composer 依赖模式
+- Phar 源码模式
+
+### Composer 依赖模式
+
+从 Composer 依赖加载框架是一种拉取框架的方式，这种方式的优点在于，你可以直观地感受到是如何使用框架从零开始一个完整的项目的过程。
+
+从 Composer 依赖的启动步骤：
+
+```bash
+mkdir my-bot # 新建一个空的文件夹
+cd my-bot/
+composer require zhamao/framework # 从 composer 拉取后会自动部署 autoload 和 composer.json 等内容
+
+# 使用命令初始化框架
+vendor/bin/start init
+
+# 启动框架
+vendor/bin/start server
+```
+
+注意：使用 `init` 命令时，会给当前目录解压以下文件：
+
+```php
+$extract_files = [
+    "/config/global.php",							// 全局配置文件
+    "/.gitignore",									// git 排除文件
+    "/config/file_header.json",						// HTTP 文件头
+    "/config/console_color.json",					// 终端颜色主题文件
+    "/config/motd.txt",								// 框架启动时自定义的 motd
+    "/src/Module/Example/Hello.php",				// 框架自带的示例模块
+    "/src/Module/Middleware/TimerMiddleware.php",	// 框架自带的函数运行时间监控中间件
+    "/src/Custom/global_function.php"				// 用户可在这里自定义编写自己的全局函数
+];
+```
+
+经过 init 解压这些文件后，你的框架就能正常运行且开始编写代码了！
+
+### Starter 模板模式
+
+从模板新建其实原理和 Composer 依赖模式完全一样，只不过，这个过程是使用模板仓库新建的项目，使用 Composer 自带的 `create-project` 方式创建的。starter 也是一个 GitHub 项目，见 [地址](https://github.com/zhamao-robot/zhamao-framework-starter)。
+
+```bash
+composer create-project zhamao/framework-starter my-bot/ # my-bot 是你自定义的文件夹名称，和上方相同
+cd my-bot
+vendor/bin/start server # 启动框架
+```
+
+Starter 模式相当于直接从 GitHub 拉取 `zhamao-framework-starter` 项目，然后执行 `composer update`。
+
+那和 Composer 依赖模式有什么区别呢？没区别！构建出来的框架和文件是一模一样的！使用 Composer 依赖模式，使用 `init` 命令后，文件会和 `zhamao-framework-starter` 仓库拉取回来的模板一模一样！（或者换句话说，这个仓库就是使用 `init` 命令生成的文件的）
+
+那使用哪种好呢？看你自己！如果你想给你自己的已有项目套上炸毛框架，那么就推荐使用 Composer 依赖模式，如果是从 0 开始编写框架模块，则推荐使用模板模式。
+
+### 源码模式
+
+源码模式和以上两种方案都不一样，源码模式允许你对框架本身进行一系列修改，框架本体就可以直接运行。
+
+Composer 依赖模式（以及模板模式）和源码模式的区别是：
+
+- 依赖模式和模板模式是通过 library 方式引入框架的，框架本身会放在 composer 的 `vendor/` 目录下，从 composer 引入的 library 相当于子集，vendor 目录下的文件最好不要手动修改（应该都知道吧），所以框架本身也只是加载了进来。
+- 源码模式相当于直接从框架源码目录运行框架和模块，框架源码都在 `src/ZM` 目录下，默认的示例模块都在 `src/Module` 下，是同级目录。而此时的 `vendor/` 目录只包含了框架依赖的外部组件，例如注解解析器和 psysh 等。
+
+源码模式可以方便地调试和修改框架本身，拉取方式很简单，用 `git clone` 或从 GitHub 下载最新版的源码包解压即可。
+
+```bash
+git clone https://github.com/zhamao-robot/zhamao-framework.git
+cd zhamao-framework/
+bin/start server # 第一次运行时会提示一个“框架源码模式需要在autoload文件中添加Module目录为自动加载”
+composer update # 更新 autoload 文件，应用刚才上一步添加的 `src/Module` 文件夹下的模块自动加载
+bin/start server # 通过源码模式启动框架
+```
+
+## 框架启动参数
+
+框架启动时可以根据实际情况指定启动参数。
+
+- `--debug-mode`：启用调试模式，调试模式的作用是关闭一键协程化和终端交互，减少 Swoole 本身对代码逻辑的干扰（比如执行 `shell_exec()` 报错的话可以开启这个进行调试）。
+- `--log-{mode}`：设置 log 等级。支持 `--log-debug`，`--log-verbose`，`--log-info`，`--log-warning`，`--log-error`。
+- `--log-theme`：设置终端信息的主题。这个选项适用于多种终端信息显示的兼容，例如白色终端和不支持颜色的终端。详见 [Console - 主题设置](/component/console/#_2)。
+- `--disable-coroutine`：关闭一键协程化。
+- `--remote-terminal`：开启 nc 远程终端，配置文件使用全局中的 `remote_terminal` 项。也可以在全局配置中常开启（status 设置为 true）。
+- `--daemon`：以守护进程方式运行框架，此参数将直接在输出 motd 后将进程挂到 init 下运行，后台常驻。
+- `--watch`：监控 `src/` 目录下的文件变化，有变化则自动重新载入代码。开启监控需要安装 PHP 扩展：inotify。使用 pecl 就可以安装：`pecl install inotify`。（注：不支持 WSL 和 macOS）
+- `--env`：设置运行环境，设置运行环境后将优先加载指定环境的配置文件，支持 `--env=production`，`--env=staging`，`--env=development`，见 [基本配置](/guide/basic-config/#_2)。
+- `--worker-num`：指定运行的工作进程数量（并不是越多越好，框架默认为 CPU 核心数），例如 `--worker-num=8`。
+- `--task-worker-num`：启用 TaskWorker 进程并指定数量。
+- `--show-php-ver`：在启动时显示 Swoole 和 PHP 的版本。
+
+## 守护进程操作命令
+
+守护进程在 2.2.0 版本开始，可以使用命令行快速操作，如重启、停止、查看状态等。
+
+注意，这里的守护进程操作命令是指 **使用 `--daemon` 方式启动的框架**，如使用 Docker、screen、tmux、systemd 等方式挂后台跑则此命令不可用！
+
+```bash
+vendor/bin/start daemon:status # 查看守护进程的状态
+vendor/bin/start daemon:reload # 重载框架
+vendor/bin/start daemon:stop # 停止运行守护进程的框架
+```
+
+## 独立启动其他组件
+
+框架默认不止启动框架的 `server` 命令，还有 `init` 命令和 `simple-http-server` 命令。`init` 命令在上方 Composer 依赖模式中提到过，就是初始化各个文件的。
+
+### 独立 HTTP 文件服务器
+
+如果你只需要一个静态文件服务器，类似 Nginx，那么框架也支持。
+
+```bash
+vendor/bin/start simple-http-server your-web-dir/ --host=0.0.0.0 --port=8080
+```
+
+-  `your-web-dir` 是必填的参数。
+- `--host` 和 `--port` 是可选参数，如果不填，则默认使用 `global.php` 配置文件中的配置。
+
+### 检查配置是否更新
+
+默认情况下（非源码模式），你可以使用命令 `vendor/bin/start check:config` 来检查你的配置文件是否需要更新部分段落。
+
+### systemd 配置文件生成器
+
+框架支持生成 systemd 配置文件 `zhamao.service`，生成后将文件放入 `/etc/systemd/system` 后输入 `systemctl enable zhamao.service` 即可。
+
+命令：`vendor/bin/start systemd:generate`
+
+注意，systemd 启动的守护进程模式和使用参数 `--daemon` 不一样，请勿同时混用，直接使用上述命令生成的配置文件即可正常使用！

docs/advanced/example/admin.md

@@ -0,0 +1,229 @@
+# 编写管理员专属功能
+
+众所周知，如果大家使用炸毛框架来开发聊天机器人的话，会比较方便。但是有些地方你一定会感觉还是欠缺了点，比如下面这样，你想编写一个只能由机器人管理员，也就是你自己，才能触发的功能：
+
+```php
+/**
+ * @CQCommand(match="禁言",message_type="group")
+ */
+public function banSomeone() {
+    $r1 = ctx()->getNextArg("请输入禁言的人或at他");
+    $r2 = ctx()->getFullArg("请输入禁言的时间（秒）");
+    $cq = CQ::getCQ($r1);
+    if ($cq !== null) {
+        if ($cq["type"] != "at") return "请at或者输入正确的QQ号！";
+        $r1 = $cq["params"]["qq"];
+    }
+    // 群内禁言用户
+    ctx()->getRobot()->setGroupBan(ctx()->getGroupId(), $r1, $r2);
+    return "禁言成功！";
+}
+```
+
+这时候，如果只是自己有绝对的权利，可以将自己的 QQ 号写死在注解 `@CQCommand` 中，并限定 `user_id`（假设我的 QQ 号码为 123456）：
+
+```php
+/**
+ * @CQCommand(match="禁言",message_type="group",user_id=123456)
+ */
+```
+
+但是，随着时间的推移，你的机器人伙伴群可能越来越大，这个命令可能不止需要绝对的你来使用，你还要将机器人的部分权利下发给更多的伙伴，怎么办呢？注解里面只能写死的。
+
+答案很简单，这时候我们就需要用到框架提供的中间件（Middleware）。中间件说白了就是在事件执行前、后、过程中抛出的异常对其进行阻断和插入代码，比如我们上方在触发禁言这个注解事件前首先要判断执行这个命令的是不是钦定的管理员。
+
+## 第一步：定义中间件
+
+首先，我们需要定义一个中间件。在框架默认提供的脚手架中，包含了一个叫 `TimerMiddleware.php` 的示例中间件，这个示例中间件的目的是非常简单的，就是判断这个注解事件运行了多长时间。假设你有一个机器人功能，这个功能下的代码需要执行很长时间，可以使用这一注解轻松将事件执行的时间打印到终端上。
+
+关于中间件的有关说明，见 [中间件](/event/middleware)。
+
+下面我们假设你已经阅读过中间件注解的文档了，我们着手编写一个判断指令执行者是否是指定的管理员 QQ 的中间件。为了省事和让大家方便地复现，我先在脚手架下的目录 `src/Module/Middleware/` 下新建 PHP 类文件 `AdminMiddleware.php`（和 `TimerMiddleware.php` 在同一个目录）。
+
+```php
+<?php
+
+namespace Module\Middleware;
+
+use ZM\Annotation\Http\HandleBefore;
+use ZM\Annotation\Http\MiddlewareClass;
+use ZM\Exception\ZMException;
+use ZM\Http\MiddlewareInterface;
+use ZM\Store\LightCache;
+
+/**
+ * Class AdminMiddleware
+ * 示例中间件：用于动态管理一些管理员指令的中间件
+ * @package Module\Middleware
+ * @MiddlewareClass("admin")
+ */
+class AdminMiddleware implements MiddlewareInterface
+{
+    /**
+     * @HandleBefore()
+     * @return bool
+     * @throws ZMException
+     */
+    public function onBefore(): bool {
+        $r = ctx()->getUserId(); // 从上下文获取发消息的用户 QQ
+        $admin_list = LightCache::get("admin_list") ?? []; // 从轻量缓存获取管理员列表
+        return in_array($r, $admin_list); // 返回这个 QQ 是否在管理员列表中
+    }
+}
+```
+
+其中，`@MiddlewareClass("admin")` 的意思是，定义这个类为名字叫 `admin` 的中间件，同时，所有中间件的类**必须**带上 `implements MiddlewareInterface`，统一接口形式。
+
+`@HandleBefore()` 代表的是，这个类下的这个函数（onBefore）被标注为这个中间件的 `onBefore` 事件，也就是说，如果有别的注解事件插入了这个 `admin` 中间件，那么执行对应注解事件前都要执行一下 `@HandleBefore` 所绑定的这个函数。而这个绑定的函数只能返回 `bool` 类型的值哦！
+
+## 第二步：使用中间件
+
+使用中间件很简单，在需要阻断的注解事件绑定的函数上再加一个注解就好了！我们以上方的禁言例子说明：
+
+```php
+/**
+ * @Middleware("admin")
+ * @CQCommand(match="禁言",message_type="group")
+ */
+```
+
+<chat-box :my-chats="[
+    {type:0,content:'禁言 1234567 600'},
+    {type:1,content:'禁言成功！'},
+    {type:2,content:'假设我不在管理员名单里'},
+    {type:0,content:'禁言 1234567 900'},
+    {type:2,content:'机器人没有回复，因为中间件返回了 false，不继续执行'},
+]"></chat-box>
+
+而这时候有朋友又要问了，如果我有一系列管理员命令，假设都在一个叫 `AdminFunc.php` 的模块类里，我是不是还得一个一个地给注解事件写 `@Middleware("admin")` 呢？当然不需要！如果你这个类所有的注解事件都是机器人的聊天事件（`@CQCommand`，`@CQMessage`）的话，可以直接给类注解这个中间件，效果等同于给每一个函数写一次中间件注解。
+
+```php
+<?php
+
+namespace Module\Example;
+
+use ZM\Annotation\Http\Middleware;
+
+/**
+ * Class AdminFunc
+ * @package Module\Example
+ * @Middleware("admin")
+ */
+class AdminFunc
+{ 
+    // ...这里是你的一堆注解事件的函数
+}
+```
+
+## 第三步：补全代码
+
+上面我们讲到了，中间件里面使用了 `LightCache` 轻量缓存来储存临时的管理员列表，那么我们将这部分的代码完善吧！
+
+**src/Module/Example/AdminFunc.php**
+
+```php
+<?php
+
+namespace Module\Example;
+
+use ZM\Annotation\CQ\CQCommand;
+use ZM\Annotation\Http\Middleware;
+use ZM\API\CQ;
+
+/**
+ * Class AdminFunc
+ * @package Module\Example
+ * @Middleware("admin")
+ */
+class AdminFunc
+{
+    /**
+     * @CQCommand(match="禁言",message_type="group")
+     */
+    public function banSomeone() {
+        $r1 = ctx()->getNextArg("请输入禁言的人或at他");
+        $r2 = ctx()->getFullArg("请输入禁言的时间（秒）");
+        $cq = CQ::getCQ($r1);
+        if ($cq !== null) {
+            if ($cq["type"] != "at") return "请at或者输入正确的QQ号！";
+            $r1 = $cq["params"]["qq"];
+        }
+        // 群内禁言用户
+        ctx()->getRobot()->setGroupBan(ctx()->getGroupId(), $r1, $r2);
+        return "禁言成功！";
+    }
+
+    /**
+     * @CQCommand(match="解除禁言",message_type="group")
+     */
+    public function unbanSomeone() {
+        $r1 = ctx()->getNextArg("请输入禁言的人或at他");
+        $cq = CQ::getCQ($r1);
+        if ($cq !== null) {
+            if ($cq["type"] != "at") return "请at或者输入正确的QQ号！";
+            $r1 = $cq["params"]["qq"];
+        }
+        // 群内禁言用户
+        ctx()->getRobot()->setGroupBan(ctx()->getGroupId(), $r1, 0);
+        return "解除禁言成功！";
+    }
+}
+```
+
+**src/Module/Example/AdminManager.php**
+
+```php
+<?php
+
+namespace Module\Example;
+
+use ZM\Annotation\CQ\CQCommand;
+use ZM\Annotation\Http\Middleware;
+use ZM\Annotation\Swoole\OnStart;
+use ZM\Store\LightCache;
+use ZM\Store\Lock\SpinLock;
+
+class AdminManager
+{
+    /**
+     * @OnStart()
+     */
+    public function onStart() {
+        if (!LightCache::isset("admin_list")) { //一次性代码，首次执行才会执行if
+            LightCache::set("admin_list", [ // 框架启动时初始化管理员列表
+                "123456",
+                "234567"
+            ], -2); // 这里用 -2 的原因是将这一列表持久化保存，避免关闭框架后丢失
+        }
+    }
+
+    /**
+     * @CQCommand(match="添加管理员")
+     * @Middleware("admin")
+     */
+    public function addAdmin() { //只有管理员才能添加管理员
+        $qq = ctx()->getNextArg("请输入要添加管理员的QQ(qq号码，不可at）");
+        SpinLock::lock("admin_list");        //如果是多进程模式的话需要加锁
+        $ls = LightCache::get("admin_list");
+        if (!in_array($qq, $ls)) $ls[] = $qq;
+        LightCache::set("admin_list", $ls, -2);
+        SpinLock::unlock("admin_list");      //如果是多进程模式的话需要加锁
+        return "成功添加 $qq 到管理员列表！";
+    }
+}
+```
+
+<chat-box :my-chats="[
+    {type:2,content:'现在我是 123456'},
+    {type:0,content:'禁言 13579 60'},
+    {type:1,content:'禁言成功！'},
+    {type:0,content:'解除禁言 13579'},
+    {type:1,content:'解除禁言成功！'},
+    {type:0,content:'添加管理员 98765'},
+    {type:1,content:'成功添加 98765 到管理员列表！'},
+    {type:2,content:'现在我是98765'},
+    {type:0,content:'禁言 13579'},
+    {type:1,content:'请输入禁言的时间（秒）'},
+    {type:0,content:'120'},
+    {type:1,content:'禁言成功！'},
+]"></chat-box>

docs/advanced/example/integrate-qingyunke-chatbot.md

@@ -0,0 +1,85 @@
+# 接入青云客智能聊天机器人API
+
+作为一个群聊机器人，懂得聊天会让机器人增色不少，在大数据和 AI 热潮下，不少厂商都研发了自己的智能聊天 API，例如图灵机器人、腾讯智能闲聊等，大厂开发的 API 自然有着他人无可比拟的健壮性和可靠性，但是随之而来不菲的价格显然并不适合大众开发者。这时候一个免费、可用的智能聊天 API 便非常重要了，其中，青云客是少有的完全免费、无需注册的智能聊天 API，提供了包括智能聊天、歌词、天气查询、笑话等多种有用功能，且接入简单，非常适合新手开发者尝试。
+
+## 结果演示
+
+![圖片](https://user-images.githubusercontent.com/31698606/158875192-108698a3-b54e-4fc0-889a-0829ca328b13.png)
+
+## 阅读接入指南
+
+不管接入何种服务，阅读接入指南永远都是最优先、最重要的一步，所幸青云客的接入指南十分简单，简单来说归纳为以下：
+* 请求：GET https://api.qingyunke.com/api.php
+* 参数：
+* * `key`   目前固定为 `free`
+* * `appid` 目前固定为 `0`
+* * `msg`   关键词，需要经过 `urlencode`
+* 注意：返回结果中 `{br}` 代表换行
+
+## 逻辑编写
+
+阅读过后，我们便可以进行主要的编写工作了。
+
+首先，为了机器人的性能考虑，也为了避免过分打扰群聊的聊天，我们希望机器人只有在主动触发（@AT 或者 关键词等）时才会进行智能聊天。
+
+对于关键词匹配，我们可以使用 `@CQCommand`：
+
+```php
+/**
+ * 智能聊天
+ *
+ * @CQCommand(start_with="机器人")
+ */
+public function chat()
+{
+    // 替换掉机器人前缀，并获取消息内容
+    $msg = ctx()->getMessage();
+    $msg = str_replace('机器人', '', $msg);
+    if (empty(trim($msg))) {
+        $msg = ctx()->getFullArg('怎么了？');
+    }
+
+    Console::info('正在获取智能聊天回复：' . $msg);
+    // 请求 API 获取回复
+    $raw_data = file_get_contents('https://api.qingyunke.com/api.php?key=free&appid=0&msg=' . urlencode($msg));
+    try {
+        $data = json_decode($raw_data, true, 512, JSON_THROW_ON_ERROR);
+    } catch (\Exception $e) {
+        $data = ['content' => '机器人解析异常，请稍后再试'];
+        Console::warning('无法获取智能聊天回复：' . $e->getMessage());
+    }
+    if ($data['result'] !== 0) {
+        $data = ['content' => '机器人服务异常，请稍后再试'];
+        Console::warning('无法获取智能聊天回复：' . $raw_data);
+    }
+    Console::info('获取智能聊天回复完成：' . $data['content']);
+    // 将 {br} 替换为换行
+    $data['content'] = strtr($data['content'], ['{br}' => "\n"]);
+    return $data['content'];
+}
+```
+
+这样我们的命令便只会在用户发送以`机器人`开头的消息时才会触发。
+
+同时，我们也希望在 @AT 机器人时也进行回复，此时可以使用 `@CQBefore` 方法进行折中：
+
+```php
+/**
+ * 将 AT 机器人的消息交由智能聊天处理
+ *
+ * @CQBefore("message")
+ */
+public function changeAt(): bool
+{
+    // 判断此条消息是否 AT 了机器人
+    if (MessageUtil::isAtMe(ctx()->getMessage(), ctx()->getRobotId())) {
+        // 将 AT 本身从消息中去掉
+        $msg = str_replace(CQ::at(ctx()->getRobotId()), '', ctx()->getMessage());
+        ctx()->setMessage('机器人' . trim($msg));
+        // 调用智能聊天
+        ctx()->reply($this->chat());
+        return false;
+    }
+    return true;
+}
+```

docs/advanced/example/weather-bot.md

@@ -0,0 +1,113 @@
+# 基于词性分析和魅族天气的天气查询机器人
+
+本文将基于 [`jieba-php`](https://github.com/fukuball/jieba-php) 中文分词库以及 [魅族天气 API](https://github.com/shichunlei/-Api/blob/master/MeizuWeather.md) 开发一个天气查询机器人。
+
+## 结果演示
+
+![圖片](https://user-images.githubusercontent.com/31698606/159122016-61ba9696-5786-4561-b371-827d9f1d01aa.png)
+尾部的随机表情并非本教程的一部分。
+
+## 逻辑编写
+
+[jieba-php](https://github.com/fukuball/jieba-php) 是目前比较好用的中文分词库，虽然最近的维护并不活跃，但已足够我们的需求：
+
+```shell
+composer require fukuball/jieba-php:dev-master
+```
+
+以下代码使用了本文作者自行编写的天气查询库，需要进行引入：
+
+```shell
+composer require sunxyw/weather
+```
+
+您也可以将以下代码自行改写为直接调用魅族天气 API，详情请参阅[魅族天气 API 文档](https://github.com/shichunlei/-Api/blob/master/MeizuWeather.md)。
+
+```php
+<?php
+
+namespace Bot\Module\SmartChat;
+
+use Fukuball\Jieba\Jieba;
+use Fukuball\Jieba\Posseg;
+use Sunxyw\Weather\Weather;
+use ZM\Annotation\CQ\CQCommand;
+use ZM\Console\Console;
+
+class WeatherReport
+{
+    /**
+     * 加载字典
+     *
+     * @OnStart(worker_id=-1)
+     *
+     * @return void
+     */
+    public function initDictionary(): void
+    {
+        // 分词以及词性分析需要载入字典到内存
+        ini_set('memory_limit', '600M');
+        Jieba::init(['dict' => 'small']);
+        Posseg::init();
+    }
+
+    /**
+     * 查询天气
+     *
+     * @CQCommand(keyword="天气")
+     *
+     * @return string
+     */
+    public function cmdQueryWeather(): string
+    {
+        // 分词并进行词性分析
+        $seg_list = Posseg::cut(ctx()->getMessage());
+        $tags = array_column($seg_list, 'tag');
+        // 找出词性为 ns（地名）的单词
+        $location_index = array_search('ns', $tags, true);
+        $location = $seg_list[$location_index]['word'];
+
+        // 此处引入了本文作者自己写的天气库
+        $w = new Weather();
+        try {
+            $report = $w->getWeather($location);
+        } catch (\InvalidArgumentException) {
+            return '城市输入错误';
+        } catch (\JsonException $e) {
+            Console::warning("天气查询失败：{$e->getMessage()}");
+            return '天气查询失败';
+        }
+
+        $template = <<<EOF
+%s天气：%s
+温度：%s℃
+湿度：%s%%
+风向：%s %s
+空气质量：%s
+------------------------------
+未来三天天气：
+%s：%s，日间%s℃，夜间%s℃，吹%s %s
+%s：%s，日间%s℃，夜间%s℃，吹%s %s
+%s：%s，日间%s℃，夜间%s℃，吹%s %s
+EOF;
+        $args = [
+            $report->getCity(),
+            $report->getRealtime()['weather'],
+            $report->getRealtime()['temperature'],
+            $report->getRealtime()['humidity'],
+            $report->getRealtime()['wind_direction'],
+            $report->getRealtime()['wind_speed'],
+            $report->getRealtime()['air_quality'],
+        ];
+        foreach (array_slice($report->getForecastDaily(), 0, 3) as $forecast) {
+            $args[] = $forecast['date'];
+            $args[] = $forecast['weather'];
+            $args[] = $forecast['temperature']['day'];
+            $args[] = $forecast['temperature']['night'];
+            $args[] = $forecast['wind_direction'];
+            $args[] = $forecast['wind_speed'];
+        }
+        return vsprintf($template, ...$args);
+    }
+}
+```

docs/advanced/framework-structure.md

@@ -0,0 +1,5 @@
+# 框架剖析
+
+## 框架运行总结构图
+
+![](https://static.zhamao.me/images/docs/a23d8a952cf9c88d395888d220605a4f.png)

docs/advanced/inside-class.md

@@ -0,0 +1,67 @@
+# 内部类文件手册
+
+这个章节写明了在框架使用过程中可能涉及到的框架内部或 Swoole、其他 composer 依赖组件的内部类，这里会根据类的命名空间一一说明。
+
+## Swoole\Http\Request
+
+此类是 Swoole 内部的一个类，一般在收到 HTTP 请求时，在 `@RequestMapping` 或 `@OnRequestEvent()` 两个注解下可用，用作获取 GET、POST参数，上传到后端的文件、Cookies 等。详见 [Swoole 文档 - Request](http://wiki.swoole.com/#/http_server?id=httprequest) 。
+
+### 属性
+
+- `$fd`：获取当前连接的文件描述符 ID。
+- `$header`：`HTTP` 请求的头部信息。类型为数组，所有 `key` 均为小写。
+- `$server`：`HTTP` 请求相关的服务器信息。
+- `$cookie`：获取 Cookies。
+- `$get`：获取 GET 参数。
+- `$post`：获取 POST 参数。
+- `$files`：获取上传的文件信息
+
+### 方法
+
+- `rawContent()`：获取 POST 包原始二进制内容，相当于原生 PHP 的 ` file_get_contents("php://input");` 。
+- `getData()`：获取完整的原始 `Http` 请求报文。包括 `Http Header` 和 `Http Body`
+
+### 示例
+
+```php
+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 ==> [
+	"我叫顺溜",
+	"我今年二十八"
+]
+*/
+```

docs/advanced/manually-install.md

@@ -0,0 +1,3 @@
+# 手动部署环境教程
+
+TODO: 还没写

docs/advanced/multi-process.md

@@ -0,0 +1,72 @@
+# 框架多进程
+
+首先对于多进程概念，对于传统 PHP 程序员可能比较陌生，唯一接触到的地方可能就是 php-fpm 等一些方式处理时间长的请求时开进程去执行。关于多进程，我觉得廖雪峰的 Python 多进程这段讲的不错：
+
+> Unix/Linux 操作系统提供了一个`fork()`系统调用，它非常特殊。普通的函数调用，调用一次，返回一次，但是`fork()`调用一次，返回两次，因为操作系统自动把当前进程（称为父进程）复制了一份（称为子进程），然后，分别在父进程和子进程内返回。
+
+这里面的重点在于，多进程的创建，是父进程的复制，然后两个进程接下来运行的代码和存的内容就分道扬镳了。
+
+PHP 也是如此，框架的多进程又是怎么一回事呢？为什么要采用多进程呢？
+
+## 作用
+
+使用过框架的你一定知道，框架是以命令行方式运行 PHP 的，而命令行方式运行 PHP，就代表要常驻内存，就像 Python、Node.js 一样。而默认情况下，比如 Python 的 Flask 为单线程单进程模式，也就是说同时只能处理一个 Web 请求。但大部分情况下，比如 Node.js，提供的都是异步 I/O，这也就是说明它在 Web 处理请求上，可同时承接的 I/O 密集型请求会更多一些，这样在对一般的 Web 应用中 I/O 密集型场景非常有用，而且往往只需要单进程也可以承载上万的并发请求。
+
+在炸毛框架中，因为框架基于 Swoole 构建，所以天然支持协程，而协程就是针对 I/O 操作进行一个调度，类似异步的 Node.js，所以针对项目中存在太多的 SQL 语句执行、文件读写的话，炸毛框架直接上手，无需做任何修改，也可以达到很好的性能。
+
+**但是**，CPU 密集型的应用怎么办呢？假设我的 Web 应用有大量的排序、md5 运算怎么办呢？这样的阻塞，假设是一个超级大的 for 循环或者是要执行很长时间的 while 循环，CPU 一直在被占用。多进程就是针对 CPU 密集型的应用说 yes 的一个方案。
+
+![diagram](https://static.zhamao.me/images/docs/06c17ab473f17ab10523a938cdbd8760.png)
+
+我们假设现在有 3 个请求同时访问，也就是说上面的流程需要执行 3 遍。而如果我们只有一个进程的话，最后一个请求需要等待的时间为 `2*3+5*3=21` 秒，非常耗时。
+
+而如果有两个进程处理 3 个请求，则最后一个完成的请求就缩短了，`2+5+2+5=14` 秒。
+
+![diagram](https://static.zhamao.me/images/docs/dbb4e32e1c77f96162d10e41f25befa4.png)
+
+所以如果要充分利用你的服务器或者个人电脑的多核 CPU 资源，就要设置多个进程来处理。一个进程只能在一个 CPU 上运行，而设置了多进程后，就可以让多核 CPU 充分运行多个进程，所以我们给框架设置多进程的推荐数值为等同于 CPU 的核心数。
+
+## 为什么不是多线程
+
+因为众所周知，PHP 对线程的支持比较不好，而 ZTS 版本的 PHP 又会影响传统的 Web 端 PHP 的性能，再加上 Linux 对线程的切换效率和多进程切换的效率差不多，多线程容易造成数据读写不安全等问题，故 Swoole 使用的是多进程模型。
+
+## 框架进程模型
+
+![diagram](https://static.zhamao.me/images/docs/46a34feb0195d6ea12da7b80750c9e71.png)
+
+上图中，横向的时间片可以理解为并行执行，这些操作在多个 CPU 内可能同时在执行。
+
+## 进程间隔离
+
+众所周知，进程是程序在操作系统中的一个边界，和自己有关的一切变量、内容和代码都在自己的进程内，不同进程之间如果不使用管道等方式，是不可以互相访问的。而加上开始描述的，创建子进程是一个复制自身的过程，所以也就会有如下图的情况：
+
+![diagram](https://static.zhamao.me/images/docs/8b43e2179a63c8d91a508d7cefcd3226.png)
+
+我们以静态类为例，设置一个进程中的全局变量。这里就会出现，同一个静态变量在多个进程中完全不同的值的结果。此后，我们将会在 Worker 进程中执行用户的代码，如果设置 Worker 数量仅为 1 的话，那么就简单许多了，你还是可以使用全局变量或静态类来存储你想要的内容而不用担心这种多个进程变量隔离的情况（因为用户的 Web 请求处理的代码只会在一个 Worker 进程中执行）。如果像上图一样设置了多个 Worker，则用户过来的比如 HTTP 请求就有可能出现在不同的 Worker 进程中，给全局变量设值就一定会造成不同步的问题。这时我们就不可以使用全局变量做数据同步（注意，我说的是数据同步）。
+
+## 跨进程同步
+
+跨进程同步方案中，框架给出了很多种解决方案。
+
+- MySQL 数据库
+- Redis
+- LightCache 轻量缓存（共享内存）
+- WorkerCache 大缓存
+- ZMAtomic 跨进程原子计数器
+
+下面的表格我将列出下方的特点和各自的优缺点：
+
+| 类型        | 用途                                                | 优点                                              | 缺点                                                         |
+| ----------- | --------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------ |
+| MySQL       | 大型的传统的关系式数据都可以用数据库，你懂的        | 就是数据库的优点                                  | 和数据库不在同一台服务器的话网络延迟会较大，数据获取效率不高 |
+| Redis       | 传统的 key-value 数据库                             | 数据无同步等问题，性能高                          | 有网络通信延迟                                               |
+| LightCache  | 框架封装的跨进程的 key-value 存储模型               | 性能强悍，无 I/O 和网络通信                       | 需要提前分配最大内存大小，最大单个值长度大小，不灵活         |
+| WorkerCache | 框架封装的基于进程的 key-value 存储模型，类似 Redis | 无需提前分配最大内存大小，受限于 PHP memory_limit | 见 WorkerCache 的说明                                        |
+
+::: tip WorkerCache 的说明
+
+对于 WorkerCache 来说，其实是比较特殊的进程间通信。具体来说就是，WorkerCache 的原理就是将变量指定的存到一个进程中，如果是本进程读写的话直接相当于改一下全局变量，如果是其他进程读写的话，则依靠进程间通信。
+	
+所以缺点也显而易见，如果使用过程中不是命中了 WorkerCache 存储所在的进程的话，则一直会使用进程间通信，影响一定的效率。
+
+:::

docs/advanced/php-env.md

@@ -0,0 +1,3 @@
+# PHP 环境高级部署方式
+
+TODO: 留个坑。

docs/advanced/task-worker.md

@@ -0,0 +1,3 @@
+# 使用 TaskWorker 进程处理密集运算
+
+> TODO: 新开个坑，有时间补上。（__填坑标记__）

docs/api/ZM/API/CQ.md

@@ -0,0 +1,618 @@
+# ZM\API\CQ
+
+## at
+
+```php
+public function at(int|string $qq): string
+```
+
+### 描述
+
+at一下QQ用户（仅在QQ群支持at全体）
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| qq | int|string | 用户QQ号/ID号 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## face
+
+```php
+public function face(int|string $id): string
+```
+
+### 描述
+
+发送QQ原生表情
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| id | int|string | 表情ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## image
+
+```php
+public function image(string $file, bool $cache, bool $flash, bool $proxy, int $timeout): string
+```
+
+### 描述
+
+发送图片
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| file | string | 文件的路径、URL或者base64编码的图片数据 |
+| cache | bool | 是否缓存（默认为true） |
+| flash | bool | 是否闪照（默认为false） |
+| proxy | bool | 是否使用代理（默认为true） |
+| timeout | int | 超时时间（默认不超时） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## record
+
+```php
+public function record(string $file, bool $magic, bool $cache, bool $proxy, int $timeout): string
+```
+
+### 描述
+
+发送语音
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| file | string | 文件的路径、URL或者base64编码的语音数据 |
+| magic | bool | 是否加特技（默认为false） |
+| cache | bool | 是否缓存（默认为true） |
+| proxy | bool | 是否使用代理（默认为true） |
+| timeout | int | 超时时间（默认不超时） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## video
+
+```php
+public function video(string $file, bool $cache, bool $proxy, int $timeout): string
+```
+
+### 描述
+
+发送短视频
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| file | string | 文件的路径、URL或者base64编码的短视频数据 |
+| cache | bool | 是否缓存（默认为true） |
+| proxy | bool | 是否使用代理（默认为true） |
+| timeout | int | 超时时间（默认不超时） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## rps
+
+```php
+public function rps(): string
+```
+
+### 描述
+
+发送投掷骰子（只能在单条回复中单独使用）
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## dice
+
+```php
+public function dice(): string
+```
+
+### 描述
+
+发送掷骰子表情（只能在单条回复中单独使用）
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## shake
+
+```php
+public function shake(): string
+```
+
+### 描述
+
+戳一戳（原窗口抖动，仅支持好友消息使用）
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## poke
+
+```php
+public function poke(int|string $type, int|string $id, string $name): string
+```
+
+### 描述
+
+发送新的戳一戳
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| type | int|string | 焯一戳类型 |
+| id | int|string | 戳一戳ID号 |
+| name | string | 戳一戳名称（可选） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## anonymous
+
+```php
+public function anonymous(int $ignore): string
+```
+
+### 描述
+
+发送匿名消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| ignore | int | 是否忽略错误（默认为1，0表示不忽略错误） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## share
+
+```php
+public function share(string $url, string $title, null|string $content, null|string $image): string
+```
+
+### 描述
+
+发送链接分享（只能在单条回复中单独使用）
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| url | string | 分享地址 |
+| title | string | 标题 |
+| content | null|string | 卡片内容（可选） |
+| image | null|string | 卡片图片（可选） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## contact
+
+```php
+public function contact(int|string $type, int|string $id): string
+```
+
+### 描述
+
+发送好友或群推荐名片
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| type | int|string | 名片类型 |
+| id | int|string | 好友或群ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## location
+
+```php
+public function location(float|string $lat, float|string $lon, string $title, string $content): string
+```
+
+### 描述
+
+发送位置
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| lat | float|string | 纬度 |
+| lon | float|string | 经度 |
+| title | string | 标题（可选） |
+| content | string | 卡片内容（可选） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## music
+
+```php
+public function music(string $type, int|string $id_or_url, null|string $audio, null|string $title, null|string $content, null|string $image): string
+```
+
+### 描述
+
+发送音乐分享（只能在单条回复中单独使用）
+qq、163、xiami为内置分享，需要先通过搜索功能获取id后使用
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| type | string | 分享类型（仅限 `qq`、`163`、`xiami` 或 `custom`） |
+| id_or_url | int|string | 当分享类型不是 `custom` 时，表示的是分享音乐的ID（需要先通过搜索功能获取id后使用），反之表示的是音乐卡片点入的链接 |
+| audio | null|string | 当分享类型是 `custom` 时，表示为音乐（如mp3文件）的HTTP链接地址（不可为空） |
+| title | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的标题，建议12字以内（不可为空） |
+| content | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的简介（可忽略） |
+| image | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的图片链接地址（可忽略） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## forward
+
+```php
+public function forward(int|string $id): string
+```
+
+### 描述
+
+合并转发消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| id | int|string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## node
+
+```php
+public function node(int|string $user_id, string $nickname, string $content): string
+```
+
+### 描述
+
+合并转发消息节点
+特殊说明: 需要使用单独的API /send_group_forward_msg 发送, 并且由于消息段较为复杂, 仅支持Array形式入参。
+如果引用消息和自定义消息同时出现, 实际查看顺序将取消息段顺序。
+另外按 CQHTTP 文档说明, data 应全为字符串, 但由于需要接收message 类型的消息, 所以 仅限此Type的content字段 支持Array套娃
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| user_id | int|string | 转发消息id |
+| nickname | string | 发送者显示名字 |
+| content | string | 具体消息 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## xml
+
+```php
+public function xml(string $data): string
+```
+
+### 描述
+
+XML消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| data | string | xml内容, xml中的value部分 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## json
+
+```php
+public function json(string $data, int $resid): string
+```
+
+### 描述
+
+JSON消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| data | string | json内容 |
+| resid | int | 0为走小程序通道，其他值为富文本通道（默认为0） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## _custom
+
+```php
+public function _custom(string $type_name, array $params): string
+```
+
+### 描述
+
+返回一个自定义扩展的CQ码（支持自定义类型和参数）
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| type_name | string | CQ码类型名称 |
+| params | array | 参数 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | CQ码 |
+
+
+## decode
+
+```php
+public function decode(int|string|Stringable $msg, bool $is_content): string
+```
+
+### 描述
+
+反转义字符串中的CQ码敏感符号
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | int|string|Stringable | 字符串 |
+| is_content | bool | 如果是解码CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 转义后的CQ码 |
+
+
+## replace
+
+```php
+public function replace(int|string|Stringable $str): string
+```
+
+### 描述
+
+简单反转义替换CQ码的方括号
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| str | int|string|Stringable | 字符串 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 字符串 |
+
+
+## escape
+
+```php
+public function escape(int|string|Stringable $msg, bool $is_content): string
+```
+
+### 描述
+
+转义CQ码的特殊字符，同encode
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | int|string|Stringable | 字符串 |
+| is_content | bool | 如果是转义CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 转义后的CQ码 |
+
+
+## encode
+
+```php
+public function encode(int|string|Stringable $msg, bool $is_content): string
+```
+
+### 描述
+
+转义CQ码的特殊字符
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | int|string|Stringable | 字符串 |
+| is_content | bool | 如果是转义CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 转义后的CQ码 |
+
+
+## removeCQ
+
+```php
+public function removeCQ(string $msg): string
+```
+
+### 描述
+
+移除消息中所有的CQ码并返回移除CQ码后的消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | string | 消息 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 消息内容 |
+
+
+## getCQ
+
+```php
+public function getCQ(string $msg, bool $is_object): null|array|CQObject
+```
+
+### 描述
+
+获取消息中第一个CQ码
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | string | 消息内容 |
+| is_object | bool | 是否以对象形式返回，如果为False的话，返回数组形式（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| null|array|CQObject | 返回的CQ码（数组或对象） |
+
+
+## getAllCQ
+
+```php
+public function getAllCQ(string $msg, bool $is_object): array|CQObject[]
+```
+
+### 描述
+
+获取消息中所有的CQ码
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | string | 消息内容 |
+| is_object | bool | 是否以对象形式返回，如果为False的话，返回数组形式（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|CQObject[] | 返回的CQ码们（数组或对象） |

docs/api/ZM/API/GoCqhttpAPIV11.md

@@ -0,0 +1,130 @@
+# ZM\API\GoCqhttpAPIV11
+
+## getGuildServiceProfile
+
+```php
+public function getGuildServiceProfile(): array|bool
+```
+
+### 描述
+
+获取频道系统内BOT的资料
+响应字段：nickname, tiny_id, avatar_url
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGuildList
+
+```php
+public function getGuildList(): array|bool
+```
+
+### 描述
+
+获取频道列表
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGuildMetaByGuest
+
+```php
+public function getGuildMetaByGuest(int|string $guild_id): array|bool
+```
+
+### 描述
+
+通过访客获取频道元数据
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| guild_id | int|string | 频道ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGuildChannelList
+
+```php
+public function getGuildChannelList(int|string $guild_id, false $no_cache): array|bool
+```
+
+### 描述
+
+获取子频道列表
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| guild_id | int|string | 频道ID |
+| no_cache | false | 禁用缓存（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGuildMembers
+
+```php
+public function getGuildMembers(int|string $guild_id): array|bool
+```
+
+### 描述
+
+获取频道成员列表
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| guild_id | int|string | 频道ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## sendGuildChannelMsg
+
+```php
+public function sendGuildChannelMsg(int|string $guild_id, int|string $channel_id, string $message): array|bool
+```
+
+### 描述
+
+发送信息到子频道
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| guild_id | int|string | 频道ID |
+| channel_id | int|string | 子频道ID |
+| message | string | 信息内容 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |

docs/api/ZM/API/OneBotV11.md

@@ -0,0 +1,984 @@
+# ZM\API\OneBotV11
+
+## get
+
+```php
+public function get(int|string $robot_id): ZMRobot
+```
+
+### 描述
+
+获取机器人Action/API实例
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| robot_id | int|string | 机器人ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| ZMRobot | 机器人实例 |
+
+
+## getRandom
+
+```php
+public function getRandom(): ZMRobot
+```
+
+### 描述
+
+随机获取一个连接到框架的机器人实例
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| ZMRobot | 机器人实例 |
+
+
+## getAllRobot
+
+```php
+public function getAllRobot(): ZMRobot[]
+```
+
+### 描述
+
+获取所有机器人实例
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| ZMRobot[] | 机器人实例们 |
+
+
+## setCallback
+
+```php
+public function setCallback(bool|Closure $callback): OneBotV11
+```
+
+### 描述
+
+设置回调或启用协程等待API回包
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| callback | bool|Closure | 是否开启协程或设置异步回调函数，如果为true，则协程等待结果，如果为false，则异步执行并不等待结果，如果为回调函数，则异步执行且调用回调 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| OneBotV11 | 返回本身 |
+
+
+## setPrefix
+
+```php
+public function setPrefix(int $prefix): OneBotV11
+```
+
+### 描述
+
+设置API调用类型后缀
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| prefix | int | 设置后缀类型，API_NORMAL为不加后缀，API_ASYNC为异步调用，API_RATE_LIMITED为加后缀并且限制调用频率 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| OneBotV11 | 返回本身 |
+
+
+## sendPrivateMsg
+
+```php
+public function sendPrivateMsg(int|string $user_id, string $message, bool $auto_escape): array|bool
+```
+
+### 描述
+
+发送私聊消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| user_id | int|string | 用户ID |
+| message | string | 消息内容 |
+| auto_escape | bool | 是否自动转义（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## sendGroupMsg
+
+```php
+public function sendGroupMsg(int|string $group_id, string $message, bool $auto_escape): array|bool
+```
+
+### 描述
+
+发送群消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群组ID |
+| message | string | 消息内容 |
+| auto_escape | bool | 是否自动转义（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## sendMsg
+
+```php
+public function sendMsg(string $message_type, int|string $target_id, string $message, bool $auto_escape): array|bool
+```
+
+### 描述
+
+发送消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| message_type | string | 消息类型 |
+| target_id | int|string | 目标ID |
+| message | string | 消息内容 |
+| auto_escape | bool | 是否自动转义（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## deleteMsg
+
+```php
+public function deleteMsg(int|string $message_id): array|bool
+```
+
+### 描述
+
+撤回消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| message_id | int|string | 消息ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getMsg
+
+```php
+public function getMsg(int|string $message_id): array|bool
+```
+
+### 描述
+
+获取消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| message_id | int|string | 消息ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getForwardMsg
+
+```php
+public function getForwardMsg(int|string $id): array|bool
+```
+
+### 描述
+
+获取合并转发消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| id | int|string | ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## sendLike
+
+```php
+public function sendLike(int|string $user_id, int $times): array|bool
+```
+
+### 描述
+
+发送好友赞
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| user_id | int|string | 用户ID |
+| times | int | 时间 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupKick
+
+```php
+public function setGroupKick(int|string $group_id, int|string $user_id, bool $reject_add_request): array|bool
+```
+
+### 描述
+
+群组踢人
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| reject_add_request | bool |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupBan
+
+```php
+public function setGroupBan(int|string $group_id, int|string $user_id, int $duration): array|bool
+```
+
+### 描述
+
+群组单人禁言
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| duration | int | 禁言时长 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupAnonymousBan
+
+```php
+public function setGroupAnonymousBan(int|string $group_id, array|int|string $anonymous_or_flag, int $duration): array|bool
+```
+
+### 描述
+
+群组匿名用户禁言
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| anonymous_or_flag | array|int|string | 匿名禁言Flag或匿名用户对象 |
+| duration | int |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupWholeBan
+
+```php
+public function setGroupWholeBan(int|string $group_id, bool $enable): array|bool
+```
+
+### 描述
+
+群组全员禁言
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| enable | bool |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupAdmin
+
+```php
+public function setGroupAdmin(int|string $group_id, int|string $user_id, bool $enable): array|bool
+```
+
+### 描述
+
+群组设置管理员
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| enable | bool |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupAnonymous
+
+```php
+public function setGroupAnonymous(int|string $group_id, bool $enable): array|bool
+```
+
+### 描述
+
+群组匿名
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| enable | bool | 是否启用（默认为true） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupCard
+
+```php
+public function setGroupCard(int|string $group_id, int|string $user_id, string $card): array|bool
+```
+
+### 描述
+
+设置群名片（群备注）
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| card | string | 名片内容（默认为空） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupName
+
+```php
+public function setGroupName(int|string $group_id, string $group_name): array|bool
+```
+
+### 描述
+
+设置群名
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| group_name | string | 群名 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupLeave
+
+```php
+public function setGroupLeave(int|string $group_id, bool $is_dismiss): array|bool
+```
+
+### 描述
+
+退出群组
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| is_dismiss | bool | 是否解散（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupSpecialTitle
+
+```php
+public function setGroupSpecialTitle(int|string $group_id, int|string $user_id, string $special_title, int $duration): array|bool
+```
+
+### 描述
+
+设置群组专属头衔
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| special_title | string | 专属头衔内容 |
+| duration | int | 持续时间（默认为-1，永久） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setFriendAddRequest
+
+```php
+public function setFriendAddRequest(array|int|string $flag, bool $approve, string $remark): array|bool
+```
+
+### 描述
+
+处理加好友请求
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| flag | array|int|string | 处理加好友请求的flag |
+| approve | bool | 是否同意（默认为true） |
+| remark | string | 设置昵称（默认不设置） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setGroupAddRequest
+
+```php
+public function setGroupAddRequest(array|int|string $flag, string $sub_type, bool $approve, string $reason): array|bool
+```
+
+### 描述
+
+处理加群请求／邀请
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| flag | array|int|string | 处理加群请求的flag |
+| sub_type | string | 处理请求类型（包含add和invite） |
+| approve | bool | 是否同意（默认为true） |
+| reason | string | 拒绝理由（仅在拒绝时有效，默认为空） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getLoginInfo
+
+```php
+public function getLoginInfo(): array|bool
+```
+
+### 描述
+
+获取登录号信息
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getStrangerInfo
+
+```php
+public function getStrangerInfo(int|string $user_id, bool $no_cache): array|bool
+```
+
+### 描述
+
+获取陌生人信息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| user_id | int|string | 用户ID |
+| no_cache | bool | 是否不使用缓存（默认为false） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getFriendList
+
+```php
+public function getFriendList(): array|bool
+```
+
+### 描述
+
+获取好友列表
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGroupInfo
+
+```php
+public function getGroupInfo(int|string $group_id, bool $no_cache): array|bool
+```
+
+### 描述
+
+获取群信息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| no_cache | bool |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGroupList
+
+```php
+public function getGroupList(): array|bool
+```
+
+### 描述
+
+获取群列表
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGroupMemberInfo
+
+```php
+public function getGroupMemberInfo(int|string $group_id, int|string $user_id, bool $no_cache): array|bool
+```
+
+### 描述
+
+获取群成员信息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| user_id | int|string | 用户ID |
+| no_cache | bool |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGroupMemberList
+
+```php
+public function getGroupMemberList(int|string $group_id): array|bool
+```
+
+### 描述
+
+获取群成员列表
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getGroupHonorInfo
+
+```php
+public function getGroupHonorInfo(int|string $group_id, string $type): array|bool
+```
+
+### 描述
+
+获取群荣誉信息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| group_id | int|string | 群ID |
+| type | string | 荣誉类型 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getCsrfToken
+
+```php
+public function getCsrfToken(): array|bool
+```
+
+### 描述
+
+获取 CSRF Token
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getCredentials
+
+```php
+public function getCredentials(string $domain): array|bool
+```
+
+### 描述
+
+获取 QQ 相关接口凭证
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| domain | string |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getRecord
+
+```php
+public function getRecord(string $file, string $out_format): array|bool
+```
+
+### 描述
+
+获取语音
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| file | string | 文件 |
+| out_format | string | 输出格式 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getImage
+
+```php
+public function getImage(string $file): array|bool
+```
+
+### 描述
+
+获取图片
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| file | string | 文件 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## canSendImage
+
+```php
+public function canSendImage(): array|bool
+```
+
+### 描述
+
+检查是否可以发送图片
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## canSendRecord
+
+```php
+public function canSendRecord(): array|bool
+```
+
+### 描述
+
+检查是否可以发送语音
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getStatus
+
+```php
+public function getStatus(): array|bool
+```
+
+### 描述
+
+获取运行状态
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getVersionInfo
+
+```php
+public function getVersionInfo(): array|bool
+```
+
+### 描述
+
+获取版本信息
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## setRestart
+
+```php
+public function setRestart(int $delay): array|bool
+```
+
+### 描述
+
+重启 OneBot 实现
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| delay | int | 延迟时间（毫秒，默认为0） |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## cleanCache
+
+```php
+public function cleanCache(): array|bool
+```
+
+### 描述
+
+清理缓存
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |
+
+
+## getExtendedAPI
+
+```php
+public function getExtendedAPI(string $package_name): mixed
+```
+
+### 描述
+
+获取内置支持的扩展API对象
+现支持 go-cqhttp 的扩展API
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| package_name | string |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed | 返回包的操作对象 |
+
+
+## callExtendedAPI
+
+```php
+public function callExtendedAPI(string $action, array $params): array|bool
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| action | string | 动作（API）名称 |
+| params | array | 参数 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） |

docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md

@@ -0,0 +1,117 @@
+# ZM\API\Proxies\Bot\AbstractBotProxy
+
+## __construct
+
+```php
+public function __construct(AbstractBotProxy|ZMRobot $bot): mixed
+```
+
+### 描述
+
+构造函数
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| bot | AbstractBotProxy|ZMRobot | 调用此代理的机器人实例 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## __call
+
+```php
+public function __call(string $name, array $arguments): mixed
+```
+
+### 描述
+
+在传入的机器人实例上调用方法
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 方法名 |
+| arguments | array | 参数 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## __get
+
+```php
+public function __get(string $name): mixed
+```
+
+### 描述
+
+获取传入的机器人实例的属性
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 属性名 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## __set
+
+```php
+public function __set(string $name, mixed $value): mixed
+```
+
+### 描述
+
+设置传入的机器人实例的属性
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 属性名 |
+| value | mixed | 属性值 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## __isset
+
+```php
+public function __isset(string $name): bool
+```
+
+### 描述
+
+判断传入的机器人实例的属性是否存在
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 属性名 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| bool |  |

docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md

@@ -0,0 +1,24 @@
+# ZM\API\Proxies\Bot\AllBotsProxy
+
+## __call
+
+```php
+public function __call(string $name, array $arguments): array<mixed>
+```
+
+### 描述
+
+在所有机器人实例上调用方法
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 方法名 |
+| arguments | array | 参数 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array<mixed> | 返回一个包含所有执行结果的数组，键名为机器人ID |

docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md

@@ -0,0 +1,24 @@
+# ZM\API\Proxies\Bot\AllGroupsProxy
+
+## __call
+
+```php
+public function __call(string $name, array $arguments): array<mixed>
+```
+
+### 描述
+
+在传入的机器人实例上调用方法
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| name | string | 方法名 |
+| arguments | array | 参数 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| array<mixed> | 返回一个包含所有执行结果的数组，键名为群号 |

docs/api/ZM/API/TuringAPI.md

@@ -0,0 +1,48 @@
+# ZM\API\TuringAPI
+
+## getTuringMsg
+
+```php
+public function getTuringMsg(string $msg, int|string $user_id, string $api): string
+```
+
+### 描述
+
+请求图灵API，返回图灵的消息
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| msg | string | 消息 |
+| user_id | int|string | 用户ID |
+| api | string | API Key |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| string | 图灵的回复 |
+
+
+## getResultStatus
+
+```php
+public function getResultStatus(array $r): bool|string
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| r | array | 数据API回包 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| bool|string | 错误消息或成功鸥鸟 |

docs/api/ZM/API/ZMRobot.md

@@ -0,0 +1,46 @@
+# ZM\API\ZMRobot
+
+## all
+
+```php
+public function all(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllBotsProxy
+```
+
+### 描述
+
+获取一个会在所有机器人实例上执行的代理
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| proxy | ZM\API\Proxies\Bot\AbstractBotProxy |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| ZM\API\Proxies\Bot\AllBotsProxy |  |
+
+
+## allGroups
+
+```php
+public function allGroups(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllGroupsProxy
+```
+
+### 描述
+
+获取一个会在所有群上执行的代理
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| proxy | ZM\API\Proxies\Bot\AbstractBotProxy |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| ZM\API\Proxies\Bot\AllGroupsProxy |  |

docs/api/ZM/Annotation/AnnotationBase.md

@@ -0,0 +1 @@
+# ZM\Annotation\AnnotationBase

docs/api/ZM/Annotation/AnnotationParser.md

@@ -0,0 +1,100 @@
+# ZM\Annotation\AnnotationParser
+
+## __construct
+
+```php
+public function __construct(): mixed
+```
+
+### 描述
+
+AnnotationParser constructor.
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## registerMods
+
+```php
+public function registerMods(): mixed
+```
+
+### 描述
+
+注册各个模块类的注解和模块level的排序
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## addRegisterPath
+
+```php
+public function addRegisterPath(string $path, string $indoor_name): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| path | string | 注册解析注解的路径 |
+| indoor_name | string | 起始命名空间的名称 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## sortByLevel
+
+```php
+public function sortByLevel(array $events, string $class_name, string $prefix): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| events | array | 需要排序的 |
+| class_name | string | 排序的类名 |
+| prefix | string | 前缀 |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## verifyMiddlewares
+
+```php
+public function verifyMiddlewares(): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQAPIResponse.md

@@ -0,0 +1 @@
+# ZM\Annotation\CQ\CQAPIResponse

docs/api/ZM/Annotation/CQ/CQAfter.md

@@ -0,0 +1,39 @@
+# ZM\Annotation\CQ\CQAfter
+
+## getLevel
+
+```php
+public function getLevel(): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## setLevel
+
+```php
+public function setLevel(mixed $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | mixed |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQBefore.md

@@ -0,0 +1,39 @@
+# ZM\Annotation\CQ\CQBefore
+
+## getLevel
+
+```php
+public function getLevel(): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## setLevel
+
+```php
+public function setLevel(mixed $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | mixed |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQCommand.md

@@ -0,0 +1,22 @@
+# ZM\Annotation\CQ\CQCommand
+
+## setLevel
+
+```php
+public function setLevel(int $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQMessage.md

@@ -0,0 +1 @@
+# ZM\Annotation\CQ\CQMessage

docs/api/ZM/Annotation/CQ/CQMetaEvent.md

@@ -0,0 +1,39 @@
+# ZM\Annotation\CQ\CQMetaEvent
+
+## getLevel
+
+```php
+public function getLevel(): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |
+
+
+## setLevel
+
+```php
+public function setLevel(int $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQNotice.md

@@ -0,0 +1,22 @@
+# ZM\Annotation\CQ\CQNotice
+
+## setLevel
+
+```php
+public function setLevel(int $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/CQ/CQRequest.md

@@ -0,0 +1,22 @@
+# ZM\Annotation\CQ\CQRequest
+
+## setLevel
+
+```php
+public function setLevel(int $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/Command/TerminalCommand.md

@@ -0,0 +1 @@
+# ZM\Annotation\Command\TerminalCommand

docs/api/ZM/Annotation/Cron/Cron.md

@@ -0,0 +1,61 @@
+# ZM\Annotation\Cron\Cron
+
+## setStatus
+
+```php
+public function setStatus(int $status): void
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| status | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| void |  |
+
+
+## getRecordNextTime
+
+```php
+public function getRecordNextTime(): int
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| int |  |
+
+
+## setRecordNextTime
+
+```php
+public function setRecordNextTime(int $record_next_time): void
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| record_next_time | int |  |
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| void |  |

docs/api/ZM/Annotation/Http/Controller.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\Controller

docs/api/ZM/Annotation/Http/HandleAfter.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\HandleAfter

docs/api/ZM/Annotation/Http/HandleBefore.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\HandleBefore

docs/api/ZM/Annotation/Http/HandleException.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\HandleException

docs/api/ZM/Annotation/Http/Middleware.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\Middleware

docs/api/ZM/Annotation/Http/MiddlewareClass.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\MiddlewareClass

docs/api/ZM/Annotation/Http/RequestMapping.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\RequestMapping

docs/api/ZM/Annotation/Http/RequestMethod.md

@@ -0,0 +1 @@
+# ZM\Annotation\Http\RequestMethod

docs/api/ZM/Annotation/Module/Closed.md

@@ -0,0 +1 @@
+# ZM\Annotation\Module\Closed

docs/api/ZM/Annotation/Swoole/OnCloseEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnCloseEvent

docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnManagerStartEvent

docs/api/ZM/Annotation/Swoole/OnMessageEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnMessageEvent

docs/api/ZM/Annotation/Swoole/OnOpenEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnOpenEvent

docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnPipeMessageEvent

docs/api/ZM/Annotation/Swoole/OnRequestEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnRequestEvent

docs/api/ZM/Annotation/Swoole/OnSave.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnSave

docs/api/ZM/Annotation/Swoole/OnSetup.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnSetup

docs/api/ZM/Annotation/Swoole/OnStart.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnStart

docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnSwooleEvent

docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md

@@ -0,0 +1,23 @@
+# ZM\Annotation\Swoole\OnSwooleEventBase
+
+## setLevel
+
+```php
+public function setLevel(int $level): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| level | int |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/Swoole/OnTask.md

@@ -0,0 +1,17 @@
+# ZM\Annotation\Swoole\OnTask
+
+## getRule
+
+```php
+public function getRule(): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Annotation/Swoole/OnTaskEvent.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnTaskEvent

docs/api/ZM/Annotation/Swoole/OnTick.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\OnTick

docs/api/ZM/Annotation/Swoole/SwooleHandler.md

@@ -0,0 +1 @@
+# ZM\Annotation\Swoole\SwooleHandler

docs/api/ZM/Command/BuildCommand.md

@@ -0,0 +1 @@
+# ZM\Command\BuildCommand

docs/api/ZM/Command/CheckConfigCommand.md

@@ -0,0 +1,25 @@
+# ZM\Command\CheckConfigCommand
+
+## check
+
+```php
+public function check(mixed $remote, mixed $local, Symfony\Component\Console\Output\OutputInterface $out): mixed
+```
+
+### 描述
+
+作者很懒，什么也没有说
+
+### 参数
+
+| 名称 | 类型 | 描述 |
+| -------- | ---- | ----------- |
+| remote | mixed |  |
+| local | mixed |  |
+| out | Symfony\Component\Console\Output\OutputInterface |  |
+
+### 返回
+
+| 类型 | 描述 |
+| ---- | ----------- |
+| mixed |  |

docs/api/ZM/Command/Daemon/DaemonCommand.md

@@ -0,0 +1 @@
+# ZM\Command\Daemon\DaemonCommand

docs/api/ZM/Command/Daemon/DaemonReloadCommand.md

@@ -0,0 +1 @@
+# ZM\Command\Daemon\DaemonReloadCommand

docs/api/ZM/Command/Daemon/DaemonStatusCommand.md

@@ -0,0 +1 @@
+# ZM\Command\Daemon\DaemonStatusCommand

docs/api/ZM/Command/Daemon/DaemonStopCommand.md

@@ -0,0 +1 @@
+# ZM\Command\Daemon\DaemonStopCommand