插件开发

约 997 字大约 3 分钟

后端

拉取最新的 fba 项目到本地并配置好开发环境
通过插件分类、插件路由结构、插件配置、数据库兼容性了解插件系统的运作机制
根据插件目录结构进行插件开发
完成插件开发
插件分享可选
使用插件模板仓库 fba_plugin_template 创建个人仓库，并将插件代码上传到个人仓库
注意
请不要将插件代码以 PR 的方式进行提交！
申请发布插件可选

插件分类

应用级插件

在项目结构中，app 目录下的一级文件夹被视为应用，此原理同样应用于插件系统。也就是说，如果插件被开发为应用，那么它们将会像应用一样被注入到系统中，我们称这类插件为【应用级插件】

扩展级插件

与【应用级插件】相反，如果插件不被开发为应用，那么它们将被开发为 app 目录下已存在应用的扩展功能，我们称这类插件为【扩展级插件】

插件路由结构

如果插件符合插件开发的要求，则插件中的所有路由都将自动注入到 FastAPI 应用中。但值得注意的是，启动时间可能会随着插件数量的递增而增加，因为 fba 会在启动前对所有插件进行解析

应用级插件

插件路由结构应完全遵循路由结构进行开发

扩展级插件

插件路由结构必须根据现有应用中的目录结构进行 1:1 复制，可参考 fba 中的内置插件 notice

插件配置

plugin.toml 是插件的配置文件，每个插件都必须包含此文件

应用级插件

# 应用配置
[app]
# 插件路由器实例，可参考源码：backend/app/admin/api/router.py，通常默认命名为 v1
router = ['']

扩展级插件

# 应用配置
[app]
# 此插件属于哪个 app
include = ''

# 接口配置
# xxx 对应的是插件 api 目录下的接口文件名（不包含后缀）
# 例如接口文件名为 notice.py，则 xxx 应该为 notice
# 如果包含多个接口文件，则应存在多个相应的 api 配置
[api.xxx]
# xxx 路由前缀，必须以 '/' 开头
prefix = ''
# 标签，用于 FastAPI 接口文档
tags = ''

数据库兼容性

fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对第三方插件进行强制要求，如果您对此感兴趣，请查看 SQLAlchemy 2.0 官方文档: with_variant

插件目录结构

backend固定目录必须

plugin固定目录必须

xxx插件名必须

api接口必须

crudCRUD 非必须

model模型非必须

__init__.py在此文件内导入所有模型类必须

…

schema数据传输非必须

service服务非必须

utils工具包非必须

__init__.py作为 python 包保留必须

conf.py插件独立配置非必须

…更多其他配置，例如 enums.py... 非必须

plugin.toml插件配置文件必须

README.md插件使用说明必须

requirements.txt依赖包文件非必须

前端

暂无此计划...