zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-07-20 15:15:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
zhamao-framework/event/bot.html
crazywhalecc 5c95c4a0e6 Auto deploy from Github Actions
2024-09-19 08:29:13 +00:00

83 lines
39 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>机器人事件 | 炸毛框架 v3</title>
<meta name="description" content="">
<meta name="generator" content="VuePress 1.9.10">
<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);
})();
</script>
<meta name="description" content="一个高性能聊天机器人 + Web 框架">
<link rel="preload" href="/assets/css/0.styles.de075592.css" as="style"><link rel="preload" href="/assets/js/app.cf958133.js" as="script"><link rel="preload" href="/assets/js/2.4c04991c.js" as="script"><link rel="preload" href="/assets/js/1.d8755a39.js" as="script"><link rel="preload" href="/assets/js/46.732b1cef.js" as="script"><link rel="prefetch" href="/assets/js/10.960912c3.js"><link rel="prefetch" href="/assets/js/11.cd171694.js"><link rel="prefetch" href="/assets/js/12.ff9ca1d1.js"><link rel="prefetch" href="/assets/js/13.a56deac8.js"><link rel="prefetch" href="/assets/js/14.b222a011.js"><link rel="prefetch" href="/assets/js/15.31489867.js"><link rel="prefetch" href="/assets/js/16.e921dbc4.js"><link rel="prefetch" href="/assets/js/17.58f730d3.js"><link rel="prefetch" href="/assets/js/18.26c46c49.js"><link rel="prefetch" href="/assets/js/19.ee0bfd3b.js"><link rel="prefetch" href="/assets/js/20.bb3578b8.js"><link rel="prefetch" href="/assets/js/21.e66f7fe5.js"><link rel="prefetch" href="/assets/js/22.cba8ca48.js"><link rel="prefetch" href="/assets/js/23.cb49f41c.js"><link rel="prefetch" href="/assets/js/24.d95b175a.js"><link rel="prefetch" href="/assets/js/25.b0d69869.js"><link rel="prefetch" href="/assets/js/26.8e7089c0.js"><link rel="prefetch" href="/assets/js/27.333a53a1.js"><link rel="prefetch" href="/assets/js/28.df4b871c.js"><link rel="prefetch" href="/assets/js/29.5427ad45.js"><link rel="prefetch" href="/assets/js/3.07fc018e.js"><link rel="prefetch" href="/assets/js/30.7cb7445a.js"><link rel="prefetch" href="/assets/js/31.5c4bb546.js"><link rel="prefetch" href="/assets/js/32.7fc05474.js"><link rel="prefetch" href="/assets/js/33.9684a4f8.js"><link rel="prefetch" href="/assets/js/34.83e32a28.js"><link rel="prefetch" href="/assets/js/35.95d03df6.js"><link rel="prefetch" href="/assets/js/36.80aace42.js"><link rel="prefetch" href="/assets/js/37.1eaed2ee.js"><link rel="prefetch" href="/assets/js/38.75fa7a1c.js"><link rel="prefetch" href="/assets/js/39.117f5802.js"><link rel="prefetch" href="/assets/js/4.6623271b.js"><link rel="prefetch" href="/assets/js/40.57eba153.js"><link rel="prefetch" href="/assets/js/41.89c4a7c8.js"><link rel="prefetch" href="/assets/js/42.d8f92f99.js"><link rel="prefetch" href="/assets/js/43.5ee83631.js"><link rel="prefetch" href="/assets/js/44.c09b5b0c.js"><link rel="prefetch" href="/assets/js/45.bd850606.js"><link rel="prefetch" href="/assets/js/47.2a872d0d.js"><link rel="prefetch" href="/assets/js/48.959e18f4.js"><link rel="prefetch" href="/assets/js/49.a9bb32f7.js"><link rel="prefetch" href="/assets/js/5.073233e8.js"><link rel="prefetch" href="/assets/js/50.ca90a854.js"><link rel="prefetch" href="/assets/js/51.79142530.js"><link rel="prefetch" href="/assets/js/52.fe63ad16.js"><link rel="prefetch" href="/assets/js/53.ed84845a.js"><link rel="prefetch" href="/assets/js/54.3ab7e492.js"><link rel="prefetch" href="/assets/js/55.9028e407.js"><link rel="prefetch" href="/assets/js/56.8173f798.js"><link rel="prefetch" href="/assets/js/57.2166b068.js"><link rel="prefetch" href="/assets/js/58.7c52b6bf.js"><link rel="prefetch" href="/assets/js/59.e9965a7b.js"><link rel="prefetch" href="/assets/js/60.f277436c.js"><link rel="prefetch" href="/assets/js/61.3712f8fe.js"><link rel="prefetch" href="/assets/js/8.899a0731.js"><link rel="prefetch" href="/assets/js/9.e2e8da12.js"><link rel="prefetch" href="/assets/js/vendors~docsearch.303532f0.js">
<link rel="stylesheet" href="/assets/css/0.styles.de075592.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="ant-row"><div class="nav-button"><i aria-label="icon: bars" class="anticon anticon-bars"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="bars" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M912 192H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 284H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 284H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM104 228a56 56 0 1 0 112 0 56 56 0 1 0-112 0zm0 284a56 56 0 1 0 112 0 56 56 0 1 0-112 0zm0 284a56 56 0 1 0 112 0 56 56 0 1 0-112 0z"></path></svg></i> <span></span></div> <div class="ant-col ant-col-xs-24 ant-col-sm-24 ant-col-md-6 ant-col-lg-6 ant-col-xl-5 ant-col-xxl-4"><a href="/" class="router-link-active home-link"><img src="/logo_trans.png" alt="炸毛框架 v3" class="logo"> <span class="site-name">炸毛框架 v3</span></a> <div class="search-box mobile-search"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div></div> <div class="nav-space-between ant-col ant-col-xs-0 ant-col-sm-0 ant-col-md-18 ant-col-lg-18 ant-col-xl-19 ant-col-xxl-20"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><ul role="menu" id="nav" class="ant-menu ant-menu-horizontal ant-menu-root ant-menu-light"><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/guide/">
指南
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item ant-menu-item-selected"><a href="/event/" class="router-link-active">
事件
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/components/bot/bot-context.html">
组件
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/plugins/management.html">
插件
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/advanced/">
进阶
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/update/v3.html">
更新日志
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/doxy/" target="_blank">
API 文档
<i aria-label="icon: link" class="anticon anticon-link"><svg viewBox="64 64 896 896" focusable="false" data-icon="link" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M574 665.4a8.03 8.03 0 0 0-11.3 0L446.5 781.6c-53.8 53.8-144.6 59.5-204 0-59.5-59.5-53.8-150.2 0-204l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3l-39.8-39.8a8.03 8.03 0 0 0-11.3 0L191.4 526.5c-84.6 84.6-84.6 221.5 0 306s221.5 84.6 306 0l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3L574 665.4zm258.6-474c-84.6-84.6-221.5-84.6-306 0L410.3 307.6a8.03 8.03 0 0 0 0 11.3l39.7 39.7c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c53.8-53.8 144.6-59.5 204 0 59.5 59.5 53.8 150.2 0 204L665.3 562.6a8.03 8.03 0 0 0 0 11.3l39.8 39.8c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c84.5-84.6 84.5-221.5 0-306.1zM610.1 372.3a8.03 8.03 0 0 0-11.3 0L372.3 598.7a8.03 8.03 0 0 0 0 11.3l39.6 39.6c3.1 3.1 8.2 3.1 11.3 0l226.4-226.4c3.1-3.1 3.1-8.2 0-11.3l-39.5-39.6z"></path></svg></i></a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="https://docs-v2.zhamao.xin/" target="_blank">
炸毛框架 v2
<i aria-label="icon: link" class="anticon anticon-link"><svg viewBox="64 64 896 896" focusable="false" data-icon="link" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M574 665.4a8.03 8.03 0 0 0-11.3 0L446.5 781.6c-53.8 53.8-144.6 59.5-204 0-59.5-59.5-53.8-150.2 0-204l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3l-39.8-39.8a8.03 8.03 0 0 0-11.3 0L191.4 526.5c-84.6 84.6-84.6 221.5 0 306s221.5 84.6 306 0l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3L574 665.4zm258.6-474c-84.6-84.6-221.5-84.6-306 0L410.3 307.6a8.03 8.03 0 0 0 0 11.3l39.7 39.7c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c53.8-53.8 144.6-59.5 204 0 59.5 59.5 53.8 150.2 0 204L665.3 562.6a8.03 8.03 0 0 0 0 11.3l39.8 39.8c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c84.5-84.6 84.5-221.5 0-306.1zM610.1 372.3a8.03 8.03 0 0 0-11.3 0L372.3 598.7a8.03 8.03 0 0 0 0 11.3l39.6 39.6c3.1 3.1 8.2 3.1 11.3 0l226.4-226.4c3.1-3.1 3.1-8.2 0-11.3l-39.5-39.6z"></path></svg></i></a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="visibility:hidden;position:absolute;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li></ul> <ul class="extra-group"><li><a href="https://github.com/zhamao-robot/zhamao-framework" target="_blank" rel="noopener noreferrer" class="repo-link"><i aria-label="icon: github" class="anticon anticon-github"><svg viewBox="64 64 896 896" focusable="false" data-icon="github" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M511.6 76.3C264.3 76.2 64 276.4 64 523.5 64 718.9 189.3 885 363.8 946c23.5 5.9 19.9-10.8 19.9-22.2v-77.5c-135.7 15.9-141.2-73.9-150.3-88.9C215 726 171.5 718 184.5 703c30.9-15.9 62.4 4 98.9 57.9 26.4 39.1 77.9 32.5 104 26 5.7-23.5 17.9-44.5 34.7-60.8-140.6-25.2-199.2-111-199.2-213 0-49.5 16.3-95 48.3-131.7-20.4-60.5 1.9-112.3 4.9-120 58.1-5.2 118.5 41.6 123.2 45.3 33-8.9 70.7-13.6 112.9-13.6 42.4 0 80.2 4.9 113.5 13.9 11.3-8.6 67.3-48.8 121.3-43.9 2.9 7.7 24.7 58.3 5.5 118 32.4 36.8 48.9 82.7 48.9 132.3 0 102.2-59 188.1-200 212.9a127.5 127.5 0 0 1 38.1 91v112.5c.8 9 0 17.9 15 17.9 177.1-59.7 304.6-227 304.6-424.1 0-247.2-200.4-447.3-447.5-447.3z"></path></svg></i></a></li> <!----></ul></nav></div></div> <!----></header> <aside class="sidebar"><!----> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>事件</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/event/" aria-current="page" title="入门" class="sidebar-link">入门</a></li><li><a href="/event/bot.html" aria-current="page" title="机器人事件" class="active sidebar-link">机器人事件</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/event/bot.html#botaction" title="BotAction" class="sidebar-link">BotAction</a></li><li class="sidebar-sub-header"><a href="/event/bot.html#botactionresponse" title="BotActionResponse" class="sidebar-link">BotActionResponse</a></li><li class="sidebar-sub-header"><a href="/event/bot.html#botevent" title="BotEvent" class="sidebar-link">BotEvent</a></li><li class="sidebar-sub-header"><a href="/event/bot.html#botcommand" title="BotCommand" class="sidebar-link">BotCommand</a></li><li class="sidebar-sub-header"><a href="/event/bot.html#commandargument" title="CommandArgument" class="sidebar-link">CommandArgument</a></li><li class="sidebar-sub-header"><a href="/event/bot.html#commandhelp" title="CommandHelp" class="sidebar-link">CommandHelp</a></li></ul></li><li><a href="/event/http.html" title="路由事件" class="sidebar-link">路由事件</a></li><li><a href="/event/middleware.html" title="中间件事件" class="sidebar-link">中间件事件</a></li><li><a href="/event/framework.html" title="框架事件" class="sidebar-link">框架事件</a></li><li><a href="/event/extend.html" title="扩展事件分发器" class="sidebar-link">扩展事件分发器</a></li></ul></section></li></ul> </aside> <main class="page has-page-anchor"> <div class="theme-antdocs-content content__default"><h1 id="机器人事件"><a href="#机器人事件" class="header-anchor">#</a> 机器人事件</h1> <aside>
🛰️ 此页面下的所有注解命名空间为 `ZM\Annotation\OneBot`
</aside> <blockquote><p>在使用注解绑定事件时，如果不存在 <strong>必需</strong> 参数，可一个参数都不写，效果就是此事件在任何情况下都会调用此方法，例如 <code>#[BotEvent()]</code> 会在收到任意机器人事件时调用。</p></blockquote> <h2 id="botaction"><a href="#botaction" class="header-anchor">#</a> BotAction</h2> <p>BotAction 注解将在 OneBot 12 标准的动作发送前会触发，体现在代码层面就是在使用机器人上下文 <code>ctx()-&gt;sendAction()</code> 方法时会触发。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>action</td> <td>string</td> <td>动作名称</td> <td>“”</td></tr> <tr><td>need_response</td> <td>string</td> <td>动作是否需要响应</td> <td>false</td></tr> <tr><td>level</td> <td>int</td> <td>事件优先级（越大越先执行）</td> <td>20</td></tr></tbody></table> <p>举例一，你可以通过设置一个 BotAction 注解事件，来收集和统计所有机器人发出的消息、执行的动作：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotAction</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onBotAction</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified type-declaration"><span class="token punctuation">\</span>OneBot<span class="token punctuation">\</span>V12<span class="token punctuation">\</span>Object<span class="token punctuation">\</span>Action</span> <span class="token variable">$action</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'机器人执行了动作：'</span> <span class="token operator">.</span> <span class="token variable">$action</span><span class="token operator">-&gt;</span><span class="token property">action</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><p>举例二，你可以通过设置 BotAction 注解的限定参数来限定捕获触发的动作事件：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token comment">// 限定只获取 send_message 动作的触发</span>
<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotAction</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">action</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">'send_message'</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onSendMessage</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified type-declaration"><span class="token punctuation">\</span>OneBot<span class="token punctuation">\</span>V12<span class="token punctuation">\</span>Object<span class="token punctuation">\</span>Action</span> <span class="token variable">$action</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'机器人发送了消息：'</span> <span class="token operator">.</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>ZM<span class="token punctuation">\</span>Utils<span class="token punctuation">\</span>MessageUtil</span><span class="token operator">::</span><span class="token function">getAltMessage</span><span class="token punctuation">(</span><span class="token variable">$action</span><span class="token operator">-&gt;</span><span class="token property">params</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'message'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br></div></div><p>举例三，你可以通过 <code>need_response</code> 参数来限定 BotAction 触发的时机。默认情况下，BotAction 在调用 <code>ctx()-&gt;sendAction()</code> 后立刻触发，
如果限定 <code>need_response: true</code>，该事件将会在动作收到响应后再触发，届时你可以通过依赖注入的方式，获取 ActionResponse 对象：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotAction</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">need_response</span><span class="token punctuation">:</span> <span class="token attribute-class-name class-name">true</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onActionWithResponse</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified type-declaration"><span class="token punctuation">\</span>OneBot<span class="token punctuation">\</span>V12<span class="token punctuation">\</span>Object<span class="token punctuation">\</span>Action</span> <span class="token variable">$action</span><span class="token punctuation">,</span> <span class="token class-name class-name-fully-qualified type-declaration"><span class="token punctuation">\</span>OneBot<span class="token punctuation">\</span>V12<span class="token punctuation">\</span>Object<span class="token punctuation">\</span>ActionResponse</span> <span class="token variable">$response</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'机器人发送了动作：'</span> <span class="token operator">.</span> <span class="token variable">$action</span><span class="token operator">-&gt;</span><span class="token property">action</span> <span class="token operator">.</span> <span class="token string single-quoted-string">'，并且返回状态码为 '</span> <span class="token operator">.</span> <span class="token variable">$response</span><span class="token operator">-&gt;</span><span class="token property">retcode</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><h2 id="botactionresponse"><a href="#botactionresponse" class="header-anchor">#</a> BotActionResponse</h2> <p>BoActionResponse 注解将在 OneBot 12 标准的动作发出，并收到了合法的响应内容时触发。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>status</td> <td>string</td> <td>用于限定成功与否的状态</td> <td>null</td></tr> <tr><td>retcode</td> <td>int</td> <td>响应码</td> <td>null</td></tr> <tr><td>level</td> <td>int</td> <td>事件优先级（越大越先执行）</td> <td>20</td></tr></tbody></table> <p>举例一，你需要获取所有响应不成功的动作，则只需设置 status 为 failed 即可：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotActionResponse</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">status</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">'failed'</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onFailedResponse</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified type-declaration"><span class="token punctuation">\</span>OneBot<span class="token punctuation">\</span>V12<span class="token punctuation">\</span>Object<span class="token punctuation">\</span>ActionResponse</span> <span class="token variable">$response</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">error</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'动作请求失败，错误码：'</span> <span class="token operator">.</span> <span class="token variable">$response</span><span class="token operator">-&gt;</span><span class="token property">retcode</span><span class="token operator">.</span> <span class="token string single-quoted-string">'，错误消息：'</span> <span class="token operator">.</span> <span class="token variable">$response</span><span class="token operator">-&gt;</span><span class="token property">message</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><p>如果你的机器日代码逻辑更偏向于关注单个动作请求的成功与否，
这里其实更推荐使用上方的 <code>BotAction</code> 注解，并采用 <code>need_response: true</code> 参数，这样可以同时使用 Action 和 ActionResponse 对象。</p> <h2 id="botevent"><a href="#botevent" class="header-anchor">#</a> BotEvent</h2> <p>用于处理所有的机器人事件，具体的参数含义可以参见 <a href="https://12.onebot.dev/connect/data-protocol/event/" target="_blank" rel="noopener noreferrer">https://12.onebot.dev/connect/data-protocol/event/<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>type</td> <td>string</td> <td>对应标准中的事件类型</td> <td>null</td></tr> <tr><td>detail_type</td> <td>string</td> <td>对应标准中的事件详细类型</td> <td>null</td></tr> <tr><td>sub_type</td> <td>string</td> <td>对应标准中的事件子类型</td> <td>null</td></tr> <tr><td>level</td> <td>int</td> <td>事件优先级（越大越先执行）</td> <td>20</td></tr></tbody></table> <p>除了 level 外的参数，均可做限定事件内容的参数。</p> <p>举例一，你想写一个事件注解绑定的方法，但只获取 <code>type</code> 为 <code>notice</code> 消息类的事件：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotEvent</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">'notice'</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onNotice</span><span class="token punctuation">(</span><span class="token class-name type-declaration">BotContext</span> <span class="token variable">$ctx</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">OneBotEvent</span> <span class="token variable">$event</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'收到了机器人 '</span> <span class="token operator">.</span> <span class="token variable">$event</span><span class="token operator">-&gt;</span><span class="token property">self</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'user_id'</span><span class="token punctuation">]</span> <span class="token operator">.</span> <span class="token string single-quoted-string">' 的通知事件，子类型为 '</span> <span class="token operator">.</span> <span class="token variable">$event</span><span class="token operator">-&gt;</span><span class="token property">detail_type</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><p>举例二，你想限定获取群所有群消息，通过设置 <code>type</code>、<code>detail_type</code> 两个参数组合来获取：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BotEvent</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">'message'</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">detail_type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">'group'</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">onGroupMessage</span><span class="token punctuation">(</span><span class="token class-name type-declaration">OneBotEvent</span> <span class="token variable">$event</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token comment">// getAltMessage() 为返回一个终端可读的展示型文本，非消息原文</span>
<span class="token function">logger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'来自群组 '</span> <span class="token operator">.</span> <span class="token variable">$event</span><span class="token operator">-&gt;</span><span class="token function">getGroupId</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">.</span> <span class="token string single-quoted-string">':'</span> <span class="token operator">.</span> <span class="token variable">$event</span><span class="token operator">-&gt;</span><span class="token function">getUserId</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">.</span> <span class="token string single-quoted-string">' 的消息：'</span> <span class="token operator">.</span> <span class="token variable">$event</span><span class="token operator">-&gt;</span><span class="token function">getAltMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br></div></div><h2 id="botcommand"><a href="#botcommand" class="header-anchor">#</a> BotCommand</h2> <p>对于 <code>BotEvent</code> 的封装，用于支持常用的命令式调用（如：”天气 深圳”）。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>name</td> <td>string</td> <td>命令名称，应全局唯一</td> <td>“”</td></tr> <tr><td>match</td> <td>string</td> <td>匹配第一个词的命令式消息，如 天气 北京 中的 天气</td> <td>“”</td></tr> <tr><td>pattern</td> <td>string</td> <td>根据 * 号通配符进行模式匹配用户消息，如 查询*天气</td> <td>“”</td></tr> <tr><td>regex</td> <td>string 合法的正则表达式</td> <td>匹配正则表达式匹配到的用户消息</td> <td>“”</td></tr> <tr><td>start_with</td> <td>string</td> <td>匹配消息开头相匹配的消息，如 我叫炸毛，这里写 我叫</td> <td>“”</td></tr> <tr><td>end_with</td> <td>string</td> <td>匹配消息结尾相匹配的消息，以 start_with 类推</td> <td>“”</td></tr> <tr><td>keyword</td> <td>string</td> <td>匹配消息中有相关关键词的消息</td> <td>“”</td></tr> <tr><td>alias</td> <td>string</td> <td>match 匹配到命令的别名，数组形式</td> <td>[]</td></tr> <tr><td>detail_type</td> <td>string</td> <td>限定消息事件的详细类型，见 BotEvent</td> <td>“”</td></tr> <tr><td>prefix</td> <td>string</td> <td></td> <td></td></tr> <tr><td>level</td> <td>int</td> <td>事件优先级（越大越先执行）</td> <td>20</td></tr></tbody></table> <blockquote><p>机器人命令注册的实例可参见【一堆例子链接】</p></blockquote> <h2 id="commandargument"><a href="#commandargument" class="header-anchor">#</a> CommandArgument</h2> <p>与 BotCommand 搭配使用，可以自动识别参数及生成帮助。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>name</td> <td>string</td> <td>参数名称</td> <td>“”</td></tr> <tr><td>description</td> <td>string</td> <td>参数描述</td> <td>“”</td></tr> <tr><td>required</td> <td>bool</td> <td>参数是否必需</td> <td>false</td></tr> <tr><td>prompt</td> <td>string</td> <td>当参数缺失时请求用户输入时提示的消息（需要参数设为必需）</td> <td>“请输入{$name}”</td></tr> <tr><td>default</td> <td>mixed</td> <td>当参数非必需且未填入时的默认值</td> <td>null</td></tr> <tr><td>timeout</td> <td>int 单位秒</td> <td>请求输入超时时间</td> <td>60</td></tr></tbody></table> <h2 id="commandhelp"><a href="#commandhelp" class="header-anchor">#</a> CommandHelp</h2> <p>与 BotCommand 搭配使用，可以补充生成的帮助信息。</p> <table><thead><tr><th>参数名称</th> <th>允许值</th> <th>用途</th> <th>默认</th></tr></thead> <tbody><tr><td>description</td> <td>string</td> <td>命令描述</td> <td>“”</td></tr> <tr><td>usage</td> <td>string</td> <td>命令用法</td> <td>“”</td></tr> <tr><td>example</td> <td>string</td> <td>命令示例</td> <td>“”</td></tr></tbody></table> <blockquote><p>关于自动帮助生成的更多信息，请参见 【这里链接】</p></blockquote></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/zhamao-robot/zhamao-framework/edit/main/docs/event/bot.md" target="_blank" rel="noopener noreferrer">Edit this page</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev"><a href="/event/" class="prev router-link-active"><i aria-label="icon: left" class="anticon anticon-left"><svg viewBox="64 64 896 896" focusable="false" data-icon="left" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M724 218.3V141c0-6.7-7.7-10.4-12.9-6.3L260.3 486.8a31.86 31.86 0 0 0 0 50.3l450.8 352.1c5.3 4.1 12.9.4 12.9-6.3v-77.3c0-4.9-2.3-9.6-6.1-12.6l-360-281 360-281.1c3.8-3 6.1-7.7 6.1-12.6z"></path></svg></i>
入门
</a></span> <span class="next"><a href="/event/http.html">
路由事件
<i aria-label="icon: right" class="anticon anticon-right"><svg viewBox="64 64 896 896" focusable="false" data-icon="right" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M765.7 486.8L314.9 134.7A7.97 7.97 0 0 0 302 141v77.3c0 4.9 2.3 9.6 6.1 12.6l360 281.1-360 281.1c-3.9 3-6.1 7.7-6.1 12.6V883c0 6.7 7.7 10.4 12.9 6.3l450.8-352.1a31.96 31.96 0 0 0 0-50.4z"></path></svg></i></a></span></p></div> <div class="page-anchor"><div class="ant-space ant-space-vertical" style="width:100%;"><div class="ant-space-item"><div class="page-anchor-offset"><div><div class="ant-anchor-wrapper" style="max-height:100vh;"><div class="ant-anchor"><div class="ant-anchor-ink"><span class="ant-anchor-ink-ball"></span></div><div class="ant-anchor-link"><a href="#botaction" title="BotAction" class="ant-anchor-link-title">BotAction</a></div><div class="ant-anchor-link"><a href="#botactionresponse" title="BotActionResponse" class="ant-anchor-link-title">BotActionResponse</a></div><div class="ant-anchor-link"><a href="#botevent" title="BotEvent" class="ant-anchor-link-title">BotEvent</a></div><div class="ant-anchor-link"><a href="#botcommand" title="BotCommand" class="ant-anchor-link-title">BotCommand</a></div><div class="ant-anchor-link"><a href="#commandargument" title="CommandArgument" class="ant-anchor-link-title">CommandArgument</a></div><div class="ant-anchor-link"><a href="#commandhelp" title="CommandHelp" class="ant-anchor-link-title">CommandHelp</a></div></div></div></div></div></div></div></div> </main> <!----></div><div class="global-ui"></div></div>
<script src="/assets/js/app.cf958133.js" defer></script><script src="/assets/js/2.4c04991c.js" defer></script><script src="/assets/js/1.d8755a39.js" defer></script><script src="/assets/js/46.732b1cef.js" defer></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink