模块概述
公告
站点迁移啦~!
为什么迁移?
作为由我们官方维护的组件库,分散在各自的文档站点中的确有好处:它们可以各自维护自己所需的东西、互不干扰。
但是缺点也很明显: 太过分散。
组件库与核心库之间的关系是比较紧密的, 我们希望你能够在一个站点内就可以查阅或搜索到所有你想要得知的信息。
本章节对整个 Simple Robot QQ频道组件库 中出现的各模块进行一个简单的介绍。
API模块
API模块即指 simbot-component-qq-guild-api
模块, 是对 QQ频道API 的封装与实现,会尽可能保留API的原本风味 ,不会做过多的封装。
API模块并非 simbot 的组件库实现,但是组件库实现的基础。
它是一个可以独立使用的轻量级QQ频道API实现库。
如果想要请求这个API,那么你需要构建它,并提供所有所需的外部变量,比如 一个用于请求的 HttpClient
、一个 token
、甚至可选的提供一个第三方的服务器地址。
有关更多使用API的方式,可前往 使用API 了解。
安装与引用
如果想要引用它:
implementation("love.forte.simbot.component:simbot-component-qq-guild-api:4.0.0-beta5")
implementation 'love.forte.simbot.component:simbot-component-qq-guild-api:4.0.0-beta5'
<dependency>
<groupId>love.forte.simbot.component</groupId>
<artifactId>simbot-component-qq-guild-api-jvm</artifactId>
<version>4.0.0-beta5</version>
</dependency>
Stdlib模块
Stdlib模块,也可称之为标准库模块,即 simbot-component-qq-guild-stdlib
模块, 是在 API模块 的基础上,提供一种轻量级的 Bot
功能实现的模块, 也就是提供了对事件订阅与处理能力的轻量级实现。
Stdlib模块并非simbot的组件库实现,但是组件库实现的基础。
它是一个可以独立使用的轻量级QQ频道SDK实现库。
如果想要引用它:
implementation("love.forte.simbot.component:simbot-component-qq-guild-stdlib:4.0.0-beta5")
implementation 'love.forte.simbot.component:simbot-component-qq-guild-stdlib:4.0.0-beta5'
<dependency>
<groupId>love.forte.simbot.component</groupId>
<artifactId>simbot-component-qq-guild-stdlib-jvm</artifactId>
<version>4.0.0-beta5</version>
</dependency>
Core模块
Core模块,也称为组件库模块、核心模块、组件核心模块,即 simbot-component-qq-guild-core
模块。 它是在 标准库模块 的基础上实现 simbot 标准API的真正意义上的simbot组件库实现。
文档中大部分的功能介绍章节也都会分出一部分来介绍如何在核心模块下的使用, 例如 Bot
(标准库模块内的类型) 与 QGBot
(组件库模块内的类型)。
如果想要引用它:
implementation("love.forte.simbot.component:simbot-component-qq-guild-core:4.0.0-beta5")
implementation 'love.forte.simbot.component:simbot-component-qq-guild-core:4.0.0-beta5'
<dependency>
<groupId>love.forte.simbot.component</groupId>
<artifactId>simbot-component-qq-guild-core-jvm</artifactId>
<version>4.0.0-beta5</version>
</dependency>
Simple Robot 模块与组件库模块之间的关系
首先, API模块 和 标准库模块 不直接实现simbot标准API,而只是部分借用simbot提供的通用功能 (例如多平台的 atomic
实现、多平台的 ConcurrentMap
实现等) 来简化代码。
而 组件库模块 是直接实现simbot标准API的 (也就是 love.forte.simbot:simbot-api
), 并实现其中的诸多类型,来使得自己成为一个组件库 ,并可以让自己在simbot的核心库 (也就是 love.forte.simbot:simbot-core
) 或其他实现应用实现 (例如 simbot 的 Spring Boot starter 实现) 中使用。
Last modified: 15 July 2024