mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-03-17 20:54:52 +08:00
change ALL docs from MkDocs to VuePress!!
This commit is contained in:
crazywhalecc
parent
c7df37b17c
commit
dbd78d4b86
@ -1,4 +1,4 @@
|
||||
name: MkDocs Auto Deploy
|
||||
name: VuePress Auto Deploy
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
@ -13,15 +13,14 @@ jobs:
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Deploy docs to GitHub Pages
|
||||
uses: mhausenblas/mkdocs-deploy-gh-pages@master
|
||||
uses: jenkey2011/vuepress-deploy@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
CUSTOM_DOMAIN: framework.zhamao.me
|
||||
CONFIG_FILE: mkdocs.yml
|
||||
EXTRA_PACKAGES: build-base
|
||||
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}/site" "./deploy"
|
||||
cp -r "${GITHUB_WORKSPACE}/docs/.vuepress/dist" "./deploy"
|
||||
- name: Deploy to Zhamao Server
|
||||
uses: easingthemes/ssh-deploy@main
|
||||
env:
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@ -26,4 +26,9 @@ composer.lock
|
||||
.zm_worker_*.pid
|
||||
|
||||
# Git Hook 的相关锁文件
|
||||
cghooks.lock
|
||||
cghooks.lock
|
||||
|
||||
# Vuepress 相关文件
|
||||
/node_modules/
|
||||
/docs/.vuepress/dist/
|
||||
package-lock.json
|
||||
141
docs/.vuepress/components/ChatBox.vue
Normal file
141
docs/.vuepress/components/ChatBox.vue
Normal file
@ -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="http://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>
|
||||
187
docs/.vuepress/config.js
Normal file
187
docs/.vuepress/config.js
Normal file
@ -0,0 +1,187 @@
|
||||
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: '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'
|
||||
]
|
||||
},
|
||||
{
|
||||
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'
|
||||
]
|
||||
},
|
||||
],
|
||||
'/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'
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
1
docs/.vuepress/public/CNAME
Normal file
1
docs/.vuepress/public/CNAME
Normal file
@ -0,0 +1 @@
|
||||
framework.zhamao.me
|
||||
BIN
docs/.vuepress/public/logo_trans.png
Normal file
BIN
docs/.vuepress/public/logo_trans.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
1
docs/.vuepress/styles/palette.less
Normal file
1
docs/.vuepress/styles/palette.less
Normal file
@ -0,0 +1 @@
|
||||
@accentColor: #3665aa;
|
||||
18
docs/README.md
Normal file
18
docs/README.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
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 | Copyright © 2019-2022 Zhamao Developer Team | <a href="http://beian.miit.gov.cn">沪ICP备2021010446号-1</a>
|
||||
---
|
||||
4
docs/advanced/README.md
Normal file
4
docs/advanced/README.md
Normal file
@ -0,0 +1,4 @@
|
||||
# 进阶开发
|
||||
在本章，下面的部分将详细说明一些具体的案例和自定义框架的操作。
|
||||
|
||||
> 更多进阶教程敬请期待....（或者你可以选择提 Issue 到框架 GitHub，有需求就写入文档）
|
||||
@ -11,9 +11,11 @@
|
||||
|
||||
以上两种方式，`Header` 方式比 `GET` 方式优先级要高，如果两者均没有指定，框架会将此连接当作 `default` 类型接入。
|
||||
|
||||
!!! note "提示"
|
||||
::: tip 提示
|
||||
|
||||
对于对接 OneBot 标准的机器人客户端，只要符合 OneBot 标准，即 `X-Client-Role` 会自动带上 `universal`、`qq` 等字样，就会自动标记为 `qq` 类型。
|
||||
对于对接 OneBot 标准的机器人客户端，只要符合 OneBot 标准，即 `X-Client-Role` 会自动带上 `universal`、`qq` 等字样，就会自动标记为 `qq` 类型。
|
||||
|
||||
:::
|
||||
|
||||
## 逻辑编写
|
||||
|
||||
@ -140,4 +142,3 @@ public function onMessage() {
|
||||
```php
|
||||
server()->close($conn->getFd());
|
||||
```
|
||||
|
||||
|
||||
@ -5,8 +5,10 @@
|
||||
从前面的几章中，我们了解到框架有多种下载到本地的方式。
|
||||
|
||||
- Composer 依赖模式
|
||||
- Starter 从模板创建模式
|
||||
- Starter 从模板创建模式（等同于 Composer 模式）
|
||||
- 源码模式
|
||||
- Phar Composer 依赖模式
|
||||
- Phar 源码模式
|
||||
|
||||
### Composer 依赖模式
|
||||
|
||||
@ -131,4 +133,4 @@ vendor/bin/start simple-http-server your-web-dir/ --host=0.0.0.0 --port=8080
|
||||
|
||||
命令：`vendor/bin/start systemd:generate`
|
||||
|
||||
注意，systemd 启动的守护进程模式和使用参数 `--daemon` 不一样，请勿同时混用，直接使用上述命令生成的配置文件即可正常使用！
|
||||
注意，systemd 启动的守护进程模式和使用参数 `--daemon` 不一样，请勿同时混用，直接使用上述命令生成的配置文件即可正常使用！
|
||||
|
||||
@ -87,14 +87,13 @@ class AdminMiddleware implements MiddlewareInterface
|
||||
*/
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
^ 假设我是管理员
|
||||
) 禁言 1234567 600
|
||||
( 禁言成功！
|
||||
^ 假设我不在管理员名单里
|
||||
) 禁言 1234567 900
|
||||
^ 机器人没有回复，因为中间件返回了 false，不继续执行
|
||||
</chat-box>
|
||||
<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`）的话，可以直接给类注解这个中间件，效果等同于给每一个函数写一次中间件注解。
|
||||
|
||||
@ -120,112 +119,111 @@ class AdminFunc
|
||||
|
||||
上面我们讲到了，中间件里面使用了 `LightCache` 轻量缓存来储存临时的管理员列表，那么我们将这部分的代码完善吧！
|
||||
|
||||
=== "src/Module/Example/AdminFunc.php"
|
||||
**src/Module/Example/AdminFunc.php**
|
||||
|
||||
```php
|
||||
<?php
|
||||
```php
|
||||
<?php
|
||||
|
||||
namespace Module\Example;
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQCommand;
|
||||
use ZM\Annotation\Http\Middleware;
|
||||
use ZM\API\CQ;
|
||||
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 "禁言成功！";
|
||||
}
|
||||
|
||||
/**
|
||||
* Class AdminFunc
|
||||
* @package Module\Example
|
||||
* @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")
|
||||
*/
|
||||
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 "解除禁言成功！";
|
||||
}
|
||||
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 到管理员列表！";
|
||||
}
|
||||
```
|
||||
|
||||
=== "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>
|
||||
^ 现在我是 123456
|
||||
) 禁言 13579 60
|
||||
( 禁言成功！
|
||||
) 解除禁言 13579
|
||||
( 解除禁言成功！
|
||||
) 添加管理员 98765
|
||||
( 成功添加 98765 到管理员列表！
|
||||
^ 现在我是98765
|
||||
) 禁言 13579
|
||||
( 请输入禁言的时间（秒）
|
||||
) 120
|
||||
( 禁言成功！
|
||||
</chat-box>
|
||||
}
|
||||
```
|
||||
|
||||
<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>
|
||||
|
||||
@ -3,8 +3,8 @@
|
||||
作为一个群聊机器人，懂得聊天会让机器人增色不少，在大数据和 AI 热潮下，不少厂商都研发了自己的智能聊天 API，例如图灵机器人、腾讯智能闲聊等，大厂开发的 API 自然有着他人无可比拟的健壮性和可靠性，但是随之而来不菲的价格显然并不适合大众开发者。这时候一个免费、可用的智能聊天 API 便非常重要了，其中，青云客是少有的完全免费、无需注册的智能聊天 API，提供了包括智能聊天、歌词、天气查询、笑话等多种有用功能，且接入简单，非常适合新手开发者尝试。
|
||||
|
||||
## 结果演示
|
||||
|
||||
|
||||
|
||||
|
||||
## 阅读接入指南
|
||||
|
||||
@ -83,6 +83,3 @@ public function changeAt(): bool
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,20 +3,24 @@
|
||||
本文将基于 [`jieba-php`](https://github.com/fukuball/jieba-php) 中文分词库以及 [魅族天气 API](https://github.com/shichunlei/-Api/blob/master/MeizuWeather.md) 开发一个天气查询机器人。
|
||||
|
||||
## 结果演示
|
||||
|
||||
|
||||
尾部的随机表情并非本教程的一部分。
|
||||
|
||||
## 逻辑编写
|
||||
|
||||
[`jieba-php`](https://github.com/fukuball/jieba-php) 是目前比较好用的中文分词库，虽然最近的维护并不活跃，但已足够我们的需求：
|
||||
[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
|
||||
@ -107,6 +111,3 @@ EOF;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,4 +3,3 @@
|
||||
## 框架运行总结构图
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# 进阶开发
|
||||
在本章，下面的部分将详细说明一些具体的案例和自定义框架的操作。
|
||||
|
||||
- 如何自定义修改框架本身？- [框架启动方式](/advanced/custom-start/)
|
||||
- 如何接入一个自己的 WebSocket 客户端？- [接入 WebSocket 客户端](/advanced/connect-ws-client/)
|
||||
- 框架到底是怎么工作的？- [框架结构剖析](/advanced/framework-structure/)
|
||||
|
||||
> 更多进阶教程敬请期待....（或者你可以选择提 Issue 到框架 GitHub，有需求就写入文档）
|
||||
|
||||
@ -65,6 +65,3 @@ $obj->match ==> [
|
||||
]
|
||||
*/
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# 手动部署环境教程
|
||||
|
||||
TODO: 还没写
|
||||
TODO: 还没写
|
||||
|
||||
@ -67,4 +67,3 @@ PHP 也是如此，框架的多进程又是怎么一回事呢？为什么要采
|
||||
对于 WorkerCache 来说，其实是比较特殊的进程间通信。具体来说就是，WorkerCache 的原理就是将变量指定的存到一个进程中，如果是本进程读写的话直接相当于改一下全局变量，如果是其他进程读写的话，则依靠进程间通信。
|
||||
|
||||
所以缺点也显而易见，如果使用过程中不是命中了 WorkerCache 存储所在的进程的话，则一直会使用进程间通信，影响一定的效率。
|
||||
|
||||
|
||||
3
docs/advanced/php-env.md
Normal file
3
docs/advanced/php-env.md
Normal file
@ -0,0 +1,3 @@
|
||||
# PHP 环境高级部署方式
|
||||
|
||||
TODO: 留个坑。
|
||||
@ -1,4 +1,3 @@
|
||||
# 使用 TaskWorker 进程处理密集运算
|
||||
|
||||
> 新开个坑，有时间补上。（__填坑标记__）
|
||||
|
||||
> TODO: 新开个坑，有时间补上。（__填坑标记__）
|
||||
|
||||
@ -1,103 +0,0 @@
|
||||
|
||||
.md-header-nav__button.md-logo {
|
||||
padding: .2rem;
|
||||
margin: .2rem;
|
||||
}
|
||||
|
||||
.md-header-nav__button.md-logo img, .md-header-nav__button.md-logo svg {
|
||||
width: 1.6rem;
|
||||
height: 1.6rem;
|
||||
}
|
||||
|
||||
.doc-chat-container {
|
||||
border-radius: 6px;
|
||||
width: 100%;
|
||||
min-height: 30px;
|
||||
/*noinspection CssUnresolvedCustomProperty*/
|
||||
background-color: var(--md-code-bg-color);
|
||||
padding: 12px;
|
||||
margin-right: auto;
|
||||
margin-left: auto;
|
||||
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;
|
||||
}
|
||||
|
||||
.md-typeset .admonition, .md-typeset details {
|
||||
font-size: .72rem;
|
||||
}
|
||||
1
docs/assets/css/library/default.min.css
vendored
1
docs/assets/css/library/default.min.css
vendored
@ -1 +0,0 @@
|
||||
.hljs{display:block;overflow-x:auto;padding:.5em;background:#f0f0f0}.hljs,.hljs-subst{color:#444}.hljs-comment{color:#888}.hljs-attribute,.hljs-doctag,.hljs-keyword,.hljs-meta-keyword,.hljs-name,.hljs-selector-tag{font-weight:700}.hljs-deletion,.hljs-number,.hljs-quote,.hljs-selector-class,.hljs-selector-id,.hljs-string,.hljs-template-tag,.hljs-type{color:#800}.hljs-section,.hljs-title{color:#800;font-weight:700}.hljs-link,.hljs-regexp,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-symbol,.hljs-template-variable,.hljs-variable{color:#bc6060}.hljs-literal{color:#78a960}.hljs-addition,.hljs-built_in,.hljs-bullet,.hljs-code{color:#397300}.hljs-meta{color:#1f7199}.hljs-meta-string{color:#4d99bf}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB |
3
docs/component/README.md
Normal file
3
docs/component/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# 框架组件
|
||||
|
||||
这里列举了框架内的你可能会用到的常用组件。
|
||||
@ -1,4 +1,4 @@
|
||||
# Token 验证
|
||||
# 接入安全验证 - Token
|
||||
|
||||
为了保障安全，框架支持给接入的 WebSocket 连接验证 Token，如果不设置 Token 同时又将框架的端口暴露在公网将会非常危险。
|
||||
|
||||
@ -27,9 +27,9 @@
|
||||
|
||||
go-cqhttp 的配置段：
|
||||
|
||||
```hjson
|
||||
// 访问密钥, 强烈推荐在公网的服务器设置
|
||||
access_token: "emhhbWFvLXJvYm90"
|
||||
```
|
||||
// 访问密钥, 强烈推荐在公网的服务器设置
|
||||
access_token: "emhhbWFvLXJvYm90"
|
||||
```
|
||||
|
||||
框架的配置文件配置段：
|
||||
@ -56,4 +56,4 @@ $config["access_token"] = function($token){
|
||||
|
||||
## 自定义验证（open 事件）
|
||||
|
||||
当然，这里设置了自定义方式，其实你也可以在下一层的 `@OnOpenEvent` 注解事件中进行自定义内容和判断，具体见 `@OnOpenEvent` 的相关章节。
|
||||
当然，这里设置了自定义方式，其实你也可以在下一层的 `@OnOpenEvent` 注解事件中进行自定义内容和判断，具体见 `@OnOpenEvent` 的相关章节。
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# CQ 码（多媒体消息）
|
||||
# 多媒体消息 - CQ码
|
||||
|
||||
消息中的多媒体内容使用 CQ 码来表示，形如 `[CQ:face,id=178]`。其中，`[CQ:]` 是固定格式；`face` 是「功能名」，除了 `face` 还有许多不同的功能名；`id=178` 是「参数」，某些功能不需要参数，而另一些需要多个参数，当有多个参数时，参数间使用逗号分隔。
|
||||
|
||||
@ -14,11 +14,13 @@
|
||||
|
||||
更多 CQ 码功能请参考 [消息段类型](https://github.com/howmanybots/onebot/blob/master/v11/specs/message/segment.md)。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
CQ 码中不应有多余的空格，例如不应该使用 `[CQ:face, id=178]`。
|
||||
CQ 码中不应有多余的空格，例如不应该使用 `[CQ:face, id=178]`。
|
||||
|
||||
CQ 码的参数值可以包含空格、换行、除 `[],&` 之外的特殊符号等。在解析时，应直接取 `[CQ:` 后、第一个 `,` 或 `]` 前的部分为功能名，第一个 `,` 之后到 `]` 之间的部分为参数，按 `,` 分割后，每个部分第一个 `=` 前的内容为参数名，之后的部分为参数值。例如 `[CQ:share,title=标题中有=等号,url=http://baidu.com]` 中，功能名为 `share`，`title` 参数值为 `标题中有=等号`，`url` 参数值为 `http://baidu.com`。
|
||||
CQ 码的参数值可以包含空格、换行、除 `[],&` 之外的特殊符号等。在解析时，应直接取 `[CQ:` 后、第一个 `,` 或 `]` 前的部分为功能名，第一个 `,` 之后到 `]` 之间的部分为参数，按 `,` 分割后，每个部分第一个 `=` 前的内容为参数名，之后的部分为参数值。例如 `[CQ:share,title=标题中有=等号,url=http://baidu.com]` 中，功能名为 `share`，`title` 参数值为 `标题中有=等号`，`url` 参数值为 `http://baidu.com`。
|
||||
|
||||
:::
|
||||
|
||||
## 转义
|
||||
|
||||
@ -69,12 +71,12 @@ class Hello {
|
||||
}
|
||||
```
|
||||
|
||||
效果
|
||||
效果：
|
||||
|
||||
<chat-box>
|
||||
) 发送图片
|
||||
[ https://zhamao.xin/file/hello.jpg
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'发送图片'},
|
||||
{type:3,content:'https://zhamao.xin/file/hello.jpg'}
|
||||
]"></chat-box>
|
||||
|
||||
## CQ 码操作
|
||||
|
||||
@ -191,15 +193,17 @@ public function faceTest() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) 打盹
|
||||
( 正在打盹...
|
||||
[ https://docs-v1.zhamao.xin/face/8.gif
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'打盹'},
|
||||
{type:1,content:'正在打盹...'},
|
||||
{type:3,content:'https://docs-v1.zhamao.xin/face/8.gif'},
|
||||
]"></chat-box>
|
||||
|
||||
!!! note "提示"
|
||||
对于不断更新的 QQ 版本下，可能会持续扩充新的 QQ 表情，如果上表没有新的表情的话，也可以使用消息接收的方式，让机器人收到表情后解析出来对应的 id 然后再发送。
|
||||
::: tip 提示
|
||||
|
||||
对于不断更新的 QQ 版本下，可能会持续扩充新的 QQ 表情，如果上表没有新的表情的话，也可以使用消息接收的方式，让机器人收到表情后解析出来对应的 id 然后再发送。
|
||||
|
||||
:::
|
||||
|
||||
### CQ::image() - 发送图片
|
||||
|
||||
@ -221,7 +225,11 @@ public function faceTest() {
|
||||
|
||||
- 绝对路径，例如 `file:///root/imagetest/1.png`，格式使用 [`file` URI](https://tools.ietf.org/html/rfc8089)
|
||||
- 网络 URL，例如 `http://i1.piimg.com/567571/fdd6e7b6d93f1ef0.jpg`
|
||||
- Base64 编码，例如 `base64://iVBORw0KGgoAAAANSUhEUgAAABQAAAAVCAIAAADJt1n/AAAAKElEQVQ4EWPk5+RmIBcwkasRpG9UM4mhNxpgowFGMARGEwnBIEJVAAAdBgBNAZf+QAAAAABJRU5ErkJggg==`
|
||||
- Base64 编码，例如
|
||||
|
||||
```
|
||||
base64://iVBORw0KGgoAAAANSUhEUgAAABQAAAAVCAIAAADJt1n/AAAAKElEQVQ4EWPk5+RmIBcwkasRpG9UM4mhNxpgowFGMARGEwnBIEJVAAAdBgBNAZf+QAAAAABJRU5ErkJggg==
|
||||
```
|
||||
|
||||
### CQ::record() - 发送语音
|
||||
|
||||
@ -250,10 +258,10 @@ public function say() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) 说你好
|
||||
( [语音消息，点击收听] 2'' )))
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'说你好'},
|
||||
{type:1,content:'[语音消息，点击收听] 2\'\' )))'},
|
||||
]"></chat-box>
|
||||
|
||||
> 此 CQ 码只能用于单独一条文本消息中，如果混有其他字符串，则会吞掉其他字符串内容。
|
||||
|
||||
@ -274,10 +282,10 @@ public function atTest() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) at测试
|
||||
( @鲸鱼 你好啊！
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'at测试'},
|
||||
{type:1,content:'@鲸鱼 你好啊！'},
|
||||
]"></chat-box>
|
||||
|
||||
### CQ::video() - 发送短视频
|
||||
|
||||
@ -346,9 +354,11 @@ public function atTest() {
|
||||
|
||||
匿名发消息。需要在允许匿名发消息的群里发。
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
当收到匿名消息时，需要通过 [消息事件的群消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/message.md#群消息) 的 `anonymous` 字段判断。
|
||||
当收到匿名消息时，需要通过 [消息事件的群消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/message.md#群消息) 的 `anonymous` 字段判断。
|
||||
|
||||
:::
|
||||
|
||||
定义：`CQ::anonymous($ignore = 1)`
|
||||
|
||||
@ -515,9 +525,11 @@ public function xmlTest() {
|
||||
|
||||
其中 `$resid` 是面向 go-cqhttp 扩展的参数，默认不填为 0，走小程序通道，填了走富文本通道发送。
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
因为某些众所周知的原因，XML 和 JSON 的返回不提供实例，有兴趣的可以自行研究如何编写，文档不含任何相关教程。
|
||||
因为某些众所周知的原因，XML 和 JSON 的返回不提供实例，有兴趣的可以自行研究如何编写，文档不含任何相关教程。
|
||||
|
||||
:::
|
||||
|
||||
### CQ::_custom() - 扩展自定义 CQ 码
|
||||
|
||||
@ -536,4 +548,3 @@ public function xmlTest() {
|
||||
CQ::_custom("at",["qq" => "123456","qwe" => "asd"]);
|
||||
// 返回：[CQ:at,qq=123456,qwe=asd]
|
||||
```
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# MessageUtil 消息处理工具类
|
||||
# 消息处理工具类 - MessageUtil
|
||||
|
||||
类定义：`\ZM\Utils\MessageUtil`
|
||||
|
||||
@ -81,9 +81,11 @@ MessageUtil::isAtMe("[CQ:at,qq=123456789]另一个朋友你好","123456"); // fa
|
||||
|
||||
返回：数组，切分后的。
|
||||
|
||||
!!! tip "为什么不直接使用 explode 呢"
|
||||
::: tip 为什么不直接使用 explode 呢
|
||||
|
||||
因为 `explode()` 只会简单粗暴的切割字符串，假设用户输入的消息中两个词中间有多个空格，则会有空的词出现。例如 `你好 我是一个长空格`。此函数会将多个空格当作一个空格来对待。
|
||||
因为 `explode()` 只会简单粗暴的切割字符串，假设用户输入的消息中两个词中间有多个空格，则会有空的词出现。例如 `你好 我是一个长空格`。此函数会将多个空格当作一个空格来对待。
|
||||
|
||||
:::
|
||||
|
||||
```php
|
||||
MessageUtil::splitCommand("你好 我是傻瓜\n我是傻瓜二号"); // ["你好","我是傻瓜","我是傻瓜二号"]
|
||||
@ -123,10 +125,10 @@ public function onStart() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) 炸毛不聪明
|
||||
( 其实还是很聪明的！
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'炸毛不聪明'},
|
||||
{type:1,content:'其实还是很聪明的！'},
|
||||
]"></chat-box>
|
||||
|
||||
### strToArray()
|
||||
|
||||
@ -176,4 +178,4 @@ $arr = \ZM\Utils\MessageUtil::strToArray($str);
|
||||
// 我们使用上边的 $arr 作为传入值。
|
||||
$new_str = \ZM\Utils\MessageUtil::arrayToStr($arr);
|
||||
// 结果："你好啊，[CQ:at,qq=123]"
|
||||
```
|
||||
```
|
||||
|
||||
@ -1,9 +1,11 @@
|
||||
# 机器人 API（OneBotV12）（待发布）
|
||||
# 机器人动作 - V12
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
目前由于 OneBot 12 标准还没有定稿，处于草案阶段，故框架暂不更新。
|
||||
|
||||
在未来升级到 OneBot 12 标准后，框架会提供转换及兼容措施以及 12 版本的 API 方法。
|
||||
目前由于 OneBot 12 标准还没有定稿，处于草案阶段，故框架暂不更新。
|
||||
|
||||
见 [机器人动作（OneBot 11）](../robot-api)。
|
||||
在未来升级到 OneBot 12 标准后，框架会提供转换及兼容措施以及 12 版本的 API 方法。
|
||||
|
||||
:::
|
||||
|
||||
见 [机器人动作（OneBot 11）](./robot-api.html)。
|
||||
@ -1,4 +1,4 @@
|
||||
# 机器人 API（OneBotV11）
|
||||
# 机器人动作 - V11
|
||||
|
||||
OneBotV11 类是封装好的 OneBot 标准的 API 接口调用类，可以在机器人连接后通过连接或者机器人 QQ 号获取对象并调用接口（如发送群消息、获取群列表等操作）。
|
||||
|
||||
@ -111,8 +111,9 @@ $obj = $bot->sendGroupMsg("234567", "你好");
|
||||
echo json_encode($obj, 128|256);
|
||||
```
|
||||
|
||||
输出结果
|
||||
|
||||
```json
|
||||
// 输出结果
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
@ -161,21 +162,18 @@ vardump($result["retcode"]); //如果成功撤回，输出 int(0)
|
||||
| ------------ | -------------- | ------- |
|
||||
| `message_id` | number (int32) | 消息 ID |
|
||||
|
||||
例子
|
||||
代码
|
||||
|
||||
=== "代码"
|
||||
```php
|
||||
$bot = OneBotV11::get(123456); // 123456是你的机器人QQ
|
||||
$bot->sendPrivateMsg("627577391", "你好啊！你好你好！");
|
||||
```
|
||||
|
||||
```php
|
||||
$bot = OneBotV11::get(123456); // 123456是你的机器人QQ
|
||||
$bot->sendPrivateMsg("627577391", "你好啊！你好你好！");
|
||||
```
|
||||
|
||||
=== "效果"
|
||||
|
||||
<chat-box>
|
||||
( 你好啊！你好你好！
|
||||
</chat-box>
|
||||
效果
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:1,content:'你好啊！你好你好！'}
|
||||
]"></chat-box>
|
||||
|
||||
### sendGroupMsg()
|
||||
|
||||
@ -621,10 +619,11 @@ vardump($result["retcode"]); //如果成功撤回，输出 int(0)
|
||||
|
||||
获取 Cookies。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
目前开源的 mirai 为底层的机器人客户端均不支持获取 Cookies 和 CSRF Token，包括 go-cqhttp。
|
||||
目前开源的 mirai 为底层的机器人客户端均不支持获取 Cookies 和 CSRF Token，包括 go-cqhttp。
|
||||
|
||||
:::
|
||||
|
||||
参数
|
||||
|
||||
@ -780,9 +779,11 @@ vardump($result["retcode"]); //如果成功撤回，输出 int(0)
|
||||
|
||||
唯一一个参数做保留，用于选择不同客户端，目前仅支持 `go-cqhttp`，所以缺省也默认为 `go-cqhttp`。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
由于不同版本的扩展 API 变化可能会很大，改动较多，炸毛框架不会将对应扩展方法写入文档，具体调用情况可根据 IDE 自动补全中的文档或对应类的注释查看。
|
||||
由于不同版本的扩展 API 变化可能会很大，改动较多，炸毛框架不会将对应扩展方法写入文档，具体调用情况可根据 IDE 自动补全中的文档或对应类的注释查看。
|
||||
|
||||
:::
|
||||
|
||||
### callExtendedAPI() （扩充 API）
|
||||
|
||||
@ -805,4 +806,3 @@ $result = $bot->callExtendedAPI("get_group_root_files", ["group_id" => 123456]);
|
||||
var_dump($result["data"]);
|
||||
// 输出群文件列表
|
||||
```
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# 图灵机器人 API（TuringAPI）
|
||||
# 图灵聊天 - TuringAPI
|
||||
|
||||
类定义：`\ZM\API\TuringAPI`
|
||||
|
||||
@ -60,27 +60,27 @@ class Hello {
|
||||
|
||||
如上述代码，我们将申请的 apikey 填入变量 `$api` 中，启动机器人即可使用，以下是实测消息（我用自己申请的 key 做测试回复的消息）。
|
||||
|
||||
<chat-box>
|
||||
) 你咋了
|
||||
( 我没事哦，谢谢您的关心。
|
||||
) 上海天气
|
||||
( 上海:周一 03月29日,小雨 东南风转东风,最低气温14度，最高气温24度。
|
||||
^ 切换为群内
|
||||
) 机器人
|
||||
( 我在！有什么事吗？
|
||||
) 你叫啥
|
||||
( 我的名字叫炸毛，认识你很高兴呢！
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'你咋了'},
|
||||
{type:1,content:'我没事哦，谢谢您的关心。'},
|
||||
{type:0,content:'上海天气'},
|
||||
{type:1,content:'上海:周一 03月29日,小雨 东南风转东风,最低气温14度，最高气温24度。'},
|
||||
{type:2,content:'切换为群内'},
|
||||
{type:0,content:'机器人'},
|
||||
{type:1,content:'我在！有什么事吗？'},
|
||||
{type:0,content:'你叫啥'},
|
||||
{type:1,content:'我的名字叫炸毛，认识你很高兴呢！'},
|
||||
]"></chat-box>
|
||||
|
||||
在默认示例模块中的例子是直接可以拿来用的，这段代码同时做了对 at 的处理、以及兼容用户自定义写的其他命令的方式，下面是默认模块填好 apikey 后可以用的各种方式提问：
|
||||
|
||||
<chat-box>
|
||||
^ 切换为群内
|
||||
) 我是一条普通消息，这条机器人不会回复我
|
||||
) @机器人 你叫啥
|
||||
( 我是聪明可爱的炸毛，认识你很高兴。
|
||||
) 机器人
|
||||
( 我在！有什么事吗？
|
||||
) 一言
|
||||
( 多少事，从来急，天地转，光阴迫，一万年太久，只争朝夕。
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'切换为群内'},
|
||||
{type:0,content:'我是一条普通消息，这条机器人不会回复我'},
|
||||
{type:0,content:'@机器人 你叫啥'},
|
||||
{type:1,content:'我是聪明可爱的炸毛，认识你很高兴。'},
|
||||
{type:0,content:'机器人'},
|
||||
{type:1,content:'我在！有什么事吗？'},
|
||||
{type:0,content:'一言'},
|
||||
{type:1,content:'多少事，从来急，天地转，光阴迫，一万年太久，只争朝夕。'},
|
||||
]"></chat-box>
|
||||
|
||||
@ -52,10 +52,11 @@ vendor/bin/start server --log-debug # 以 debug 等级启动框架
|
||||
|
||||
输出 warning 级别的 log。
|
||||
|
||||
!!! warning 注意
|
||||
::: warning 注意
|
||||
|
||||
框架内出现的用户态异常，比如无法发送 API、无法连接数据库等错误，都是 warning 错误，不会导致框架崩溃或功能错误的异常情况建议都使用 warning 输出而不是 error。
|
||||
框架内出现的用户态异常，比如无法发送 API、无法连接数据库等错误，都是 warning 错误，不会导致框架崩溃或功能错误的异常情况建议都使用 warning 输出而不是 error。
|
||||
|
||||
:::
|
||||
|
||||
### Console::info()
|
||||
|
||||
@ -100,9 +101,11 @@ $str = Console::setColor("I am gold color.", "gold");
|
||||
|
||||
炸毛框架支持从终端输入命令来进行一些操作，例如重启框架、停止框架、执行函数等。
|
||||
|
||||
!!! warning 注意
|
||||
::: warning 注意
|
||||
|
||||
在 Docker、systemd、daemon 状态下启动的框架会自动关闭终端等待输入，交互不可用。
|
||||
在 Docker、systemd、daemon 状态下启动的框架会自动关闭终端等待输入，交互不可用。
|
||||
|
||||
:::
|
||||
|
||||
### reload
|
||||
|
||||
@ -174,4 +177,3 @@ vendor/bin/start server --log-theme={主题名}
|
||||
vendor/bin/start server --log-theme=white-term # 如果用的是白色终端，这个主题更友好
|
||||
vendor/bin/start server --log-theme=no-color # 如果不想让 log 带有任何颜色，使用无色主题
|
||||
```
|
||||
|
||||
|
||||
@ -40,31 +40,33 @@ public function hello() {
|
||||
|
||||
可以使用的事件：所有 **getFrame()** 可以使用的，`@OnOpenEvent()`，`@OnCloseEvent()`
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
值得注意的是，由于机器人客户端和炸毛框架的连接是通过 WebSocket 进行的，而 WebSocket 是长连接，所以同一个机器人一次连接下收发消息所用的连接是同一个，所以 Fd 也是相同的。同理，炸毛框架的内部来区分多个机器人也是通过这一 Fd 进行判定的。
|
||||
值得注意的是，由于机器人客户端和炸毛框架的连接是通过 WebSocket 进行的，而 WebSocket 是长连接，所以同一个机器人一次连接下收发消息所用的连接是同一个，所以 Fd 也是相同的。同理，炸毛框架的内部来区分多个机器人也是通过这一 Fd 进行判定的。
|
||||
|
||||
=== "代码"
|
||||
:::
|
||||
|
||||
```php
|
||||
/**
|
||||
* @CQCommand("测试fd")
|
||||
*/
|
||||
public function testfd() {
|
||||
ctx()->reply("当前机器人连接的fd是：".ctx()->getFd()."，机器人QQ是：".ctx()->getRobotId());
|
||||
}
|
||||
```
|
||||
代码
|
||||
|
||||
=== "效果"
|
||||
```php
|
||||
/**
|
||||
* @CQCommand("测试fd")
|
||||
*/
|
||||
public function testfd() {
|
||||
ctx()->reply("当前机器人连接的fd是：".ctx()->getFd()."，机器人QQ是：".ctx()->getRobotId());
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
^ 假设我们和连接55555的机器人的私聊
|
||||
) 测试fd
|
||||
( 当前机器人连接的fd是：1，机器人QQ是：55555
|
||||
^ 假设切到了另一个机器人（66666）的私聊
|
||||
) 测试fd
|
||||
( 当前机器人连接的fd是：2，机器人QQ是：66666
|
||||
</chat-box>
|
||||
效果
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'假设我们和连接55555的机器人的私聊'},
|
||||
{type:0,content:'测试fd'},
|
||||
{type:1,content:'当前机器人连接的fd是：1，机器人QQ是：55555'},
|
||||
{type:2,content:'假设切到了另一个机器人（66666）的私聊'},
|
||||
{type:0,content:'测试fd'},
|
||||
{type:1,content:'当前机器人连接的fd是：2，机器人QQ是：66666'},
|
||||
]"></chat-box>
|
||||
|
||||
## getData() - 获取事件完整数据
|
||||
|
||||
@ -82,11 +84,11 @@ public function onMessage() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
^ 假设我是QQ为123456的用户，私聊发消息
|
||||
) 哈咯！！
|
||||
( 消息类型是：private
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'假设我是QQ为123456的用户，私聊发消息'},
|
||||
{type:0,content:'哈咯！！'},
|
||||
{type:1,content:'消息类型是：private'},
|
||||
]"></chat-box>
|
||||
|
||||
## getRequest() - HTTP 请求对象
|
||||
|
||||
@ -132,10 +134,10 @@ public function ping() {
|
||||
ctx()->getRobot()->sendPrivateMsg(123456, "发送私聊消息");
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
^ 正在和机器人聊天
|
||||
( 发送私聊消息
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'正在和机器人聊天'},
|
||||
{type:1,content:'发送私聊消息'},
|
||||
]"></chat-box>
|
||||
|
||||
## getMessage() - 获取消息
|
||||
|
||||
@ -143,24 +145,26 @@ ctx()->getRobot()->sendPrivateMsg(123456, "发送私聊消息");
|
||||
|
||||
可以使用的事件：`@CQCommand()`，`@CQMessage`，`@CQBefore("message")`，`@CQAfter("message")`
|
||||
|
||||
=== "代码"
|
||||
```php
|
||||
/**
|
||||
* @CQMessage(group_id=33333)
|
||||
*/
|
||||
public function groupRepeat() {
|
||||
ctx()->reply(ctx()->getMessage());
|
||||
}
|
||||
```
|
||||
代码
|
||||
|
||||
=== "效果"
|
||||
<chat-box>
|
||||
^ 现在在群33333内，机器人已经成了复读机
|
||||
) 来世还做复读机！！！
|
||||
( 来世还做复读机！！！
|
||||
) 你不许复读！
|
||||
( 你不许复读！
|
||||
</chat-box>
|
||||
```php
|
||||
/**
|
||||
* @CQMessage(group_id=33333)
|
||||
*/
|
||||
public function groupRepeat() {
|
||||
ctx()->reply(ctx()->getMessage());
|
||||
}
|
||||
```
|
||||
|
||||
效果
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'现在在群33333内，机器人已经成了复读机'},
|
||||
{type:0,content:'来世还做复读机！！！'},
|
||||
{type:1,content:'来世还做复读机！！！'},
|
||||
{type:0,content:'你不许复读！'},
|
||||
{type:1,content:'你不许复读！'},
|
||||
]"></chat-box>
|
||||
|
||||
## getUserId() - 获取用户 QQ 号
|
||||
|
||||
@ -275,16 +279,16 @@ function yourName(){
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) 自我介绍
|
||||
( 你叫啥名字呀？
|
||||
) jerry
|
||||
( 好的，可爱的机器人记住你叫 jerry 啦！以后多聊天哦！
|
||||
) 自我介绍
|
||||
( 你叫啥名字呀？
|
||||
^ 10分钟没理机器人
|
||||
( 你都10分钟不理我了，嘤嘤嘤
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'自我介绍'},
|
||||
{type:1,content:'你叫啥名字呀？'},
|
||||
{type:0,content:'jerry'},
|
||||
{type:1,content:'好的，可爱的机器人记住你叫 jerry 啦！以后多聊天哦！'},
|
||||
{type:0,content:'自我介绍'},
|
||||
{type:1,content:'你叫啥名字呀？'},
|
||||
{type:2,content:'10分钟没理机器人'},
|
||||
{type:1,content:'你都10分钟不理我了，嘤嘤嘤'},
|
||||
]"></chat-box>
|
||||
|
||||
## getArgs() - 自动获取参数
|
||||
|
||||
@ -316,12 +320,12 @@ public function argTest1() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) test
|
||||
( 请输入你要传入的参数内容
|
||||
) test2
|
||||
( 参数内容：test2
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'test'},
|
||||
{type:1,content:'请输入你要传入的参数内容'},
|
||||
{type:0,content:'test2'},
|
||||
{type:1,content:'参数内容：test2'},
|
||||
]"></chat-box>
|
||||
|
||||
`getArgs()` 也有三层封装，在使用过程中避免麻烦的话，推荐使用下面这几种 `get*Arg()` 方式。
|
||||
|
||||
@ -341,14 +345,14 @@ public function argTest1() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) test abc def argtest
|
||||
( 参数内容：abc def argtest
|
||||
) test
|
||||
( 请输入你要传入的参数内容
|
||||
) abc def
|
||||
( 参数内容：abc def
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'test abc def argtest'},
|
||||
{type:1,content:'参数内容：abc def argtest'},
|
||||
{type:0,content:'test'},
|
||||
{type:1,content:'请输入你要传入的参数内容'},
|
||||
{type:0,content:'abc def'},
|
||||
{type:1,content:'参数内容：abc def'},
|
||||
]"></chat-box>
|
||||
|
||||
## getNextArg()
|
||||
|
||||
@ -364,14 +368,14 @@ public function argTest1() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) test abc def argtest
|
||||
( 参数内容：abc
|
||||
) test
|
||||
( 请输入你要传入的参数内容
|
||||
) abc
|
||||
( 参数内容：abc
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'test abc def argtest'},
|
||||
{type:1,content:'参数内容：abc'},
|
||||
{type:0,content:'test'},
|
||||
{type:1,content:'请输入你要传入的参数内容'},
|
||||
{type:0,content:'abc'},
|
||||
{type:1,content:'参数内容：abc'},
|
||||
]"></chat-box>
|
||||
|
||||
## getNumArg()
|
||||
|
||||
@ -389,14 +393,14 @@ public function argTest1() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) test abc 334 argtest
|
||||
( 数字参数内容：334
|
||||
) test abc
|
||||
( 请输入你要传入的数字内容
|
||||
) 998
|
||||
( 参数内容：998
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'test abc 334 argtest'},
|
||||
{type:1,content:'数字参数内容：334'},
|
||||
{type:0,content:'test abc'},
|
||||
{type:1,content:'请输入你要传入的参数内容'},
|
||||
{type:0,content:'998'},
|
||||
{type:1,content:'参数内容：998'},
|
||||
]"></chat-box>
|
||||
|
||||
## copy()
|
||||
|
||||
@ -418,8 +422,7 @@ public function argTest1() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) test abc 334 argtest
|
||||
( 参数内容：abc, 334, argtest
|
||||
</chat-box>
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'test abc 334 argtest'},
|
||||
{type:1,content:'参数内容：abc, 334, argtest'},
|
||||
]"></chat-box>
|
||||
|
||||
@ -60,4 +60,3 @@ for($i = 0; $i < 1000; ++$i) {
|
||||
`$name` 为字符串，是你要用的协程池的名称。
|
||||
|
||||
`$size` 为大小，最大不可超过 Swoole 配置文件中指定的最大协程数量。
|
||||
|
||||
|
||||
@ -101,4 +101,4 @@ public function randNum() {
|
||||
|
||||
## EventDispatcher::enableEventTrace() - 启用事件跟踪器
|
||||
|
||||
还没写完，不着急。
|
||||
还没写完，不着急。
|
||||
|
||||
@ -8,35 +8,35 @@
|
||||
|
||||
根据加载的用户编写的代码类名来获取类所在的文件路径。
|
||||
|
||||
=== "src/Module/Example/Hello.php"
|
||||
**src/Module/Example/Hello.php**
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
class Hello { ... }
|
||||
```
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
class Hello { ... }
|
||||
```
|
||||
|
||||
=== "src/Module/Example/Start.php"
|
||||
**src/Module/Example/Start.php**
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
use ZM\Annotation\Swoole\OnStart;
|
||||
class Start {
|
||||
/**
|
||||
* @OnStart()
|
||||
*/
|
||||
public function onStart() {
|
||||
Console::info("Path: ".getClassPath(Hello::class));
|
||||
}
|
||||
}
|
||||
```
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
use ZM\Annotation\Swoole\OnStart;
|
||||
class Start {
|
||||
/**
|
||||
* @OnStart()
|
||||
*/
|
||||
public function onStart() {
|
||||
Console::info("Path: ".getClassPath(Hello::class));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
=== "输出结果"
|
||||
**输出结果**
|
||||
|
||||
```
|
||||
[11:12:02] [I] [#0] Path: /mnt/d/project/zhamao-framework/src/Module/Example/Hello.ph
|
||||
```
|
||||
```
|
||||
[11:12:02] [I] [#0] Path: /mnt/d/project/zhamao-framework/src/Module/Example/Hello.ph
|
||||
```
|
||||
|
||||
## explodeMsg()
|
||||
|
||||
@ -289,7 +289,7 @@ zm_dump($pass);
|
||||
|
||||
定义：`zm_config($name, $key = null)`。
|
||||
|
||||
有关 ZMConfig 模块的说明，见 [指南 - 基本配置](/guide/basic-config/)。
|
||||
有关 ZMConfig 模块的说明，见 [指南 - 基本配置](/guide/basic-config)。
|
||||
|
||||
```php
|
||||
zm_config("global"); //等同于 ZMConfig::get("global");
|
||||
@ -321,4 +321,3 @@ zm_config("global", "swoole"); //等同于 ZMConfig::get("global", "swoole");
|
||||
## zm_verbose()
|
||||
|
||||
同 `Console::verbose($msg)`。
|
||||
|
||||
|
||||
@ -1,37 +1,44 @@
|
||||
# 远程终端
|
||||
|
||||
框架在 2.3 版本时删除了本地终端（就是框架启动后可以在终端输入一些参数），因为框架的多进程模式会导致终端输入错乱，所以暂时取消掉了。
|
||||
|
||||
而远程终端应运而生，为的是弥补这一功能。与之前不同的是，远程终端使用 nc 连接，无需任何其他组件和客户端，而且功能更丰富，支持自定义命令。
|
||||
|
||||
## 启用
|
||||
|
||||
有两种开启方式：
|
||||
|
||||
- 永久开启：全局配置文件中找到 `remote_terminal` 的 `status`，改为 true，启动框架即可。
|
||||
- 临时开启：启动框架时加上参数 `--remote-terminal`。例如：`vendor/bin/start server --remote-terminal`。
|
||||
|
||||
## 配置
|
||||
|
||||
在一般情况下，框架为了安全，直接按照默认配置，会监听 `127.0.0.1:20002` 端口，不可以远程访问，只能使用本机的 nc 连接，效果如下：
|
||||
|
||||
本地主机：
|
||||
|
||||
|
||||
|
||||
从别的主机：
|
||||
|
||||
|
||||
|
||||
如果将 `host` 改为 `0.0.0.0` 或对应监听地址，即可指向性访问。
|
||||
|
||||
但是，如果你又想远程连接，又想保证安全，那么可以设置一个 token 参数，来保证连接时需要输入 token 才能使用远程终端。
|
||||
假设我们的 token 是 `iAMTokEn`：
|
||||
|
||||
|
||||
|
||||
|
||||
## 使用
|
||||
|
||||
默认情况下，使用 `nc` 命令即可。
|
||||
|
||||
```bash
|
||||
nc <your-host> <your-port> -vvv
|
||||
# nc 127.0.0.1 20002 -vvv
|
||||
```
|
||||
|
||||
输入 help 即可查看内置的常用指令：
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# 单例类（SingletonTrait）
|
||||
# 单例类 - SingletonTrait
|
||||
|
||||
单例类，顾名思义，就是让用户声明的类拥有单例的特性，而这一组件引入的方式也最直接。它是一个 PHP 的 `trait`。
|
||||
|
||||
@ -40,4 +40,4 @@ Foo::getInstance()->test = 5;
|
||||
var_dump(Foo::getInstance()->test);
|
||||
```
|
||||
|
||||
只需要在类中使用：`use \ZM\Utils\SingletonTrait;` 一句话即可。
|
||||
只需要在类中使用：`use \ZM\Utils\SingletonTrait;` 一句话即可。
|
||||
|
||||
@ -23,4 +23,3 @@
|
||||
```php
|
||||
TaskManager::runTask("heavy_task", 100, "param1", "param2");
|
||||
```
|
||||
|
||||
|
||||
@ -64,4 +64,3 @@ array:31 [
|
||||
```
|
||||
|
||||
> 为什么不能重载所有文件？因为框架是多进程模型，而重载相当于只重新启动了一次 Worker 进程，Manager 和 Master 进程未重启，所以被 Manager、Master 进程已经加载的 PHP 文件无法使用 reload 命令重新加载。详见 [进阶 - 进程间隔离](/advanced/multi-process/#_5)。
|
||||
|
||||
|
||||
@ -6,9 +6,11 @@ HTTP 路由管理器用作管理炸毛框架内 `@RequestMapping` 和静态目
|
||||
|
||||
> 2.3.0 版本起可用。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
因为炸毛框架的路由实现是不基于跨进程的共享内存的，所以每次使用这里面的工具函数都需要单独在所有 Worker 进程中执行一次，最好的办法就是在启动框架时执行（`@OnStart(-1)` 即可，代表此注解事件将在每个工作进程中都被执行一次）。
|
||||
因为炸毛框架的路由实现是不基于跨进程的共享内存的，所以每次使用这里面的工具函数都需要单独在所有 Worker 进程中执行一次，最好的办法就是在启动框架时执行（`@OnStart(-1)` 即可，代表此注解事件将在每个工作进程中都被执行一次）。
|
||||
|
||||
:::
|
||||
|
||||
## 方法
|
||||
|
||||
@ -51,4 +53,4 @@ public function onStart() {
|
||||
|
||||
定义：`\Symfony\Component\Routing\RouteCollection | null`
|
||||
|
||||
炸毛框架使用了 Symfony 框架的 route 组件，有关详情请查阅 [文档](https://symfony.com/doc/current/routing.html)。
|
||||
炸毛框架使用了 Symfony 框架的 route 组件，有关详情请查阅 [文档](https://symfony.com/doc/current/routing.html)。
|
||||
|
||||
@ -4,10 +4,11 @@
|
||||
|
||||
命名空间：`use ZM\Requests\ZMRequest;`
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
在使用 Swoole 4.6.0 以下（不包含）的版本时，最好使用 Swoole 官方推荐的 Saber 或者 ZMRequest 这个轻量的 HTTP 请求客户端，不要使用 curl_exec，因为在老版本的 Swoole 上对 curl 的协程 Hook 支持不是很完善。
|
||||
在使用 Swoole 4.6.0 以下（不包含）的版本时，最好使用 Swoole 官方推荐的 Saber 或者 ZMRequest 这个轻量的 HTTP 请求客户端，不要使用 curl_exec，因为在老版本的 Swoole 上对 curl 的协程 Hook 支持不是很完善。
|
||||
|
||||
:::
|
||||
|
||||
## ZMRequest::get()
|
||||
|
||||
@ -262,11 +263,12 @@ $a->onClose(function($client){
|
||||
|
||||
返回值：`true|false`，当为 `true` 时代表握手成功，此时可以在回调里愉快地收发消息了。如果为 `false` 表明握手失败。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
这里由于是协程转异步，所以不能确定 `upgrade()` 和 `onMessage()` 哪个先会被触发（一般情况下如果服务器不是立刻响应回包信息，总是会先返回 `upgrade()` 的结果。
|
||||
这里由于是协程转异步，所以不能确定 `upgrade()` 和 `onMessage()` 哪个先会被触发（一般情况下如果服务器不是立刻响应回包信息，总是会先返回 `upgrade()` 的结果。
|
||||
|
||||
:::
|
||||
|
||||
## 设置参数
|
||||
|
||||
见：[Swoole - HTTP 客户端](http://wiki.swoole.com/#/coroutine_client/http_client?id=set)
|
||||
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
# 框架组件
|
||||
|
||||
这里列举了框架内的你可能会用到的常用组件。
|
||||
@ -36,14 +36,16 @@ src/
|
||||
|
||||
- 含义：模块的描述。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "my-first-module",
|
||||
"description": "这个是一个示例模块打包教程"
|
||||
}
|
||||
```
|
||||
```json
|
||||
{
|
||||
"name": "my-first-module",
|
||||
"description": "这个是一个示例模块打包教程"
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
#### - version
|
||||
|
||||
@ -52,14 +54,17 @@ src/
|
||||
|
||||
版本处理方式和 Composer 基本一致，建议使用三段式，也就是 `大版本.小版本.补丁版本`。关于三段式版本的描述和规范，见 [到底三段式版本号是什么？](https://www.chrisyue.com/what-the-hell-are-semver-and-the-difference-between-composer-version-control-sign-tilde-and-caret.html)。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "my-first-module",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
```
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "my-first-module",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
#### - depends
|
||||
|
||||
@ -68,17 +73,20 @@ src/
|
||||
|
||||
此处用作模块的依赖检测，假设模块 `foo` 依赖模块 `bar` 的 1.x 版本但是不兼容 `bar` 的 2.x 版本，可以像 Composer 的 `require` 一样编写版本依赖：`^1.0`。也可以使用 `~`、`>=`、`*` 这些与 Composer 包管理相同逻辑的版本依赖关系，详见 [Composer - 包版本](https://docs.phpcomposer.com/01-basic-usage.html#Package-Versions)。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"depends": {
|
||||
"bar": "^1.0",
|
||||
"bsr": "*"
|
||||
}
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"depends": {
|
||||
"bar": "^1.0",
|
||||
"bsr": "*"
|
||||
}
|
||||
```
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
#### - light-cache-store
|
||||
|
||||
@ -89,16 +97,19 @@ src/
|
||||
|
||||
我们假设在项目模块中使用到了 `group-status` 这一个 LightCache，那么只需要写 `light-cache-store` 配置项，在模块打包时就会将持久化的数据也打包到 phar 模块包内。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"light-cache-store": [
|
||||
"group-status"
|
||||
]
|
||||
}
|
||||
```
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"light-cache-store": [
|
||||
"group-status"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
#### - global-config-override
|
||||
|
||||
@ -109,14 +120,17 @@ src/
|
||||
|
||||
如果是 false，那么和不指定此参数效果是一样的，无需用户修改 global.php。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"global-config-override": "请将 static_file_server 的 status 改为 true"
|
||||
}
|
||||
```
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"global-config-override": "请将 static_file_server 的 status 改为 true"
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
#### - allow-hotload
|
||||
|
||||
@ -125,17 +139,23 @@ src/
|
||||
|
||||
当此项为 true 时，可以将模块包直接放入 `zm_data/modules` 文件夹下，然后将 `global.php` 中的 `module_loader` 项中的 `enable_hotload` 改为 true，启动框架即可加载。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"allow-hotload": true
|
||||
}
|
||||
```
|
||||
::: tip 编写实例
|
||||
|
||||
!!! warning "注意"
|
||||
如果使用允许热加载，那么模块包中的配置最好不要有 `global-config-override` 和 `light-cache-store`，以此来达到最正确的效果，一般热加载更适合 Library（库）类型的模块。
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"allow-hotload": true
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
::: warning 注意
|
||||
|
||||
如果使用允许热加载，那么模块包中的配置最好不要有 `global-config-override` 和 `light-cache-store`，以此来达到最正确的效果，一般热加载更适合 Library（库）类型的模块。
|
||||
|
||||
:::
|
||||
|
||||
#### - zm-data-store
|
||||
|
||||
@ -146,17 +166,20 @@ src/
|
||||
|
||||
我们假设要打包一个 `{zm_data 目录}/config/` 目录及其目录下的文件，和一个 `main.png` 文件，下方是实例。
|
||||
|
||||
??? note "点我查看编写实例："
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"zm-data-store": [
|
||||
"config/",
|
||||
"main.png"
|
||||
]
|
||||
}
|
||||
```
|
||||
::: tip 编写实例
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "foo",
|
||||
"description": "这个是一个示例模块打包教程",
|
||||
"zm-data-store": [
|
||||
"config/",
|
||||
"main.png"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
在打包时框架会自动添加这些文件到 phar 插件包内，到解包时，会自动将这些文件释放到对应框架的 `zm_data` 目录下。
|
||||
|
||||
@ -221,7 +244,6 @@ $ ./zhamao module:pack foo
|
||||
- crash/swoole_error.log
|
||||
- 必要的框架热加载以及解包需要的配置信息
|
||||
|
||||
|
||||
## 打包命令
|
||||
|
||||
```bash
|
||||
@ -240,4 +262,3 @@ $ ./zhamao module:pack foo
|
||||
```
|
||||
|
||||
通过此命令可以查看模块相关的信息，如未打包但已配置的模块信息等。
|
||||
|
||||
|
||||
@ -81,4 +81,4 @@ zm_data/modules/foo.phar
|
||||
请输入修改模式，y(使用vim修改)/e(自行使用其他编辑器修改后确认)/N(默认暂不修改)：[y/e/N]
|
||||
```
|
||||
|
||||
一般这种情况，根据第二条提示（第二条提示为打包时填入的 `global-config-override`）。如果输入 y，则会自动执行命令 `vim config/global.php`，如果输入的是 e，则会等待你手动修改完成文件，最后按回车完成修改。默认情况直接回车的话，会跳过此步骤，如果模块要求了修改但跳过修改，安装后可能会有功能缺失等问题。
|
||||
一般这种情况，根据第二条提示（第二条提示为打包时填入的 `global-config-override`）。如果输入 y，则会自动执行命令 `vim config/global.php`，如果输入的是 e，则会等待你手动修改完成文件，最后按回车完成修改。默认情况直接回车的话，会跳过此步骤，如果模块要求了修改但跳过修改，安装后可能会有功能缺失等问题。
|
||||
|
||||
@ -16,10 +16,11 @@ $config['init_atomics'] = [
|
||||
|
||||
这时我们就成功初始化两个原子计数器，名字分别为 `foo` 和 `bar`。
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
初始化的值必须是不小于 0 的 int32 值！
|
||||
初始化的值必须是不小于 0 的 int32 值！
|
||||
|
||||
:::
|
||||
|
||||
## 使用
|
||||
|
||||
@ -59,7 +60,8 @@ class Hello {
|
||||
|
||||
设置计数的数字：`ZMAtomic::get("bar")->set(77);`
|
||||
|
||||
!!! note "提示"
|
||||
::: tip 提示
|
||||
|
||||
还有一些不常用的方法，可以看 Swoole 官方的文档，这里就不一一列举了。
|
||||
还有一些不常用的方法，可以看 Swoole 官方的文档，这里就不一一列举了。
|
||||
|
||||
:::
|
||||
|
||||
@ -101,7 +101,8 @@ $r = file_get_contents(working_dir() . "/composer.json");
|
||||
file_put_contents("/tmp/test.txt", "hello world");
|
||||
```
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
在默认的情况里，框架的根目录均为可写可读的，在读写文件时务必要注意目录的位置和权限。使用 `working_dir()` 获取目录后面需要加 `/` 再追加自己的文件名或子目录名。
|
||||
在默认的情况里，框架的根目录均为可写可读的，在读写文件时务必要注意目录的位置和权限。使用 `working_dir()` 获取目录后面需要加 `/` 再追加自己的文件名或子目录名。
|
||||
|
||||
:::
|
||||
|
||||
@ -81,14 +81,14 @@ public function storeAfterRemove() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) store
|
||||
( OK！
|
||||
) storeAfterRemove
|
||||
( 内容存在！
|
||||
^ 等待 30 秒
|
||||
( 内容不存在！
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'store'},
|
||||
{type:1,content:'OK！'},
|
||||
{type:0,content:'storeAfterRemove'},
|
||||
{type:1,content:'内容存在！'},
|
||||
{type:2,content:'等待 30 秒'},
|
||||
{type:1,content:'内容不存在！'},
|
||||
]"></chat-box>
|
||||
|
||||
### LightCache::update()
|
||||
|
||||
@ -218,14 +218,14 @@ public function getStore() {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
^ 我在 2021-01-05 15:21:00 发送这条消息
|
||||
) getStore
|
||||
( 2021-01-05 15:20:00
|
||||
^ 这时我用 Ctrl+C 停止框架，过一会儿再启动
|
||||
) getStore
|
||||
( 存储时间：2021-01-05 15:20:00
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:2,content:'我在 2021-01-05 15:21:00 发送这条消息'},
|
||||
{type:0,content:'getStore'},
|
||||
{type:1,content:'2021-01-05 15:20:00'},
|
||||
{type:2,content:'这时我用 Ctrl+C 停止框架，过一会儿再启动'},
|
||||
{type:0,content:'getStore'},
|
||||
{type:1,content:'存储时间：2021-01-05 15:20:00'},
|
||||
]"></chat-box>
|
||||
|
||||
### 数据加锁
|
||||
|
||||
@ -250,10 +250,11 @@ public function test() {
|
||||
|
||||
在运行完测试后，通过 `LightCache::get("web_count")`，获取到的数你会发现不是 200000。怎么回事呢？请自行翻阅多进程开发相关的书籍哦！（或者简单理解为，有一些情况下，进程 1 执行到了 `if-else` 语句，另一个进程也执行到了这里，两次在代码层面加的数是相同的，则虽然请求了两次，但是后执行 set 的那个进程又覆盖了前一个进程执行的值，导致最终结果加了 1 而不是 2）
|
||||
|
||||
!!! note "提示"
|
||||
::: tip 提示
|
||||
|
||||
同样的场景，使用 ZMAtomic 就不需要使用锁了。Atomic 是一句话：`add(1)` 立即加值的。而 LightCache 需要加锁的情况一般都是 `get->改值->set` 这样的代码。
|
||||
同样的场景，使用 ZMAtomic 就不需要使用锁了。Atomic 是一句话：`add(1)` 立即加值的。而 LightCache 需要加锁的情况一般都是 `get->改值->set` 这样的代码。
|
||||
|
||||
:::
|
||||
|
||||
解决这一问题，就需要用到锁。这种情况下，我们首先考虑的是自旋锁，框架也因此内置了一个方便使用的自旋锁组件。详见下一章：自旋锁。
|
||||
|
||||
@ -271,13 +272,13 @@ public function test() {
|
||||
|
||||
### WorkerCache 跨进程大缓存
|
||||
|
||||
WorkerCache 和 LightCache 几乎完全不同，WorkerCache 存储的方式说白了就是 PHP 的静态变量，不过框架支持使用封装好的进程间通信进行跨进程读取。但由于需要设置一个存储变量的进程，所以配置文件必须先指定要将数据存到哪个 Worker/TaskWorker 进程中。关于框架内多进程的说明，请见 [进阶 - 多进程 Hack](/advanced/multi-process/)。
|
||||
WorkerCache 和 LightCache 几乎完全不同，WorkerCache 存储的方式说白了就是 PHP 的静态变量，不过框架支持使用封装好的进程间通信进行跨进程读取。但由于需要设置一个存储变量的进程，所以配置文件必须先指定要将数据存到哪个 Worker/TaskWorker 进程中。关于框架内多进程的说明，请见 [进阶 - 多进程 Hack](/advanced/multi-process)。
|
||||
|
||||
定义：`ZM\Store\WorkerCache`。
|
||||
|
||||
#### 配置
|
||||
|
||||
见 [基本配置](/guide/basic-config/)。
|
||||
见 [基本配置](/guide/basic-config)。
|
||||
|
||||
#### WorkerCache::get()
|
||||
|
||||
@ -342,12 +343,11 @@ class Hello {
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) set_store hello world
|
||||
( 成功！
|
||||
) get_store hello
|
||||
( world
|
||||
) get_store foo
|
||||
( 内容不存在！
|
||||
</chat-box>
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'set_store hello world'},
|
||||
{type:1,content:'成功！'},
|
||||
{type:0,content:'get_store hello'},
|
||||
{type:1,content:'world'},
|
||||
{type:0,content:'get_store foo'},
|
||||
{type:1,content:'内容不存在！'},
|
||||
]"></chat-box>
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
# MySQL 数据库（旧版组件）
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
此 MySQL 组件为旧版 MySQL 查询器组件，为了统一和提升对未来独立组件的兼容性，现转变为使用 `doctrine/dbal` 和 `doctrine/orm` 库来实现查询器，请转到 [MySQL 查询器]()。
|
||||
此 MySQL 组件为旧版 MySQL 查询器组件，为了统一和提升对未来独立组件的兼容性，现转变为使用 `doctrine/dbal` 和 `doctrine/orm` 库来实现查询器，请转到 [MySQL 查询器]()。
|
||||
|
||||
:::
|
||||
|
||||
## 配置
|
||||
|
||||
@ -78,8 +80,6 @@ DB::table("admin")->where("name", "fake_admin")->count();
|
||||
//SELECT count(*) FROM admin WHERE name = 'fake_admin'
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 直接执行 SQL
|
||||
|
||||
> 在查询器外执行的 SQL 语句都不会被缓存，都是一定会请求数据库的。
|
||||
@ -98,4 +98,4 @@ $r = DB::rawQuery("SELECT * FROM admin WHERE name = ?", ["fake_admin"]);
|
||||
echo $r[0]["password"];
|
||||
```
|
||||
|
||||
> 参数查询已经从根本上杜绝了 SQL 注入的问题。
|
||||
> 参数查询已经从根本上杜绝了 SQL 注入的问题。
|
||||
|
||||
3
docs/component/store/mysql-statement.md
Normal file
3
docs/component/store/mysql-statement.md
Normal file
@ -0,0 +1,3 @@
|
||||
# MySQLStatement
|
||||
|
||||
你好啊，这里是 Statement。TODO
|
||||
@ -1,4 +1,27 @@
|
||||
# 执行 SQL 语句
|
||||
# MySQL 数据库
|
||||
|
||||
## 简介
|
||||
|
||||
炸毛框架的数据库组件对接了 MySQL 连接池，在使用过程中无需配置即可实现 MySQL 查询，同时拥有高并发。
|
||||
|
||||
目前 2.5 版本后炸毛框架底层采用了 `doctrine/dbal` 组件，可以方便地构建 SQL 语句。
|
||||
|
||||
本章大体查询内容均以下表 `users` 为基础：
|
||||
|
||||
| id | username | gender | update_time |
|
||||
| -- | -------- | ------ | ----------- |
|
||||
| 1 | jack | man | 2021-10-12 |
|
||||
| 2 | rose | woman | 2021-10-11 |
|
||||
|
||||
## 配置
|
||||
|
||||
炸毛框架的数据库组件支持原生 SQL、查询构造器，去掉了复杂的对象模型关联，同时默认为数据库连接池，使开发变得简单。
|
||||
|
||||
数据库的配置位于 `config/global.php` 文件的 `mysql_config` 段，见 [全局配置](../../../../guide/basic-config#mysql_config)。
|
||||
|
||||
如果 `mysql_config.host` 字段为空，则不创建数据库连接池，填写后将创建，且默认保持长连接。
|
||||
|
||||
## 执行 SQL 语句
|
||||
|
||||
在一开始，无论你做什么数据库操作，均需要获取一个 `\ZM\MySQL\MySQLWrapper` 作为你的操作对象。
|
||||
|
||||
@ -7,11 +30,13 @@
|
||||
$wrapper = \ZM\MySQL\MySQLManager::getWrapper();
|
||||
```
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
这部分内容部分直接取自 [DBAL - Data Retrieval And Manipulation](https://www.doctrine-project.org/projects/doctrine-dbal/en/2.13/reference/data-retrieval-and-manipulation.html) 原文并直接翻译，如有实际不同请提交 Issue 反馈。
|
||||
这部分内容部分直接取自 [DBAL - Data Retrieval And Manipulation](https://www.doctrine-project.org/projects/doctrine-dbal/en/2.13/reference/data-retrieval-and-manipulation.html) 原文并直接翻译，如有实际不同请提交 Issue 反馈。
|
||||
|
||||
## 执行预处理 SQL 语句
|
||||
:::
|
||||
|
||||
### 执行预处理 SQL 语句
|
||||
|
||||
预处理查询很巧妙地解决了 SQL 注入问题，并且可以方便地绑定参数进行查询。
|
||||
|
||||
@ -27,7 +52,7 @@ $stmt->bindValue(2, "jack");
|
||||
$resultSet = $stmt->executeQuery();
|
||||
```
|
||||
|
||||
其中 `$resultSet` 与 `Statement` 方法相似，此处的对象可能是 [数据库语句对象](../mysql-statement) 或 数据库结果对象（结果对象与语句对象的 `fetchXXX()` 部分一致）。
|
||||
其中 `$resultSet` 与 `Statement` 方法相似，此处的对象可能是 [数据库语句对象](./mysql-statement) 或 数据库结果对象（结果对象与语句对象的 `fetchXXX()` 部分一致）。
|
||||
|
||||
这里也可以使用命名标签，使用标签可以给相同参数处使用同一个标签：
|
||||
|
||||
@ -38,7 +63,7 @@ $stmt->bindValue("name", "jack");
|
||||
$resultSet = $stmt->executeQuery();
|
||||
```
|
||||
|
||||
## 执行常规语句
|
||||
### 执行常规语句
|
||||
|
||||
执行常规语句为 `statement` 方式执行，此方法执行后只返回影响的行数，而不返回结果，适用于 `UPDATE` 等语句。
|
||||
|
||||
@ -48,7 +73,7 @@ $count = $wrapper->executeStatement('UPDATE users SET username = ? WHERE id = ?'
|
||||
echo $count; // 1
|
||||
```
|
||||
|
||||
## 执行查询语句
|
||||
### 执行查询语句
|
||||
|
||||
为给定的 SQL 创建一个准备好的语句并将参数传递给 executeQuery 方法，然后返回结果集。此方法为上述的「预处理查询语句」的简化版，可直接在第二个参数使用 array 插入绑定参数执行。
|
||||
|
||||
@ -68,7 +93,7 @@ array(
|
||||
*/
|
||||
```
|
||||
|
||||
### fetchAllAssociative()
|
||||
#### fetchAllAssociative()
|
||||
|
||||
执行查询并将所有结果返回一个数组中。
|
||||
|
||||
@ -79,7 +104,7 @@ $resultSet = $wrapper->fetchAllAssociative('SELECT * FROM user WHERE username =
|
||||
// 结果同 executeQuery()->fetchAllAssociative() 中 $user 的值。
|
||||
```
|
||||
|
||||
### fetchAllKeyValue()
|
||||
#### fetchAllKeyValue()
|
||||
|
||||
执行查询并将前两列分别作为键和值提取到关联数组中。
|
||||
|
||||
@ -93,7 +118,7 @@ array(
|
||||
*/
|
||||
```
|
||||
|
||||
### fetchAllAssociativeIndexed()
|
||||
#### fetchAllAssociativeIndexed()
|
||||
|
||||
执行查询并将数据作为关联数组获取，其中键代表第一列，值是其余列及其值的关联数组。
|
||||
|
||||
@ -111,7 +136,7 @@ array(
|
||||
*/
|
||||
```
|
||||
|
||||
### fetchNumeric()
|
||||
#### fetchNumeric()
|
||||
|
||||
查询并返回第一行数据，形式以数字索引方式返回每一列。
|
||||
|
||||
@ -127,7 +152,7 @@ array(
|
||||
*/
|
||||
```
|
||||
|
||||
### fetchOne()
|
||||
#### fetchOne()
|
||||
|
||||
仅返回查询结果的第一行第一列的值。
|
||||
|
||||
@ -136,7 +161,7 @@ $username = $wrapper->fetchOne('SELECT username FROM users WHERE id = ?', array(
|
||||
echo $username; // jack
|
||||
```
|
||||
|
||||
### fetchAssociative()
|
||||
#### fetchAssociative()
|
||||
|
||||
返回结果内第一行的关联数组形式的数据。
|
||||
|
||||
@ -153,7 +178,7 @@ array(
|
||||
*/
|
||||
```
|
||||
|
||||
### delete()
|
||||
#### delete()
|
||||
|
||||
删除查询操作，第一个参数为表名，第二个参数为 `['列名' => '列值']`。
|
||||
|
||||
@ -163,7 +188,7 @@ $wrapper->delete('users', array('username' => 'jack'));
|
||||
// 等同于执行DELETE FROM user WHERE username = ? ，参数列表为('jack')
|
||||
```
|
||||
|
||||
### insert()
|
||||
#### insert()
|
||||
|
||||
插入数据库一行，第一个参数为表名，第二个参数为对应数据。
|
||||
|
||||
@ -172,7 +197,7 @@ $wrapper->insert('users', array('id' => 0, 'username' => 'jwage', 'gender' => 'w
|
||||
// INSERT INTO user (id, username, gender, update_time) VALUES (?,?,?,?) (0,jwage,woman,2021-10-17)
|
||||
```
|
||||
|
||||
### update()
|
||||
#### update()
|
||||
|
||||
更新数据库，使用给定数据更新匹配键值标识符的所有行。
|
||||
|
||||
@ -181,4 +206,3 @@ $wrapper->insert('users', array('id' => 0, 'username' => 'jwage', 'gender' => 'w
|
||||
$wrapper->update('user', array('username' => 'jwage'), array('id' => 1));
|
||||
// UPDATE user (username) VALUES (?) WHERE id = ? (jwage, 1)
|
||||
```
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
# 配置
|
||||
|
||||
炸毛框架的数据库组件支持原生 SQL、查询构造器，去掉了复杂的对象模型关联，同时默认为数据库连接池，使开发变得简单。
|
||||
|
||||
数据库的配置位于 `config/global.php` 文件的 `mysql_config` 段，见 [全局配置](../../../../guide/basic-config#mysql_config)。
|
||||
|
||||
如果 `mysql_config.host` 字段为空，则不创建数据库连接池，填写后将创建，且默认保持长连接。
|
||||
@ -1 +0,0 @@
|
||||
你好啊，这里是 Statement。
|
||||
@ -1,14 +0,0 @@
|
||||
# MySQL 数据库简介
|
||||
|
||||
炸毛框架的数据库组件对接了 MySQL 连接池，在使用过程中无需配置即可实现 MySQL 查询，同时拥有高并发。
|
||||
|
||||
目前 2.5 版本后炸毛框架底层采用了 `doctrine/dbal` 组件，可以方便地构建 SQL 语句。
|
||||
|
||||
本章大体查询内容均以下表 `users` 为基础：
|
||||
|
||||
| id | username | gender | update_time |
|
||||
| -- | -------- | ------ | ----------- |
|
||||
| 1 | jack | man | 2021-10-12 |
|
||||
| 2 | rose | woman | 2021-10-11 |
|
||||
|
||||
#
|
||||
@ -59,4 +59,4 @@ ZMRedis::call(function($redis) {
|
||||
|
||||
选一个喜欢的就好。硬要是说区别的话，对象模式是在 PHP 自动回收这个 `ZMRedis` 对象时会归还连接，也可以通过手动 `unset($obj)` 进行回收，否则就会执行到函数结尾自动回收。切记不可将 `$obj` 对象持久化存到静态或全局变量等。
|
||||
|
||||
回调模式看似是回调，但是是同步执行的，不会发生顺序错乱。也就是说到了 `ZMRedis::call()` 方法里面的时候，后面的代码不会提前执行，是顺序执行的。回调的作用仅仅是用作自动回收连接对象。
|
||||
回调模式看似是回调，但是是同步执行的，不会发生顺序错乱。也就是说到了 `ZMRedis::call()` 方法里面的时候，后面的代码不会提前执行，是顺序执行的。回调的作用仅仅是用作自动回收连接对象。
|
||||
|
||||
@ -2,9 +2,11 @@
|
||||
|
||||
前面讲到 LightCache 轻量缓存在特定的情况下为了保证数据不被多进程的因素导致丢失或覆盖，在高并发情况下修改数据需要加锁，所以炸毛框架内置了 SpinLock 自旋锁。
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
框架单进程运行的模式下不需要任何自旋锁。
|
||||
框架单进程运行的模式下不需要任何自旋锁。
|
||||
|
||||
:::
|
||||
|
||||
## 配置
|
||||
|
||||
@ -61,9 +63,11 @@ public function test() {
|
||||
|
||||
原理剖析：在 LightCache 获取前，先对此内容上锁，这时如果其他进程有同时也在执行这个代码的时候，就会在 `SpinLock::lock()` 这行代码处原地等待，防止继续执行。等前面的那个进程执行到 `SpinLock::unlock()` 释放锁时，其他进程才可继续执行，从而避免了多个进程并行执行这段代码导致的数据错乱。
|
||||
|
||||
!!! error "警告"
|
||||
::: danger 警告
|
||||
|
||||
使用锁时务必谨慎，如果不按照下面的规则使用自旋锁可能导致 CPU 占用率上升。
|
||||
使用锁时务必谨慎，如果不按照下面的规则使用自旋锁可能导致 CPU 占用率上升。
|
||||
|
||||
:::
|
||||
|
||||
自旋锁使用约定：
|
||||
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# 自定义注解
|
||||
|
||||
TODO：师傅，莫催，快肝完了！
|
||||
TODO：师傅，莫催，快肝完了！
|
||||
|
||||
@ -116,4 +116,4 @@ class Test {
|
||||
|
||||
我们假设 CustomEvent 是我们的自定义注解。还没写完，这部分太复杂了，而且举例子也不好举例，这块应该也不用着急更新。
|
||||
|
||||
TODO：待完成
|
||||
TODO：待完成
|
||||
|
||||
@ -328,7 +328,7 @@ class Hello {
|
||||
|
||||
## 示例3（接收 WS 客户端发来的数据）
|
||||
|
||||
见 [接入 WebSocket 客户端](/advanced/connect-ws-client/)。
|
||||
见 [接入 WebSocket 客户端](/advanced/connect-ws-client)。
|
||||
|
||||
## 示例4（使用 OnStart 给所有 Worker 进程写入缓存提速）
|
||||
|
||||
@ -359,8 +359,7 @@ class Hello {
|
||||
},
|
||||
"key": "C",
|
||||
"answer_type": 0
|
||||
},
|
||||
.....
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -411,10 +410,10 @@ class Hello {
|
||||
|
||||
聊天效果：
|
||||
|
||||
<chat-box>
|
||||
) 找题 1
|
||||
( 题目名称：法律与其他社会规范的区别在于（ ）。\nA. 是调整人们行为的规范\nB. 有约束力\nC. 由国家强制力保证执行\nD. 规定制裁措施\n正确答案：C
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'找题 1'},
|
||||
{type:1,content:'题目名称：法律与其他社会规范的区别在于（ ）。\nA. 是调整人们行为的规范\nB. 有约束力\nC. 由国家强制力保证执行\nD. 规定制裁措施\n正确答案：C'},
|
||||
]"></chat-box>
|
||||
|
||||
## 示例5（创建每分钟自动执行的爬虫）
|
||||
|
||||
@ -430,4 +429,5 @@ public function onCrawl() {
|
||||
|
||||
## 示例6（创建一个远程终端命令并调试框架）
|
||||
|
||||
> 开个坑，以后填。（__填坑标记__）
|
||||
> 开个坑，以后填。（__填坑标记__）
|
||||
>
|
||||
@ -65,6 +65,3 @@ class Hello {
|
||||
EventDispatcher::interrupt();
|
||||
EventDispatcher::interrupt($data); // 也可以带返回值，自定义注解事件时有用。
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
在炸毛框架中，中间件最直白的意思就是注解事件执行前、执行后、执行过程中可进行插入代码但不破坏原有代码。
|
||||
|
||||
```伪代码
|
||||
```
|
||||
@中间件1
|
||||
@带条件的注解1
|
||||
function 我的方法() {
|
||||
@ -192,4 +192,3 @@ public function testRoute() {
|
||||
配置项为 1，在访问此路由执行此函数时会抛出异常，中断此次事件。
|
||||
|
||||
配置项为 2，在框架启动时抛出致命异常。
|
||||
|
||||
|
||||
@ -4,9 +4,11 @@ QQ 机器人事件是指 CQHTTP 插件发来的 Event 事件，被框架处理
|
||||
|
||||
为了便于开发，这里的注解类对应 CQHTTP 插件返回的 `post_type` 类型，对号入座即可。
|
||||
|
||||
!!! tip "提示"
|
||||
::: tip 提示
|
||||
|
||||
在使用注解绑定事件过程中，如果无 **必需** 参数，可一个参数也不写，效果就是此事件任何情况下都会调用此方法。例如：`@CQMessage()`
|
||||
在使用注解绑定事件过程中，如果无 **必需** 参数，可一个参数也不写，效果就是此事件任何情况下都会调用此方法。例如：`@CQMessage()`
|
||||
|
||||
:::
|
||||
|
||||
事件是用户需要从 OneBot 被动接收的数据，有以下几个大类：
|
||||
|
||||
@ -61,39 +63,39 @@ QQ 收到消息后触发的事件对应注解。
|
||||
- 在用户 QQ 为 `123456` 的用户私聊给机器人发消息后机器人回复内容。
|
||||
- 用户发送文字为 `hello` 时返回 `你好啊，xxx` 的消息。
|
||||
|
||||
=== "代码"
|
||||
代码
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQMessage;
|
||||
|
||||
class Hello {
|
||||
/**
|
||||
* @CQMessage(message_type="private",user_id=123456)
|
||||
*/
|
||||
public function test() {
|
||||
return "你和机器人私聊发送了这些文本：".ctx()->getMessage();
|
||||
}
|
||||
/**
|
||||
* @CQMessage(message="hello")
|
||||
*/
|
||||
public function hello() {
|
||||
return "你好啊，".ctx()->getUserId();
|
||||
}
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQMessage;
|
||||
|
||||
class Hello {
|
||||
/**
|
||||
* @CQMessage(message_type="private",user_id=123456)
|
||||
*/
|
||||
public function test() {
|
||||
return "你和机器人私聊发送了这些文本：".ctx()->getMessage();
|
||||
}
|
||||
```
|
||||
/**
|
||||
* @CQMessage(message="hello")
|
||||
*/
|
||||
public function hello() {
|
||||
return "你好啊，".ctx()->getUserId();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
=== "效果"
|
||||
效果
|
||||
|
||||
<chat-box>
|
||||
) 假设我是私聊机器人
|
||||
( 你和机器人私聊发送了这些文本：假设我是私聊机器人
|
||||
^ 假设我现在切到群里，在群里发hello
|
||||
) hello
|
||||
( 你好啊，123456
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'假设我是私聊机器人'},
|
||||
{type:1,content:'你和机器人私聊发送了这些文本：假设我是私聊机器人'},
|
||||
{type:2,content:'假设我现在切到群里，在群里发hello'},
|
||||
{type:0,content:'hello'},
|
||||
{type:1,content:'你好啊，123456'},
|
||||
]"></chat-box>
|
||||
|
||||
## CQCommand()
|
||||
|
||||
@ -125,11 +127,13 @@ QQ 收到消息后触发的事件对应注解。
|
||||
| group_id | `int64` 或 `string` | 限定消息发送来源群 ID，同 `@CQMessage` | 空 |
|
||||
| level | `int` | 事件优先级（越大越靠前） | 20 |
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
在 `@CQCommand` 注解事件中，从 `match` 到 `keyword` 六个参数中，必须且只能定义一个，`alias` 目前只能和 `match` 参数同时使用；
|
||||
|
||||
框架内部对于同一条消息事件，优先处理 `@CQCommand` 注解事件，如果未匹配到任何注解事件，则才会继续执行 `@CQMessage` 注解事件。
|
||||
在 `@CQCommand` 注解事件中，从 `match` 到 `keyword` 六个参数中，必须且只能定义一个，`alias` 目前只能和 `match` 参数同时使用；
|
||||
|
||||
框架内部对于同一条消息事件，优先处理 `@CQCommand` 注解事件，如果未匹配到任何注解事件，则才会继续执行 `@CQMessage` 注解事件。
|
||||
|
||||
:::
|
||||
|
||||
- 参数 `match` 匹配模式是：遇到空格、换行就会切分，比如 `点歌 xxx yyy` 会被分割为 `[点歌,xxx,yyy]`，然后抽取第一个词做为命令去匹配，剩下的为参数。
|
||||
- 参数 `pattern` 匹配模式是：\* 号位置变成参数，比如 `从*到*的随机数`，我们输入 `从1到9的随机数`，成功匹配，参数列表：`[1,9]`。
|
||||
@ -141,52 +145,54 @@ QQ 收到消息后触发的事件对应注解。
|
||||
|
||||
我们以参数 `match` 写一个简单的 demo：
|
||||
|
||||
=== "代码"
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
代码
|
||||
|
||||
use ZM\Annotation\CQ\CQCommand;
|
||||
|
||||
class Hello {
|
||||
/**
|
||||
* @CQCommand(match="疫情",alias={"COVID"})
|
||||
*/
|
||||
public function virus(){
|
||||
$city = ctx()->getNextArg("请输入城市名称");
|
||||
return "城市 ".$city." 的疫情状况如下："."{这里假装是疫情接口返回的数据}";
|
||||
}
|
||||
/**
|
||||
* 如果选择使用 match 参数的话，可以省略 `match=`
|
||||
* @CQCommand("掷硬币")
|
||||
*/
|
||||
public function randChoice() {
|
||||
return "你看到的是：" . (mt_rand(0,1) ? "正面" : "反面");
|
||||
}
|
||||
/**
|
||||
* @CQCommand(pattern="*把*翻译成*")
|
||||
*/
|
||||
public function translate() {
|
||||
ctx()->getNextArg(); // 为什么需要单独调用一次呢？看下面例子就知道啦
|
||||
$text = ctx()->getNextArg(); // 获取第二个星号匹配的内容
|
||||
$target = ctx()->getNextArg(); // 获取第三个星号匹配的内容
|
||||
// 这里 FakeTranslateAPI 是假设我们对接了一个翻译的 API，开发时请替换为自己的接口。
|
||||
return "翻译结果：" . FakeTranslateAPI::translate($text, $target);
|
||||
}
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQCommand;
|
||||
|
||||
class Hello {
|
||||
/**
|
||||
* @CQCommand(match="疫情",alias={"COVID"})
|
||||
*/
|
||||
public function virus(){
|
||||
$city = ctx()->getNextArg("请输入城市名称");
|
||||
return "城市 ".$city." 的疫情状况如下："."{这里假装是疫情接口返回的数据}";
|
||||
}
|
||||
```
|
||||
=== "效果"
|
||||
/**
|
||||
* 如果选择使用 match 参数的话，可以省略 `match=`
|
||||
* @CQCommand("掷硬币")
|
||||
*/
|
||||
public function randChoice() {
|
||||
return "你看到的是：" . (mt_rand(0,1) ? "正面" : "反面");
|
||||
}
|
||||
/**
|
||||
* @CQCommand(pattern="*把*翻译成*")
|
||||
*/
|
||||
public function translate() {
|
||||
ctx()->getNextArg(); // 为什么需要单独调用一次呢？看下面例子就知道啦
|
||||
$text = ctx()->getNextArg(); // 获取第二个星号匹配的内容
|
||||
$target = ctx()->getNextArg(); // 获取第三个星号匹配的内容
|
||||
// 这里 FakeTranslateAPI 是假设我们对接了一个翻译的 API，开发时请替换为自己的接口。
|
||||
return "翻译结果：" . FakeTranslateAPI::translate($text, $target);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<chat-box>
|
||||
) 疫情 北京
|
||||
( 城市 北京 的疫情状况如下：blablablabla
|
||||
) COVID 香港
|
||||
( 城市 香港 的疫情状况如下：blablablabla
|
||||
) 掷硬币
|
||||
( 你看到的是：正面
|
||||
) 我想把我爱你翻译成英语
|
||||
( 翻译结果：I love you!
|
||||
</chat-box>
|
||||
效果
|
||||
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'疫情 北京'},
|
||||
{type:1,content:'城市 北京 的疫情状况如下：blablablabla'},
|
||||
{type:0,content:'COVID 香港'},
|
||||
{type:1,content:'城市 香港 的疫情状况如下：blablablabla'},
|
||||
{type:0,content:'掷硬币'},
|
||||
{type:1,content:'你看到的是：正面'},
|
||||
{type:0,content:'我想把我爱你翻译成英语'},
|
||||
{type:1,content:'翻译结果：I love you!'},
|
||||
]"></chat-box>
|
||||
|
||||
## CQNotice()
|
||||
|
||||
@ -292,49 +298,52 @@ TODO：先放着，有时间再更。
|
||||
|
||||
### 用法
|
||||
|
||||
=== "代码"
|
||||
代码
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQBefore;
|
||||
use ZM\Annotation\CQ\CQMessage;
|
||||
class Test {
|
||||
/**
|
||||
* @CQBefore("message")
|
||||
*/
|
||||
public function filter(){
|
||||
// 可用于敏感词，如政治相关的词语不响应其他模块
|
||||
if(mb_strpos(ctx()->getMessage(), "谷歌") !== false) return false;
|
||||
else return true;
|
||||
}
|
||||
/**
|
||||
* @CQCommand("百科")
|
||||
*/
|
||||
public function wiki() {
|
||||
$content = ctx()->getNextArg("请说你要查百科的内容");
|
||||
// 这里假设你对接了一个查百科的接口
|
||||
return "已搜到匹配 $content 的如下结果：".FakeAPI::searchWiki($content);
|
||||
}
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\CQ\CQBefore;
|
||||
use ZM\Annotation\CQ\CQMessage;
|
||||
class Test {
|
||||
/**
|
||||
* @CQBefore("message")
|
||||
*/
|
||||
public function filter(){
|
||||
// 可用于敏感词，如政治相关的词语不响应其他模块
|
||||
if(mb_strpos(ctx()->getMessage(), "谷歌") !== false) return false;
|
||||
else return true;
|
||||
}
|
||||
```
|
||||
/**
|
||||
* @CQCommand("百科")
|
||||
*/
|
||||
public function wiki() {
|
||||
$content = ctx()->getNextArg("请说你要查百科的内容");
|
||||
// 这里假设你对接了一个查百科的接口
|
||||
return "已搜到匹配 $content 的如下结果：".FakeAPI::searchWiki($content);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
=== "效果"
|
||||
效果
|
||||
|
||||
<chat-box>
|
||||
) 百科 北京
|
||||
( 已搜到匹配 北京 的如下结果：blablabla
|
||||
) 百科 谷歌被封
|
||||
^ 机器人没有任何回复
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'百科 北京'},
|
||||
{type:1,content:'已搜到匹配 北京 的如下结果：blablabla'},
|
||||
{type:0,content:'百科 谷歌被封'},
|
||||
{type:2,content:'机器人没有任何回复'},
|
||||
]"></chat-box>
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
在设置了 `level` 参数后，如果设置了多个 `@CQBefore` 监听事件函数，更高 `level` 的事件函数返回了 `false`，则低 `level` 的绑定函数不会执行，所有 `@CQMessage` 绑定的事件也不会执行。
|
||||
|
||||
你也可以使用 `@CQBefore` 做一些消息的转发和过滤。比如你想去除用户发来的文字中的 emoji、图片等 CQ 码，只保留文本。
|
||||
|
||||
使用 `ctx()->waitMessage()` 时等待用户输入下一条消息功能和 CQBefore 配合过滤消息时需注意，见 [FAQ - CQBefore 过滤不了 waitMessage](/FAQ/wait-message-cqbefore/)
|
||||
在设置了 `level` 参数后，如果设置了多个 `@CQBefore` 监听事件函数，更高 `level` 的事件函数返回了 `false`，则低 `level` 的绑定函数不会执行，所有 `@CQMessage` 绑定的事件也不会执行。
|
||||
|
||||
你也可以使用 `@CQBefore` 做一些消息的转发和过滤。比如你想去除用户发来的文字中的 emoji、图片等 CQ 码，只保留文本。
|
||||
|
||||
使用 `ctx()->waitMessage()` 时等待用户输入下一条消息功能和 CQBefore 配合过滤消息时需注意，见 [FAQ - CQBefore 过滤不了 waitMessage](/FAQ/wait-message-cqbefore/)
|
||||
|
||||
:::
|
||||
|
||||
## CQAfter()
|
||||
|
||||
|
||||
@ -2,9 +2,11 @@
|
||||
|
||||
炸毛框架提供了一个简易但是高效易用的 HTTP 路由注解，你可以使用路由功能来开发任何 Web 应用微服务、API 接口、中间件等。
|
||||
|
||||
!!! quote "开发提示"
|
||||
::: tip 开发提示
|
||||
|
||||
本章节涉及的路由和控制器概念可能和其他传统框架有一些出入，而且炸毛框架非绝对根据 PSR 标准进行开发，目的是使用上一些常见的东西尽可能地灵活和不啰嗦。
|
||||
本章节涉及的路由和控制器概念可能和其他传统框架有一些出入，而且炸毛框架非绝对根据 PSR 标准进行开发，目的是使用上一些常见的东西尽可能地灵活和不啰嗦。
|
||||
|
||||
:::
|
||||
|
||||
## 控制器和路由
|
||||
|
||||
@ -62,50 +64,54 @@ public function testName($param) {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 路由示例
|
||||
|
||||
=== "代码"
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\Http\Controller;
|
||||
use ZM\Annotation\Http\RequestMapping;
|
||||
代码
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Example;
|
||||
|
||||
use ZM\Annotation\Http\Controller;
|
||||
use ZM\Annotation\Http\RequestMapping;
|
||||
/**
|
||||
* @Controller("/api")
|
||||
*/
|
||||
class Hello {
|
||||
/**
|
||||
* @Controller("/api")
|
||||
* @RequestMapping("/index")
|
||||
*/
|
||||
class Hello {
|
||||
/**
|
||||
* @RequestMapping("/index")
|
||||
*/
|
||||
public function index(){
|
||||
ctx()->getResponse()->end("This is API index page"); // 使用上下文获取响应对象
|
||||
}
|
||||
/**
|
||||
* @RequestMapping("/ping")
|
||||
*/
|
||||
public function ping(){
|
||||
return "pong"; // 直接返回字符串
|
||||
}
|
||||
public function index(){
|
||||
ctx()->getResponse()->end("This is API index page"); // 使用上下文获取响应对象
|
||||
}
|
||||
```
|
||||
/**
|
||||
* @RequestMapping("/ping")
|
||||
*/
|
||||
public function ping(){
|
||||
return "pong"; // 直接返回字符串
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
=== "效果"
|
||||
效果
|
||||
|
||||
!!! example "效果描述"
|
||||
当访问浏览器的 `http://localhost:20001/api/index` 时，浏览器会返回 `This is API index page`，当访问 `/api/ping` 的 url 时，浏览器会返回 `pong`。
|
||||
|
||||
```
|
||||
/ -> 无任何路由
|
||||
/api/index -> Hello->index
|
||||
/api/ping -> Hello->ping
|
||||
```
|
||||
::: tip 效果描述
|
||||
|
||||
!!! tip "提示"
|
||||
当访问浏览器的 `http://localhost:20001/api/index` 时，浏览器会返回 `This is API index page`，当访问 `/api/ping` 的 url 时，浏览器会返回 `pong`。
|
||||
|
||||
当 `@Controller` 为 `/` 的时候，效果和不写是一样的，`@RequestMapping` 为 `/` 或 `/index/inside` 等多级路由也是可以的。
|
||||
```
|
||||
/ -> 无任何路由
|
||||
/api/index -> Hello->index
|
||||
/api/ping -> Hello->ping
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
::: tip 提示
|
||||
|
||||
当 `@Controller` 为 `/` 的时候，效果和不写是一样的，`@RequestMapping` 为 `/` 或 `/index/inside` 等多级路由也是可以的。
|
||||
|
||||
:::
|
||||
|
||||
### 绑定参数
|
||||
|
||||
@ -126,46 +132,46 @@ public function index($arg) {
|
||||
|
||||
### 示例
|
||||
|
||||
=== "获取 GET"
|
||||
#### 获取 GET
|
||||
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$get = ctx()->getRequest()->get;
|
||||
if(isset($get["name"])) return "hello, ".$get["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$get = ctx()->getRequest()->get;
|
||||
if(isset($get["name"])) return "hello, ".$get["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
|
||||
=== "获取 POST（x-www-form-urlencoded）"
|
||||
#### 获取 POST（x-www-form-urlencoded）
|
||||
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$post = ctx()->getRequest()->post;
|
||||
if(isset($post["name"])) return "hello, ".$post["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$post = ctx()->getRequest()->post;
|
||||
if(isset($post["name"])) return "hello, ".$post["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
|
||||
=== "获取 JSON POST"
|
||||
#### 获取 JSON POST
|
||||
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$post = ctx()->getRequest()->rawContent();
|
||||
$json = json_decode($post, true);
|
||||
if ($json === null) return "Invalid json data!";
|
||||
if(isset($json["name"])) return "hello, ".$json["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
```php
|
||||
/**
|
||||
* @RequestMapping("/testUrl")
|
||||
*/
|
||||
public function testUrl() {
|
||||
$post = ctx()->getRequest()->rawContent();
|
||||
$json = json_decode($post, true);
|
||||
if ($json === null) return "Invalid json data!";
|
||||
if(isset($json["name"])) return "hello, ".$json["name"];
|
||||
else return "Unknown name!!";
|
||||
}
|
||||
```
|
||||
|
||||
## 设置路由请求方式
|
||||
|
||||
|
||||
@ -4,4 +4,4 @@
|
||||
|
||||
如果框架运行过程中发现带有错误码（如 `E00034` 的形式），可以到 [错误码](/guide/errcode) 查看。
|
||||
|
||||
框架的常见问题见 [常见问题汇总](/faq/usual-question)。
|
||||
框架的常见问题见 [常见问题汇总](/faq/usual-question)。
|
||||
@ -16,4 +16,4 @@ ps aux | grep vendor/bin/start | grep -v grep | awk '{print $2}' | xargs kill -9
|
||||
# 然后使用下面的这条命令，假设最小的pid是23643
|
||||
kill -INT 23643
|
||||
# 如果使用 ps aux 看不到框架相关进程，证明关闭成功，否则需要使用第一条强行杀死
|
||||
```
|
||||
```
|
||||
|
||||
@ -19,4 +19,4 @@
|
||||
|
||||
这种错误的出现原因一般是因为协程未结束而 Worker 进程提前退出导致的，这个错误也可手动造成（在任意 Worker 进程内的位置使用 `zm_yield()` 且不使用 `zm_resume()` 恢复，期间使用 reload 或 stop 重启或停止框架就会报错）。
|
||||
|
||||
还有一种情况是数据库、文件读取或下载上传还没有传送结束，时间已经超时，在关闭或重启框架时不得不强行切断协程的运行。这种情况建议根据下方的打印输出栈进行插错，建议将协程运行时间长的过程缩短或调长 `swoole` 配置项下面的 `max_wait_time` 时间（秒），2.4.3 版本起此参数默认为 5 秒。
|
||||
还有一种情况是数据库、文件读取或下载上传还没有传送结束，时间已经超时，在关闭或重启框架时不得不强行切断协程的运行。这种情况建议根据下方的打印输出栈进行插错，建议将协程运行时间长的过程缩短或调长 `swoole` 配置项下面的 `max_wait_time` 时间（秒），2.4.3 版本起此参数默认为 5 秒。
|
||||
|
||||
@ -2,4 +2,4 @@
|
||||
|
||||
LightCache 因为是跨内存使用的，所以每次重启和关闭框架时，都只会让其中一个进程去保存。因为在 2.4.2 版本开始，持久化的逻辑发生了更改，不再支持 `expire = -2` 进行设置持久化（因为那样会很容易让开发者写错），仅支持使用 `LightCache::addPersistence($key)` 这样的方式进行设置持久化，所以在 2.4.2 版本以后，请使用此方法进行持久化设置，保证数据不丢失。
|
||||
|
||||
此外，2.4.2 版本起，不再支持用户手动调用 `savePersistence()` 方法，普通用户不可手动调用此方法，否则会导致数据出错。
|
||||
此外，2.4.2 版本起，不再支持用户手动调用 `savePersistence()` 方法，普通用户不可手动调用此方法，否则会导致数据出错。
|
||||
|
||||
@ -36,4 +36,4 @@
|
||||
|
||||
由于 2.0 框架使用了多进程模型，所以不能使用原先适用于单进程下全局变量的方式（ZMBuf）进行存取变量，所以 ZMBuf 下的所有方法都需要更改，其中 `get, set` 等对缓存操作的模型请根据 2.0 的文档变更使用 `Redis` 或内置的多进程共享内存可用的 `LightCache` 轻量缓存。
|
||||
|
||||
而获取全局配置文件，如 `global.php` 文件，也发生了变化，新框架引入了 `ZMConfig` 对象，可以快速地区分各类环境变量从而读取不同的配置文件。比如我们获取原先的 global 配置文件中的一项：`ZMBuf::globals("port")`，在 2.0 中需要使用 `ZMConfig::get("global", "port")` 方式。以此类推，`ZMBuf::config("xxx")` 也直接变为 `ZMConfig::get("xxx")` 了。
|
||||
而获取全局配置文件，如 `global.php` 文件，也发生了变化，新框架引入了 `ZMConfig` 对象，可以快速地区分各类环境变量从而读取不同的配置文件。比如我们获取原先的 global 配置文件中的一项：`ZMBuf::globals("port")`，在 2.0 中需要使用 `ZMConfig::get("global", "port")` 方式。以此类推，`ZMBuf::config("xxx")` 也直接变为 `ZMConfig::get("xxx")` 了。
|
||||
|
||||
@ -15,9 +15,11 @@
|
||||
|
||||
### v2.6.6 及以下版本教程
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
下方涉及 `ps` 命令后使用 `grep` 过滤的框架进程方式，如果你的服务器同时有其他使用 PHP 启动的服务，命令行刚好有 `server` 字样，可能会导致误杀，如果有影响的话，建议将 `grep server` 换成你启动时命令行的特殊参数或手动排除！
|
||||
下方涉及 `ps` 命令后使用 `grep` 过滤的框架进程方式，如果你的服务器同时有其他使用 PHP 启动的服务，命令行刚好有 `server` 字样，可能会导致误杀，如果有影响的话，建议将 `grep server` 换成你启动时命令行的特殊参数或手动排除！
|
||||
|
||||
:::
|
||||
|
||||
**一、**首先，使用 `ps`、`htop`、`netstat -nlp` 等命令确定框架的入口进程（也就是 Master 进程的 pid）。
|
||||
|
||||
@ -61,6 +63,3 @@ Manager 进程下的子进程，连号部分为对应的 Worker 进程，比如
|
||||
`htop` 使用方向键选择进程，选择到对应进程后可以使用 `F9` 来选择 kill 指令，比如让框架热重启，可以将光标移到 Master 进程上，使用 `SIGUSR1`：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -20,4 +20,4 @@ public function filter2() {
|
||||
}
|
||||
```
|
||||
|
||||
如果 `level >= 200`，那么此注解事件则会过滤 `waitMessage()`，如果 `level < 200`，则不会。（`@CQBefore` 的默认 level 为 20，所以默认情况下是不会过滤 waitMessage 的）
|
||||
如果 `level >= 200`，那么此注解事件则会过滤 `waitMessage()`，如果 `level < 200`，则不会。（`@CQBefore` 的默认 level 为 20，所以默认情况下是不会过滤 waitMessage 的）
|
||||
|
||||
50
docs/guide/README.md
Normal file
50
docs/guide/README.md
Normal file
@ -0,0 +1,50 @@
|
||||
# 介绍
|
||||
|
||||
::: tip 提示
|
||||
|
||||
编写文档需要较大精力，你也可以参与到本文档的建设中来，比如找错字，增加或更正内容，每页文档可直接点击右上方铅笔图标直接跳转至 GitHub 进行编辑，编辑后自动 Fork 并生成 Pull Request，以此来贡献此文档！
|
||||
|
||||
:::
|
||||
|
||||
炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（OneBot 标准的机器人对接），包含 WebSocket、HTTP 等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。
|
||||
|
||||
框架主要用途为 HTTP/WebSocket 服务器，机器人搭建框架。尤其对于聊天机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。
|
||||
|
||||
此外，QQ 机器人方面此框架基于 OneBot 标准的反向 WebSocket 连接，比传统 HTTP 通信更快。
|
||||
|
||||
```php
|
||||
/**
|
||||
* @CQCommand("你好")
|
||||
*/
|
||||
public function hello() {
|
||||
ctx()->reply("你好，我是炸毛！");
|
||||
}
|
||||
/**
|
||||
* @RequestMapping("/index")
|
||||
*/
|
||||
public function index() {
|
||||
return "<h1>hello!</h1>";
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 开始前
|
||||
|
||||
首先，你需要了解你需要知道哪些事情才能开始着手使用框架：
|
||||
|
||||
1. Linux 命令行（会跑 Linux 程序）
|
||||
2. php >=7.2 开发环境（项目会持续支持最新的 PHP 版本）
|
||||
4. OneBot 机器人聊天接口标准
|
||||
|
||||
需要值得注意的是，本教程中所涉及的内容均为尽可能翻译为白话的方式进行描述，但对于框架的组件或事件等需要单独拆分说明文档的部分则需要足够详细，所以本教程提供一个快速上手的教程，并且会将最典型的安装方式写到快速教程篇。
|
||||
|
||||
## 框架特色
|
||||
|
||||
- 支持MySQL数据库（连接池），自带查询缓存提高多查询时的效率
|
||||
- Websocket 服务器、HTTP 服务器兼容运行，一个框架多个用处
|
||||
- 支持命令、自然语言处理等多种插件形式
|
||||
- 支持多个机器人账号负载均衡
|
||||
- 协程 + TaskWorker 进程重度任务处理机制，保证高效，单个请求响应时间为 0.1 ms 左右
|
||||
- 模块分离和自由组合，可根据自身需求自己建立模块内的目录结构和代码结构
|
||||
- 灵活的注释注解注册事件方式，弥补 PHP 语言缺少注解的遗憾
|
||||
@ -2,9 +2,11 @@
|
||||
|
||||
到目前为止，炸毛框架的配置文件还没有任何变更，是默认的行为。在本章内容中，将列举出炸毛框架的配置文件的规则和使用。
|
||||
|
||||
!!! error "警告"
|
||||
::: danger 警告
|
||||
|
||||
因为炸毛框架的全局配置中含有数据库名称和密码以及 access_token 等敏感字段，在使用版本控制软件过程中请不要将敏感信息写入配置文件并提交至开源仓库！
|
||||
因为炸毛框架的全局配置中含有数据库名称和密码以及 access_token 等敏感字段，在使用版本控制软件过程中请不要将敏感信息写入配置文件并提交至开源仓库！
|
||||
|
||||
:::
|
||||
|
||||
## 全局配置文件 global.php
|
||||
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
# 错误码对照表
|
||||
|
||||
| 异常码 | 含义 | 解决方案 |
|
||||
| ------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| E00001 | 炸毛框架未检测到 PHP 安装了 Swoole 扩展 | 根据文档安装扩展去！ |
|
||||
@ -75,4 +77,3 @@
|
||||
| E00073 | 在类中找不到方法 | 检查调用对象是否存在对应的方法（method）或检查是否插入了对应的macro宏方法 |
|
||||
| E00074 | 参数非法 | 检查调用的参数是否正常（此处可能有多处问题，请看具体调用栈炸掉的地方） |
|
||||
| E99999 | 未知错误 | |
|
||||
|
||||
|
||||
@ -44,7 +44,6 @@ docker run -it --rm -v $(pwd):/app/ -p 20001:20001 zmbot/swoole vendor/bin/start
|
||||
docker run -it --rm -v $(pwd):/app/ -p 20001:20001 zmbot/swoole vendor/bin/start server
|
||||
```
|
||||
|
||||
|
||||
启动后你会看到和下方类似的初始化内容，表明启动成功了
|
||||
|
||||
```verilog
|
||||
@ -80,4 +79,4 @@ $ vendor/bin/start server
|
||||
我们使用文本编辑器进行炸毛框架开发，在使用集成开发环境 **IDEA** 或 **PhpStorm** 时，推荐通过插件市场搜索并安装 **PHP Annotations** 插件以提供注解命名空间自动补全、注解属性代码提醒、注解类跳转等，非常有助于提升开发效率的功能。
|
||||
|
||||
## 进阶环境部署和开发
|
||||
炸毛框架还支持更多种启动方式，如源码模式、守护进程模式，具体后续有关环境和部署的进阶教程，请查看 [进阶开发](/advanced/) 部分！
|
||||
炸毛框架还支持更多种启动方式，如源码模式、守护进程模式，具体后续有关环境和部署的进阶教程，请查看 [进阶开发](/advanced/) 部分！
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## 什么是 OneBot
|
||||
|
||||
OneBot 是一个聊天机器人应用接口标准，详情戳[这里](https://github.com/howmanybots/onebot)。
|
||||
OneBot 是一个聊天机器人应用接口标准，详情戳 [这里](https://github.com/howmanybots/onebot)。
|
||||
|
||||
## OneBot 实现选择
|
||||
|
||||
@ -20,4 +20,4 @@ OneBot 是一个聊天机器人应用接口标准，详情戳[这里](https://gi
|
||||
|
||||
因为目前炸毛框架 2.0 只支持 WebSocket 方式的 OneBot 实现，所以目前上述项目的连接方式均只可选支持反向 WebSocket 通信的。后期会兼容 HTTP 和正向 WebSocket 通信方式。
|
||||
|
||||
如果你还没有自己的 QQ，或者是其他原因导致的暂时无法使用上述 OneBot 实例，可以使用炸毛项目中的 OneBot 协议聊天模拟器。但目前还处在开发中，暂不可用。
|
||||
如果你还没有自己的 QQ，或者是其他原因导致的暂时无法使用上述 OneBot 实例，可以使用炸毛项目中的 OneBot 协议聊天模拟器。但目前还处在开发中，暂不可用。
|
||||
|
||||
@ -7,4 +7,3 @@ HTTP 服务器篇主要讲解如何通过炸毛框架来实现微服务、API
|
||||
- [HTTP 服务器 - 存储 - Redis](/component/redis/)
|
||||
- [HTTP 服务器 - 存储 - MySQL](/component/mysql/)
|
||||
- [HTTP 客户端](/component/zmrequest/)
|
||||
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
# 快速上手 - 机器人篇
|
||||
|
||||
|
||||
|
||||
## 简介
|
||||
|
||||
看到这里，你已经完成了前面的环境部署，到了最关键的第一步了！
|
||||
@ -26,268 +24,107 @@ OneBot 机器人部分的选择详情见 [OneBot 实例](/guide/OneBot实例/)
|
||||
2. 双击 exe 文件或者使用 `./go-cqhttp` 启动
|
||||
3. 生成默认配置文件并修改默认配置
|
||||
|
||||
!!! warning "注意"
|
||||
::: warning 注意
|
||||
|
||||
由于 go-cqhttp 项目还处于开发期，而且配置文件格式也发生了多次变化，但大体内容没有变（比如编写此文档时发布的版本中配置文件格式变成了 `hjson` 取代了原来的 `json`。
|
||||
由于 go-cqhttp 项目还处于开发期，而且配置文件格式也发生了多次变化，但大体内容没有变（比如编写此文档时发布的版本中配置文件格式变成了 `hjson` 取代了原来的 `json`。
|
||||
|
||||
=== "config.yml（最新格式）"
|
||||
:::
|
||||
|
||||
```yaml hl_lines="2 3 78 83"
|
||||
account: # 账号相关
|
||||
uin: 1233456 # QQ账号
|
||||
password: '' # 密码为空时使用扫码登录
|
||||
encrypt: false # 是否开启密码加密
|
||||
status: 0 # 在线状态 请参考 https://github.com/Mrs4s/go-cqhttp/blob/dev/docs/config.md#在线状态
|
||||
relogin: # 重连设置
|
||||
delay: 3 # 首次重连延迟, 单位秒
|
||||
interval: 3 # 重连间隔
|
||||
max-times: 0 # 最大重连次数, 0为无限制
|
||||
|
||||
# 是否使用服务器下发的新地址进行重连
|
||||
# 注意, 此设置可能导致在海外服务器上连接情况更差
|
||||
use-sso-address: true
|
||||
|
||||
heartbeat:
|
||||
# 心跳频率, 单位秒
|
||||
# -1 为关闭心跳
|
||||
interval: 5
|
||||
|
||||
message:
|
||||
# 上报数据类型
|
||||
# 可选: string,array
|
||||
post-format: string
|
||||
# 是否忽略无效的CQ码, 如果为假将原样发送
|
||||
ignore-invalid-cqcode: false
|
||||
# 是否强制分片发送消息
|
||||
# 分片发送将会带来更快的速度
|
||||
# 但是兼容性会有些问题
|
||||
force-fragment: false
|
||||
# 是否将url分片发送
|
||||
fix-url: false
|
||||
# 下载图片等请求网络代理
|
||||
proxy-rewrite: ''
|
||||
# 是否上报自身消息
|
||||
report-self-message: false
|
||||
# 移除服务端的Reply附带的At
|
||||
remove-reply-at: false
|
||||
# 为Reply附加更多信息
|
||||
extra-reply-data: false
|
||||
|
||||
output:
|
||||
# 日志等级 trace,debug,info,warn,error
|
||||
log-level: warn
|
||||
# 是否启用 DEBUG
|
||||
debug: false # 开启调试模式
|
||||
|
||||
# 默认中间件锚点
|
||||
default-middlewares: &default
|
||||
# 访问密钥, 强烈推荐在公网的服务器设置
|
||||
access-token: ''
|
||||
# 事件过滤器文件目录
|
||||
filter: ''
|
||||
# API限速设置
|
||||
# 该设置为全局生效
|
||||
# 原 cqhttp 虽然启用了 rate_limit 后缀, 但是基本没插件适配
|
||||
# 目前该限速设置为令牌桶算法, 请参考:
|
||||
# https://baike.baidu.com/item/%E4%BB%A4%E7%89%8C%E6%A1%B6%E7%AE%97%E6%B3%95/6597000?fr=aladdin
|
||||
rate-limit:
|
||||
enabled: false # 是否启用限速
|
||||
frequency: 1 # 令牌回复频率, 单位秒
|
||||
bucket: 1 # 令牌桶大小
|
||||
|
||||
database: # 数据库相关设置
|
||||
leveldb:
|
||||
# 是否启用内置leveldb数据库
|
||||
# 启用将会增加10-20MB的内存占用和一定的磁盘空间
|
||||
# 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
|
||||
enable: true
|
||||
|
||||
# 连接服务列表
|
||||
servers:
|
||||
# 添加方式，同一连接方式可添加多个，具体配置说明请查看文档
|
||||
#- http: # http 通信
|
||||
#- ws: # 正向 Websocket
|
||||
#- ws-reverse: # 反向 Websocket
|
||||
#- pprof: #性能分析服务器
|
||||
# Zhamao Framework 所需要的服务器配置
|
||||
- ws-reverse:
|
||||
# 是否禁用当前反向WS服务
|
||||
disabled: false
|
||||
# 反向WS Universal 地址
|
||||
# 注意 设置了此项地址后下面两项将会被忽略
|
||||
universal: ws://127.0.0.1:20001/
|
||||
# 反向WS API 地址
|
||||
api: ws://your_websocket_api.server
|
||||
# 反向WS Event 地址
|
||||
event: ws://your_websocket_event.server
|
||||
# 重连间隔 单位毫秒
|
||||
reconnect-interval: 3000
|
||||
middlewares:
|
||||
<<: *default # 引用默认中间件
|
||||
```
|
||||
config.yml（最新格式）：
|
||||
|
||||
=== "config.hjson（v1.0.0-beta2或更早版本所用格式）"
|
||||
```yaml {2,3,78,83}
|
||||
account: # 账号相关
|
||||
uin: 1233456 # QQ账号
|
||||
password: '' # 密码为空时使用扫码登录
|
||||
encrypt: false # 是否开启密码加密
|
||||
status: 0 # 在线状态 请参考 https://github.com/Mrs4s/go-cqhttp/blob/dev/docs/config.md#在线状态
|
||||
relogin: # 重连设置
|
||||
delay: 3 # 首次重连延迟, 单位秒
|
||||
interval: 3 # 重连间隔
|
||||
max-times: 0 # 最大重连次数, 0为无限制
|
||||
|
||||
``` json hl_lines="3 5 81 84"
|
||||
{
|
||||
// QQ号
|
||||
uin: 你的机器人QQ
|
||||
// QQ密码
|
||||
password: "你的QQ密码"
|
||||
// 是否启用密码加密
|
||||
encrypt_password: false
|
||||
// 加密后的密码, 如未启用密码加密将为空, 请勿随意修改.
|
||||
password_encrypted: ""
|
||||
// 是否启用内置数据库
|
||||
// 启用将会增加10-20MB的内存占用和一定的磁盘空间
|
||||
// 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
|
||||
enable_db: true
|
||||
// 访问密钥, 强烈推荐在公网的服务器设置
|
||||
access_token: ""
|
||||
// 重连设置
|
||||
relogin: {
|
||||
// 是否启用自动重连
|
||||
// 如不启用掉线后将不会自动重连
|
||||
enabled: true
|
||||
// 重连延迟, 单位秒
|
||||
relogin_delay: 3
|
||||
// 最大重连次数, 0为无限制
|
||||
max_relogin_times: 0
|
||||
}
|
||||
// API限速设置
|
||||
// 该设置为全局生效
|
||||
// 原 cqhttp 虽然启用了 rate_limit 后缀, 但是基本没插件适配
|
||||
// 目前该限速设置为令牌桶算法, 请参考:
|
||||
//https://baike.baidu.com/item/%E4%BB%A4%E7%89%8C%E6%A1%B6%E7%AE%97%E6%B3%95/6597000?fr=aladdin
|
||||
_rate_limit: {
|
||||
// 是否启用限速
|
||||
enabled: false
|
||||
// 令牌回复频率, 单位秒
|
||||
frequency: 1
|
||||
// 令牌桶大小
|
||||
bucket_size: 1
|
||||
}
|
||||
// 是否忽略无效的CQ码
|
||||
// 如果为假将原样发送
|
||||
ignore_invalid_cqcode: false
|
||||
// 是否强制分片发送消息
|
||||
// 分片发送将会带来更快的速度
|
||||
// 但是兼容性会有些问题
|
||||
force_fragmented: false
|
||||
// 心跳频率, 单位秒
|
||||
// -1 为关闭心跳
|
||||
heartbeat_interval: 0
|
||||
// HTTP设置
|
||||
http_config: {
|
||||
// 是否启用正向HTTP服务器
|
||||
enabled: true
|
||||
// 服务端监听地址
|
||||
host: 0.0.0.0
|
||||
// 服务端监听端口
|
||||
port: 5700
|
||||
// 反向HTTP超时时间, 单位秒
|
||||
// 最小值为5，小于5将会忽略本项设置
|
||||
timeout: 0
|
||||
// 反向HTTP POST地址列表
|
||||
// 格式:
|
||||
// {
|
||||
// 地址: secret
|
||||
// }
|
||||
post_urls: {}
|
||||
}
|
||||
// 正向WS设置
|
||||
ws_config: {
|
||||
// 是否启用正向WS服务器
|
||||
enabled: true
|
||||
// 正向WS服务器监听地址
|
||||
host: 0.0.0.0
|
||||
// 正向WS服务器监听端口
|
||||
port: 6700
|
||||
}
|
||||
// 反向WS设置
|
||||
ws_reverse_servers: [
|
||||
// 可以添加多个反向WS推送
|
||||
{
|
||||
// 是否启用该推送
|
||||
enabled: true
|
||||
// 反向WS Universal 地址
|
||||
// 注意 设置了此项地址后下面两项将会被忽略
|
||||
reverse_url: ws://127.0.0.1:20001/
|
||||
// 反向WS API 地址
|
||||
reverse_api_url: ""
|
||||
// 反向WS Event 地址
|
||||
reverse_event_url: ""
|
||||
// 重连间隔 单位毫秒
|
||||
reverse_reconnect_interval: 3000
|
||||
}
|
||||
]
|
||||
// 上报数据类型
|
||||
// 可选: string array
|
||||
post_message_format: string
|
||||
// 是否使用服务器下发的新地址进行重连
|
||||
// 注意, 此设置可能导致在海外服务器上连接情况更差
|
||||
use_sso_address: false
|
||||
// 是否启用 DEBUG
|
||||
debug: false
|
||||
// 日志等级
|
||||
// WebUi 设置
|
||||
web_ui: {
|
||||
// 是否启用 WebUi
|
||||
enabled: true
|
||||
// 监听地址
|
||||
host: 127.0.0.1
|
||||
// 监听端口
|
||||
web_ui_port: 9999
|
||||
// 是否接收来自web的输入
|
||||
web_input: false
|
||||
}
|
||||
}
|
||||
```
|
||||
# 是否使用服务器下发的新地址进行重连
|
||||
# 注意, 此设置可能导致在海外服务器上连接情况更差
|
||||
use-sso-address: true
|
||||
|
||||
=== "config.json（旧格式）"
|
||||
heartbeat:
|
||||
# 心跳频率, 单位秒
|
||||
# -1 为关闭心跳
|
||||
interval: 5
|
||||
|
||||
``` json hl_lines="2 3 30 31"
|
||||
{
|
||||
"uin": 你的QQ号,
|
||||
"password": "你的密码",
|
||||
"encrypt_password": false,
|
||||
"password_encrypted": "",
|
||||
"enable_db": true,
|
||||
"access_token": "",
|
||||
"relogin": {
|
||||
"enabled": true,
|
||||
"relogin_delay": 3,
|
||||
"max_relogin_times": 0
|
||||
},
|
||||
"ignore_invalid_cqcode": false,
|
||||
"force_fragmented": true,
|
||||
"heartbeat_interval": 0,
|
||||
"http_config": {
|
||||
"enabled": false,
|
||||
"host": "0.0.0.0",
|
||||
"port": 5700,
|
||||
"timeout": 0,
|
||||
"post_urls": {}
|
||||
},
|
||||
"ws_config": {
|
||||
"enabled": false,
|
||||
"host": "0.0.0.0",
|
||||
"port": 6700
|
||||
},
|
||||
"ws_reverse_servers": [
|
||||
{
|
||||
"enabled": true,
|
||||
"reverse_url": "ws://127.0.0.1:20001/",
|
||||
"reverse_api_url": "",
|
||||
"reverse_event_url": "",
|
||||
"reverse_reconnect_interval": 3000
|
||||
}
|
||||
],
|
||||
"post_message_format": "string",
|
||||
"debug": false,
|
||||
"log_level": ""
|
||||
}
|
||||
```
|
||||
message:
|
||||
# 上报数据类型
|
||||
# 可选: string,array
|
||||
post-format: string
|
||||
# 是否忽略无效的CQ码, 如果为假将原样发送
|
||||
ignore-invalid-cqcode: false
|
||||
# 是否强制分片发送消息
|
||||
# 分片发送将会带来更快的速度
|
||||
# 但是兼容性会有些问题
|
||||
force-fragment: false
|
||||
# 是否将url分片发送
|
||||
fix-url: false
|
||||
# 下载图片等请求网络代理
|
||||
proxy-rewrite: ''
|
||||
# 是否上报自身消息
|
||||
report-self-message: false
|
||||
# 移除服务端的Reply附带的At
|
||||
remove-reply-at: false
|
||||
# 为Reply附加更多信息
|
||||
extra-reply-data: false
|
||||
|
||||
output:
|
||||
# 日志等级 trace,debug,info,warn,error
|
||||
log-level: warn
|
||||
# 是否启用 DEBUG
|
||||
debug: false # 开启调试模式
|
||||
|
||||
# 默认中间件锚点
|
||||
default-middlewares: &default
|
||||
# 访问密钥, 强烈推荐在公网的服务器设置
|
||||
access-token: ''
|
||||
# 事件过滤器文件目录
|
||||
filter: ''
|
||||
# API限速设置
|
||||
# 该设置为全局生效
|
||||
# 原 cqhttp 虽然启用了 rate_limit 后缀, 但是基本没插件适配
|
||||
# 目前该限速设置为令牌桶算法, 请参考:
|
||||
# https://baike.baidu.com/item/%E4%BB%A4%E7%89%8C%E6%A1%B6%E7%AE%97%E6%B3%95/6597000?fr=aladdin
|
||||
rate-limit:
|
||||
enabled: false # 是否启用限速
|
||||
frequency: 1 # 令牌回复频率, 单位秒
|
||||
bucket: 1 # 令牌桶大小
|
||||
|
||||
database: # 数据库相关设置
|
||||
leveldb:
|
||||
# 是否启用内置leveldb数据库
|
||||
# 启用将会增加10-20MB的内存占用和一定的磁盘空间
|
||||
# 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
|
||||
enable: true
|
||||
|
||||
# 连接服务列表
|
||||
servers:
|
||||
# 添加方式，同一连接方式可添加多个，具体配置说明请查看文档
|
||||
#- http: # http 通信
|
||||
#- ws: # 正向 Websocket
|
||||
#- ws-reverse: # 反向 Websocket
|
||||
#- pprof: #性能分析服务器
|
||||
# Zhamao Framework 所需要的服务器配置
|
||||
- ws-reverse:
|
||||
# 是否禁用当前反向WS服务
|
||||
disabled: false
|
||||
# 反向WS Universal 地址
|
||||
# 注意 设置了此项地址后下面两项将会被忽略
|
||||
universal: ws://127.0.0.1:20001/
|
||||
# 反向WS API 地址
|
||||
api: ws://your_websocket_api.server
|
||||
# 反向WS Event 地址
|
||||
event: ws://your_websocket_event.server
|
||||
# 重连间隔 单位毫秒
|
||||
reconnect-interval: 3000
|
||||
middlewares:
|
||||
<<: *default # 引用默认中间件
|
||||
```
|
||||
|
||||
其中 ws://127.0.0.1:20001/ 中的 127.0.0.1 和 20001 应分别对应炸毛框架配置的 HOST 和 PORT
|
||||
|
||||
@ -320,21 +157,19 @@ public function repeat() {
|
||||
|
||||
这样，一个简易的复读机就做好了！回到 QQ 机器人聊天，向机器人发送 `echo 你好啊`，它会回复你 `你好啊`。
|
||||
|
||||
<chat-box>
|
||||
) echo 你好啊
|
||||
( 你好啊
|
||||
) echo
|
||||
( 请输入你要回复的内容
|
||||
) 哦豁
|
||||
( 哦豁
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'echo 你好啊'},
|
||||
{type:1,content:'你好啊'},
|
||||
{type:0,content:'echo'},
|
||||
{type:1,content:'请输入你要回复的内容'},
|
||||
{type:0,content:'哦豁'},
|
||||
{type:1,content:'哦豁'},
|
||||
]"></chat-box>
|
||||
|
||||
> 如果你只回复 `echo` 的话，它会先和你进入一个会话状态，并问你 `请输入你要回复的内容`，这时你再次说一些内容例如 `哦豁`，会回复你 `哦豁`。效果和直接输入 `echo 哦豁` 是一致的，这是炸毛框架内的一个封装好的命令参数对话询问功能。有关参数询问功能，请看后面的进阶模块。
|
||||
|
||||
|
||||
|
||||
## 使用机器人 API 和事件
|
||||
|
||||
如果你想不只是回复消息，还要做其他复杂的动作（Action），使用 OneBot Action（又名 OneBot API）进行发送即可，见 [机器人 API](/component/bot/robot-api)。
|
||||
|
||||
如果想处理其他类型的事件，比如 QQ 群通知事件等，见 [机器人注解事件](/event/robot-annotations/)。
|
||||
如果想处理其他类型的事件，比如 QQ 群通知事件等，见 [机器人注解事件](/event/robot-annotations/)。
|
||||
|
||||
@ -39,8 +39,11 @@ class Weather {
|
||||
}
|
||||
```
|
||||
|
||||
!!! note "提示"
|
||||
为了简单起见，我们在这里的例子中没有接入真实的天气数据，但要接入也非常简单，你可以使用中国天气网、和风天气等网站提供的 API，本教程的进阶一栏后期会详细编写如何对接一个天气 API 接口。
|
||||
::: tip 提示
|
||||
|
||||
为了简单起见，我们在这里的例子中没有接入真实的天气数据，但要接入也非常简单，你可以使用中国天气网、和风天气等网站提供的 API，本教程的进阶一栏后期会详细编写如何对接一个天气 API 接口。
|
||||
|
||||
:::
|
||||
|
||||
在上方代码编写完毕后，运行框架（或运行过程中终端输入 `reload`），然后使用机器人客户端连接到炸毛框架，即可实现我们的第一个功能。我们在代码中编写了一个**注解事件**：`@CQCommand`，此注解事件是用于接收用户的普通消息并切分成各类命令规则的一个注解事件绑定。代码中的注解事件省去了注解中的键名，也可以写作 `@CQCommand(match="天气")`。
|
||||
|
||||
@ -56,11 +59,11 @@ class Weather {
|
||||
|
||||
最后，函数直接返回了一个字符串，作为事件的响应，炸毛框架会自动处理并调用机器人客户端的接口，最后返回给用户消息。这里也可以使用上下文的 `ctx()->reply("xxx")` 方法替代，不返回字符串。注意两者只能选择一种方式，取决于开发者的开发习惯。
|
||||
|
||||
<chat-box>
|
||||
) 天气 北京
|
||||
( 北京 天气情况：2020年12月22日，晴，-2~9℃ blablabla
|
||||
) 天气
|
||||
( 请告诉我你要查询的城市
|
||||
) 北京
|
||||
( 北京 天气情况：2020年12月22日，晴，-2~9℃ blablabla
|
||||
</chat-box>
|
||||
<chat-box :my-chats="[
|
||||
{type:0,content:'天气 北京'},
|
||||
{type:1,content:'北京 天气情况：2020年12月22日，晴，-2~9℃ blablabla'},
|
||||
{type:0,content:'天气'},
|
||||
{type:1,content:'请告诉我你要查询的城市'},
|
||||
{type:0,content:'北京'},
|
||||
{type:1,content:'北京 天气情况：2020年12月22日，晴，-2~9℃ blablabla'},
|
||||
]"></chat-box>
|
||||
|
||||
@ -34,4 +34,4 @@ Phar 打包模式更新则必须重新自行打包新版本，例如从 Composer
|
||||
|
||||
## 升级提示
|
||||
|
||||
如果在升级过程中遇到了提示，则可能是需要升级某些配置文件需要手动进行合并更新。如果提示了更新，建议到 `vendor/zhamao/framework/config/global.php` 框架的最新库内配置文件与 `config/global.php` 文件进行对比。
|
||||
如果在升级过程中遇到了提示，则可能是需要升级某些配置文件需要手动进行合并更新。如果提示了更新，建议到 `vendor/zhamao/framework/config/global.php` 框架的最新库内配置文件与 `config/global.php` 文件进行对比。
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
框架默认使用脚手架构建好后，目录结构大致为下面这样：
|
||||
|
||||
```bash
|
||||
```
|
||||
zhamao-framework-starter/
|
||||
├── config/ # 项目的配置文件文件夹，如 global.php
|
||||
├── src/ # 项目的主要源码目录
|
||||
@ -28,20 +28,28 @@ namespace Module\<your-module-dir>;
|
||||
class ModuleA {}
|
||||
```
|
||||
|
||||
!!! fail "警告"
|
||||
如果没有遵守上方的类和文件命名规则的话（文件名、文件夹名和命名空间的统一性），在加载框架时就会报错，无法找到对应的类。因为框架的注解解析依赖于 Composer 中 psr-4 规则的自动加载。
|
||||
::: danger 警告
|
||||
|
||||
如果没有遵守上方的类和文件命名规则的话（文件名、文件夹名和命名空间的统一性），在加载框架时就会报错，无法找到对应的类。因为框架的注解解析依赖于 Composer 中 psr-4 规则的自动加载。
|
||||
|
||||
:::
|
||||
|
||||
## 创建模块
|
||||
|
||||
### 标准形式
|
||||
|
||||
我们这里以 `Entertain` 娱乐模块的创建为例，新建一个内有 `Dice.php` 掷骰子功能的模块，目录结构如下，在 `Module/` 下新建文件夹 `Entertain/`，再在此子目录下新建 `Dice.php` 文件。
|
||||
```bash
|
||||
|
||||
```
|
||||
zhamao-framework-starter/
|
||||
└── src/
|
||||
└── Module/
|
||||
└── Entertain/
|
||||
└── Dice.php
|
||||
```
|
||||
|
||||
新建的 PHP 文件按照如下方式编写：
|
||||
|
||||
```php
|
||||
<?php
|
||||
namespace Module\Entertain;
|
||||
@ -55,7 +63,7 @@ class Dice {
|
||||
|
||||
如果你只开发很简单的一些功能，如一个 PHP 文件就可以实现的，可以少去创建模块文件夹的一步，直接将 `.php` 文件新建到 `Module/` 文件夹下，这时此文件的命名空间需要更正为 `namespace Module;` 即可，而文件夹结构也更加简单：
|
||||
|
||||
```bash
|
||||
```
|
||||
zhamao-framework-starter/
|
||||
└── src/
|
||||
└── Module/
|
||||
@ -64,5 +72,4 @@ zhamao-framework-starter/
|
||||
|
||||
### Composer 外部引入形式
|
||||
|
||||
（暂未支持，敬请期待）
|
||||
|
||||
（暂未支持，敬请期待，TODO：已经支持了，但缺少文档编写）
|
||||
|
||||
131
docs/index.md
131
docs/index.md
@ -1,131 +0,0 @@
|
||||
# 介绍
|
||||
|
||||
!!! tip "提示"
|
||||
|
||||
编写文档需要较大精力，你也可以参与到本文档的建设中来，比如找错字，增加或更正内容，每页文档可直接点击右上方铅笔图标直接跳转至 GitHub 进行编辑，编辑后自动 Fork 并生成 Pull Request，以此来贡献此文档！
|
||||
|
||||
炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（OneBot 标准的机器人对接），包含 WebSocket、HTTP 等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。
|
||||
|
||||
框架主要用途为 HTTP/WebSocket 服务器，机器人搭建框架。尤其对于聊天机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。
|
||||
|
||||
此外，QQ 机器人方面此框架基于 OneBot 标准的反向 WebSocket 连接，比传统 HTTP 通信更快。
|
||||
|
||||
```php
|
||||
/**
|
||||
* @CQCommand("你好")
|
||||
*/
|
||||
public function hello() {
|
||||
ctx()->reply("你好，我是炸毛！");
|
||||
}
|
||||
/**
|
||||
* @RequestMapping("/index")
|
||||
*/
|
||||
public function index() {
|
||||
return "<h1>hello!</h1>";
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 开始前
|
||||
|
||||
首先，你需要了解你需要知道哪些事情才能开始着手使用框架：
|
||||
|
||||
1. Linux 命令行（会跑 Linux 程序）
|
||||
2. php >=7.2 开发环境（项目会持续支持最新的 PHP 版本）
|
||||
4. OneBot 机器人聊天接口标准
|
||||
|
||||
需要值得注意的是，本教程中所涉及的内容均为尽可能翻译为白话的方式进行描述，但对于框架的组件或事件等需要单独拆分说明文档的部分则需要足够详细，所以本教程提供一个快速上手的教程，并且会将最典型的安装方式写到快速教程篇。
|
||||
|
||||
!!! bug "文档提示"
|
||||
|
||||
此文档采用 MkDocs 驱动，文档的搜索组件原生不支持中文搜索，且分词很难控制，所以搜索体验会大打折扣，敬请谅解！搜不到不是没这个东西，建议这种情况可以自行翻阅目录查看！
|
||||
|
||||
|
||||
## 框架特色
|
||||
|
||||
- 支持MySQL数据库（连接池），自带查询缓存提高多查询时的效率
|
||||
- Websocket 服务器、HTTP 服务器兼容运行，一个框架多个用处
|
||||
- 支持命令、自然语言处理等多种插件形式
|
||||
- 支持多个机器人账号负载均衡
|
||||
- 协程 + TaskWorker 进程重度任务处理机制，保证高效，单个请求响应时间为 0.1 ms 左右
|
||||
- 模块分离和自由组合，可根据自身需求自己建立模块内的目录结构和代码结构
|
||||
- 灵活的注释注解注册事件方式，弥补 PHP 语言缺少注解的遗憾
|
||||
|
||||
## 文档主题
|
||||
|
||||
### 主题
|
||||
|
||||
<div class="tx-switch">
|
||||
<button data-md-color-scheme="default"><code>默认模式</code></button>
|
||||
<button data-md-color-scheme="slate"><code>暗黑模式</code></button>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
var buttons = document.querySelectorAll("button[data-md-color-scheme]");
|
||||
buttons.forEach(function(button) {
|
||||
button.addEventListener("click", function() {
|
||||
var attr = this.getAttribute("data-md-color-scheme");
|
||||
setCookie("_theme", attr);
|
||||
document.body.setAttribute("data-md-color-scheme", attr);
|
||||
var name = document.querySelector("#__code_0 code span:nth-child(7)");
|
||||
name.textContent = attr;
|
||||
})
|
||||
})
|
||||
</script>
|
||||
|
||||
### 主色调
|
||||
|
||||
<div class="tx-switch">
|
||||
<button data-md-color-primary="red"><code>red</code></button>
|
||||
<button data-md-color-primary="pink"><code>pink</code></button>
|
||||
<button data-md-color-primary="purple"><code>purple</code></button>
|
||||
<button data-md-color-primary="deep-purple"><code>deep purple</code></button>
|
||||
<button data-md-color-primary="indigo"><code>indigo</code></button>
|
||||
<button data-md-color-primary="blue"><code>blue</code></button>
|
||||
<button data-md-color-primary="light-blue"><code>light blue</code></button>
|
||||
<button data-md-color-primary="cyan"><code>cyan</code></button>
|
||||
<button data-md-color-primary="teal"><code>teal</code></button>
|
||||
<button data-md-color-primary="green"><code>green</code></button>
|
||||
<button data-md-color-primary="light-green"><code>light green</code></button>
|
||||
<button data-md-color-primary="lime"><code>lime</code></button>
|
||||
<button data-md-color-primary="yellow"><code>yellow</code></button>
|
||||
<button data-md-color-primary="amber"><code>amber</code></button>
|
||||
<button data-md-color-primary="orange"><code>orange</code></button>
|
||||
<button data-md-color-primary="deep-orange"><code>deep orange</code></button>
|
||||
<button data-md-color-primary="brown"><code>brown</code></button>
|
||||
<button data-md-color-primary="grey"><code>grey</code></button>
|
||||
<button data-md-color-primary="blue-grey"><code>blue grey</code></button>
|
||||
<button data-md-color-primary="black"><code>black</code></button>
|
||||
<button data-md-color-primary="white"><code>white</code></button>
|
||||
</div>
|
||||
|
||||
### 辅色调
|
||||
|
||||
<div class="tx-switch"> <button data-md-color-accent="red"><code>red</code></button> <button data-md-color-accent="pink"><code>pink</code></button> <button data-md-color-accent="purple"><code>purple</code></button> <button data-md-color-accent="deep-purple"><code>deep purple</code></button> <button data-md-color-accent="indigo"><code>indigo</code></button> <button data-md-color-accent="blue"><code>blue</code></button> <button data-md-color-accent="light-blue"><code>light blue</code></button> <button data-md-color-accent="cyan"><code>cyan</code></button> <button data-md-color-accent="teal"><code>teal</code></button> <button data-md-color-accent="green"><code>green</code></button> <button data-md-color-accent="light-green"><code>light green</code></button> <button data-md-color-accent="lime"><code>lime</code></button> <button data-md-color-accent="yellow"><code>yellow</code></button> <button data-md-color-accent="amber"><code>amber</code></button> <button data-md-color-accent="orange"><code>orange</code></button> <button data-md-color-accent="deep-orange"><code>deep orange</code></button> </div>
|
||||
|
||||
<script>
|
||||
var buttons = document.querySelectorAll("button[data-md-color-primary]")
|
||||
buttons.forEach(function(button) {
|
||||
button.addEventListener("click", function() {
|
||||
var attr = this.getAttribute("data-md-color-primary")
|
||||
setCookie("_primary_color", attr)
|
||||
document.body.setAttribute("data-md-color-primary", attr)
|
||||
var name = document.querySelector("#__code_2 code span:nth-child(7)")
|
||||
name.textContent = attr.replace("-", " ")
|
||||
})
|
||||
})
|
||||
</script>
|
||||
|
||||
<script>
|
||||
var buttons2 = document.querySelectorAll("button[data-md-color-accent]")
|
||||
buttons2.forEach(function(button) {
|
||||
button.addEventListener("click", function() {
|
||||
var attr = this.getAttribute("data-md-color-accent")
|
||||
setCookie("_accent_color", attr)
|
||||
document.body.setAttribute("data-md-color-accent", attr)
|
||||
var name = document.querySelector("#__code_3 code span:nth-child(7)")
|
||||
name.textContent = attr.replace("-", " ")
|
||||
})
|
||||
})
|
||||
</script>
|
||||
@ -1,97 +0,0 @@
|
||||
hljs.initHighlighting()
|
||||
|
||||
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);
|
||||
})();
|
||||
|
||||
function appendChatModule(id, chatDialogs) {
|
||||
let insertDiv = document.getElementById(id);
|
||||
let ss = '';
|
||||
ss += '<div class="doc-chat-container">';
|
||||
for(let i of chatDialogs) {
|
||||
if (i.role === 0) {
|
||||
ss += '<div class="doc-chat-row doc-chat-row-robot">\n' +
|
||||
' <img class="doc-chat-avatar" src="https://docs-v1.zhamao.xin/logo.png" alt=""/>\n' +
|
||||
' <div class="doc-chat-box doc-chat-box-robot">' + i.msg + '</div>\n' +
|
||||
' </div>';
|
||||
} else {
|
||||
ss += '<div class="doc-chat-row">\n' +
|
||||
' <div class="doc-chat-box">' + i.msg + '</div>\n' +
|
||||
' <img class="doc-chat-avatar" src="http://api.btstu.cn/sjtx/api.php" alt=""/>\n' +
|
||||
' </div>';
|
||||
}
|
||||
}
|
||||
insertDiv.innerHTML = ss + '</div>';
|
||||
}
|
||||
|
||||
function getCookie(name) {
|
||||
var arr, reg = new RegExp("(^| )" + name + "=([^;]*)(;|$)");
|
||||
|
||||
if (arr = document.cookie.match(reg))
|
||||
|
||||
return unescape(arr[2]);
|
||||
else
|
||||
return null;
|
||||
}
|
||||
|
||||
function setCookie(name, value) {
|
||||
var Days = 30;
|
||||
var exp = new Date();
|
||||
exp.setTime(exp.getTime() + Days * 24 * 60 * 60 * 1000);
|
||||
document.cookie = name + "=" + escape(value) + ";expires=" + exp.toGMTString() + ";path=/";
|
||||
}
|
||||
|
||||
s_theme=getCookie("_theme");
|
||||
if(s_theme !== undefined) {
|
||||
document.body.setAttribute("data-md-color-scheme", s_theme)
|
||||
var name = document.querySelector("#__code_0 code span:nth-child(7)")
|
||||
name.textContent = s_theme
|
||||
}
|
||||
|
||||
s_primary=getCookie("_primary_color");
|
||||
if(s_primary !== null) {
|
||||
document.body.setAttribute("data-md-color-primary", s_primary);
|
||||
var name2 = document.querySelector("#__code_2 code span:nth-child(7)");
|
||||
if (s_primary !== null && name2 !== null) name2.textContent = s_primary.replace("-", " ");
|
||||
}
|
||||
|
||||
s_accent=getCookie("_accent_color");
|
||||
if(s_accent !== null) {
|
||||
document.body.setAttribute("data-md-color-accent", s_accent);
|
||||
var name3 = document.querySelector("#__code_3 code span:nth-child(7)");
|
||||
if (s_accent !== null && name3 !== null) name3.textContent = s_accent.replace("-", " ");
|
||||
}
|
||||
|
||||
setTimeout(() => {
|
||||
let ls = document.querySelectorAll("chat-box");
|
||||
for(let i of ls) {
|
||||
let final = '<div class="doc-chat-container">';
|
||||
let dialogs = i.innerHTML.split("\n");
|
||||
for(let j of dialogs) {
|
||||
if(j === '') continue;
|
||||
if(j.substr(0, 2) === ') ') {
|
||||
final += '<div class="doc-chat-row">\n' +
|
||||
' <div class="doc-chat-box">' + j.substr(2).replaceAll("\\n", "<br>") + '</div>\n' +
|
||||
' <img class="doc-chat-avatar" src="http://api.btstu.cn/sjtx/api.php" alt=""/>\n' +
|
||||
' </div>';
|
||||
} else if (j.substr(0, 2) === '( ') {
|
||||
final += '<div class="doc-chat-row doc-chat-row-robot">\n' +
|
||||
' <img class="doc-chat-avatar" src="https://docs-v1.zhamao.xin/logo.png" alt=""/>\n' +
|
||||
' <div class="doc-chat-box doc-chat-box-robot">' + j.substr(2).replaceAll("\\n", "<br>") + '</div>\n' +
|
||||
' </div>';
|
||||
} else if (j.substr(0, 2) === '^ ') {
|
||||
final += '<div class="doc-chat-row doc-chat-banner">' + j.substr(2) + '</div>';
|
||||
} else if (j.substr(0, 2) === '[ ') {
|
||||
final += '<div class="doc-chat-row doc-chat-row-robot">\n' +
|
||||
' <img class="doc-chat-avatar" src="https://docs-v1.zhamao.xin/logo.png" alt=""/>\n' +
|
||||
' <div class="doc-chat-box doc-chat-box-robot"><img src="' + j.substr(2) + '" alt=""/></div>\n' +
|
||||
' </div>';
|
||||
}
|
||||
}
|
||||
i.innerHTML = final;
|
||||
}
|
||||
}, 500);
|
||||
44
docs/javascripts/library/highlight.min.js
vendored
44
docs/javascripts/library/highlight.min.js
vendored
File diff suppressed because one or more lines are too long
@ -75,4 +75,4 @@ $config['remote_terminal'] = [
|
||||
'port' => 20002,
|
||||
'token' => ''
|
||||
];
|
||||
```
|
||||
```
|
||||
|
||||
@ -217,4 +217,4 @@ $config['server_event_handler_class'] = [
|
||||
|
||||
> 更新时间：2020.3.19
|
||||
|
||||
正式版发布。
|
||||
正式版发布。
|
||||
|
||||
10
package.json
Normal file
10
package.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"vuepress-theme-antdocs": "^1.3.5",
|
||||
"vuepress": "^1.9.7"
|
||||
},
|
||||
"scripts": {
|
||||
"docs:dev": "vuepress dev docs",
|
||||
"docs:build": "vuepress build docs"
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user