插件开发

插件开发规范

为了方便插件开发，我们需要遵循以下文件规范

文件结构规范

│
◆  saiapp
│  ├── saiadmin-vue      # 前端文件目录
│  ├── plugin            # 后端文件目录
│  ├── config.json       # 依赖配置文件
│  ├── info.ini          # 插件信息文件
│  ├── install.sql       # 插件安装sql文件
│  ├── uninstall.sql     # 插件卸载sql文件
│  ├── update.sql        # 插件更新sql文件

sapapp

插件包名称，我们的插件是以 webman 插件的形式安装，安装的最终目录就是 webman\plugin 下，所以我们要确定好插件的名称，避免重复

saiadmin-vue

前端文件目录，我们的插件前端代码都放在这个目录下，同时这个目录也是有规范的

│
◆  saiadmin-vue
│  ├── src
│  │  ├── views            
│  │  │  ├── saiapp       # 前端应用目录

plugin

后端插件文件目录，可以通过 webman 的应用创建命令创建

│
◆  plugin
│  ├── saiapp             # 应用目录

config.json

依赖配置文件，我们的插件可能需要一些额外的依赖，我们可以在这个文件中进行配置，dependencies 代表前端依赖，require 代表后端依赖

{
    "dependencies": {
        "vue-qr": "^4.0.9"
    },
    "require": {
        "yansongda/pay": "~3.7.0"
    }
}

info.ini

插件信息文件，我们的插件需要一些基本的信息，比如插件名称、版本、作者、描述等，我们可以在这个文件中进行配置

app = saiapp
title = 插件应用
about = 功能强大的手机端应用
author = saithink
website = https://saas.saithink.top
version = 5.1.0
state = 1

install.sql

插件安装sql文件，我们的插件可能需要一些额外的数据库表，我们可以在这个文件中进行配置

uninstall.sql

插件卸载sql文件，我们的插件可能需要一些额外的数据库表，我们可以在这个文件中进行配置

update.sql

插件更新sql文件，我们的插件可能需要一些额外的数据库表，我们可以在这个文件中进行配置