2021-12-01 08:28:55 +00:00
|
|
|
|
---
|
2021-12-24 11:02:11 +00:00
|
|
|
|
sidebar_position: 0
|
2021-12-01 19:17:10 +00:00
|
|
|
|
id: index
|
2021-12-27 14:08:59 +00:00
|
|
|
|
slug: /
|
2021-12-01 08:28:55 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
2020-09-12 05:45:03 +00:00
|
|
|
|
# 概览
|
|
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
NoneBot2 是一个现代、跨平台、可扩展的 Python 聊天机器人框架，它基于 Python 的类型注解和异步特性，能够为你的需求实现提供便捷灵活的支持。
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-08-14 11:41:00 +00:00
|
|
|
|
需要注意的是，NoneBot2 仅支持 **Python 3.8 以上版本**
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
## 特色
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
### 异步优先
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
NoneBot2 基于 Python [asyncio](https://docs.python.org/3/library/asyncio.html) 编写，并在异步机制的基础上进行了一定程度的同步函数兼容。
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
### 完整的类型注解
|
|
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
NoneBot2 参考 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 等 PEP 完整实现了类型注解，通过 `pyright`/`pylance` 检查。配合编辑器的类型推导功能，能将绝大多数的 Bug 杜绝在编辑器中（[编辑器支持](./start/editor-support)）。
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
|
|
|
|
|
### 开箱即用
|
|
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
NoneBot2 提供了使用便捷、具有交互式功能的命令行工具--`nb-cli`，使得初次接触 NoneBot2 时更容易上手。详细使用方法请参考各文档章节以及[使用脚手架](./start/nb-cli)。
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
|
|
|
|
|
### 插件系统
|
|
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
插件系统是 NoneBot2 的核心，通过它可以实现机器人的模块化以及功能扩展，便于维护和管理。
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
|
|
|
|
|
### 依赖注入系统
|
|
|
|
|
|
|
|
|
|
|
|
NoneBot2 采用了一套自行定义的依赖注入系统，可以让事件的处理过程更加的简洁、清晰，增加代码的可读性，减少代码冗余。
|
|
|
|
|
|
|
|
|
|
|
|
#### 什么是依赖注入
|
|
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
[**“依赖注入”**](https://zh.m.wikipedia.org/wiki/%E6%8E%A7%E5%88%B6%E5%8F%8D%E8%BD%AC)意思是，在编程中，有一种方法可以让你的代码声明它工作和使用所需要的东西，即**“依赖”**。
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
系统（在这里是指 NoneBot2）将负责做任何需要的事情，为你的代码提供这些必要依赖（即**“注入”**依赖性）
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
这在你有以下情形的需求时非常有用：
|
2022-01-04 05:18:22 +00:00
|
|
|
|
|
2022-02-05 11:46:33 +00:00
|
|
|
|
- 这部分代码拥有共享的逻辑（同样的代码逻辑多次重复）
|
2022-01-04 05:18:22 +00:00
|
|
|
|
- 共享数据库以及网络请求连接会话
|
2022-02-05 11:46:33 +00:00
|
|
|
|
- 比如 `httpx.AsyncClient`、`aiohttp.ClientSession` 和 `sqlalchemy.Session`
|
2022-01-04 05:18:22 +00:00
|
|
|
|
- 用户权限检查以及认证
|
|
|
|
|
|
- 还有更多...
|
2020-09-12 05:45:03 +00:00
|
|
|
|
|
2022-01-04 05:18:22 +00:00
|
|
|
|
它在完成上述工作的同时，还能尽量减少代码的耦合和重复
|
