ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-28 00:31:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 Fix copywriting

Browse Source
This commit is contained in:
jigsaw
2022-02-05 19:46:33 +08:00
parent b8456b12ad
commit b9fd4b1ac8
27 changed files with 321 additions and 332 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
website/docs/advanced/runtime-hook.md
View File

@ -7,17 +7,17 @@ options:
# 钩子函数
[`钩子编程`](https://zh.wikipedia.org/wiki/%E9%92%A9%E5%AD%90%E7%BC%96%E7%A8%8B)
[钩子编程](https://zh.wikipedia.org/wiki/%E9%92%A9%E5%AD%90%E7%BC%96%E7%A8%8B)
> 钩子编程（hooking），也称作“挂钩”，是计算机程序设计术语，指通过拦截软件模块间的函数调用、消息传递、事件传递来修改或扩展操作系统、应用程序或其他软件组件的行为的各种技术。处理被拦截的函数调用、事件、消息的代码，被称为钩子（hook）。
在 `nonebot2` 中有一系列预定义的钩子函数，分为两类：`全局钩子函数` 和 `事件钩子函数` ，这些钩子函数可以用装饰器的形式来使用。
在 NoneBot2 中有一系列预定义的钩子函数，分为两类：**全局钩子函数**和**事件钩子函数**，这些钩子函数可以用装饰器的形式来使用。
## 全局钩子函数
全局钩子函数是指 `nonebot2` 针对其本身运行过程的钩子函数。
全局钩子函数是指 NoneBot2 针对其本身运行过程的钩子函数。
这些钩子函数是由其后端驱动 `driver`来运行的，故需要先获得全局 `driver` 对象：
这些钩子函数是由其后端驱动 `Driver` 来运行的，故需要先获得全局 `Driver` 对象：
```python
from nonebot import get_driver
@ -30,7 +30,7 @@ driver=get_driver()
### 启动准备
这个钩子函数会在 `nonebot2` 启动时运行。
这个钩子函数会在 NoneBot2 启动时运行。
```python
@driver.on_startup
@ -40,7 +40,7 @@ async def do_something():
### 终止处理
这个钩子函数会在 `nonebot2` 终止时运行。
这个钩子函数会在 NoneBot2 终止时运行。
```python
@driver.on_shutdown
@ -48,9 +48,9 @@ async def do_something():
pass
```
### bot 连接处理
### Bot 连接处理
这个钩子函数会在 `bot` 通过 `websocket` 连接到 `nonebot2` 时运行。
这个钩子函数会在 `Bot` 通过 websocket 连接到 NoneBot2 时运行。
```python
@driver.on_bot_connect
@ -60,7 +60,7 @@ async def do_something(bot: Bot):
### bot 断开处理
这个钩子函数会在 `bot` 断开与 `nonebot2` 的 `websocket` 连接时运行。
这个钩子函数会在 `Bot` 断开与 NoneBot2 的 websocket 连接时运行。
```python
@driver.on_bot_disconnect
@ -94,15 +94,13 @@ async def handle_api_result(bot: Bot, exception: Optional[Exception], api: str,
## 事件钩子函数
这些钩子函数指的是影响 `nonebot2` 进行 `事件处理` 的函数。
这些钩子函数指的是影响 NoneBot2 进行**事件处理**的函数。
:::tip 提示
关于 `事件处理` 的流程，可以在[这里](./README.md)查阅。
关于**事件处理**的流程，可以在[这里](./README.md)查阅。
:::
:::warning 注意
:::warning
1.在事件处理钩子函数中，与 `matcher` 运行状态相关的函数将不可用，如 `matcher.finish()`
@ -123,7 +121,7 @@ async def do_something(bot: Bot, event: Event, state: T_State):
### 事件预处理
这个钩子函数会在 `Event` 上报到 `nonebot2` 时运行
这个钩子函数会在 `Event` 上报到 NoneBot2 时运行
```python
from nonebot.message import event_preprocessor
@ -135,7 +133,7 @@ async def do_something(bot: Bot, event: Event, state: T_State):
### 事件后处理
这个钩子函数会在 `nonebot2` 处理 `Event` 后运行
这个钩子函数会在 NoneBot2 处理 `Event` 后运行
```python
from nonebot.message import event_postprocessor
@ -147,7 +145,7 @@ async def do_something(bot: Bot, event: Event, state: T_State):
### 运行预处理
这个钩子函数会在 `nonebot2`运行 `matcher` 前运行。
这个钩子函数会在 NoneBot2 运行 `matcher` 前运行。
```python
from nonebot.message import run_preprocessor
@ -159,7 +157,7 @@ async def do_something(matcher: Matcher, bot: Bot, event: Event, state: T_State)
### 运行后处理
这个钩子函数会在 `nonebot2`运行 `matcher` 后运行。
这个钩子函数会在 NoneBot2 运行 `matcher` 后运行。
```python
from nonebot.message import run_postprocessor