niucloud/v2.0-compile.md
niucloud 39e23cbc57
update v2.0-compile.md.
Signed-off-by: niucloud <niucloud@outlook.com>
2026-10-19 06:19:27 +00:00

152 lines
4.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# niucloud SAAS PHP V2.0 相关编译文档
## 一、项目
SaaS框架V2版本及插件
## 二、背景
V1版本中,插件安装后采用动态组合源码方式,需要进行一次编译后才能正常访问。由于插件的差异化可能导致编译失败,影响稳定性。
V2版本引入了**分离构建**机制:
- **admin/uni-app端** 分为 **框架编译** 和 **插件编译** 两部分
- 框架中初始内置框架编译后的源码
- 插件安装时,将插件的编译文件直接放到对应目录下:
- `public/admin/asset/addons`(Admin端)
- `public/wap/asset/addons`(WAP端)
- **无需进行编译即可正常访问**,大幅提升插件安装的稳定性和便捷性
## 三、编译命令
### 3.1 Admin 目录
| 命令 | 说明 |
|------|------|
| `npm run dev` | 项目运行(开发模式) |
| `npm run build` | 全部打包 |
| `npm run build:core` | 框架打包 |
| `npm run build:addon {插件key}` | 指定插件打包 |
### 3.2 Uni-app 目录
| 命令 | 说明 |
|------|------|
| `npm run dev:h5` | H5项目运行(开发模式) |
| `npm run build:h5` | H5全部打包 |
| `npm run build:h5:core` | H5框架打包 |
| `npm run build:h5:addon {插件key}` | H5指定插件打包 |
| `npm run build:mp-weixin` | 微信小程序全部打包 |
| `npm run build:mp-weixin:core` | 微信小程序框架打包 |
| `npm run build:mp-weixin:addon {插件key}` | 微信小程序指定插件打包 |
## 四、测试流程
### 第一步:安装框架
1. 部署并安装 Niucloud SAAS PHP V2.0 框架
2. 确认框架基础功能正常运行
### 第二步:安装插件
1. 将插件放到 `niucloud/addon/` 目录下
2. 修改插件 `info.json` 文件,将 `support_version` 的值改为 `2.0.0`
3. 在管理后台执行插件安装操作
### 第三步:开发模式验证
1. 插件安装完成后,分别进入 **admin** 和 **uni-app** 目录
2. 安装依赖:
```bash
# admin 目录
npm install
# uni-app 目录
npm install
```
3. 运行项目,检测开发模式:
```bash
# admin 端
npm run dev
# uni-app H5 端
npm run dev:h5
```
4. 检查确认开发模式下插件各功能是否正常运行,有无报错或异常
### 第四步:编译插件
开发模式验证通过后,对插件进行编译,需要编译三个端口:
#### 4.1 Admin 端编译
```bash
npm run build:addon {插件key}
```
#### 4.2 Uni-app H5 端编译
```bash
npm run build:h5:addon {插件key}
```
#### 4.3 Uni-app 微信小程序端编译
```bash
npm run build:mp-weixin:addon {插件key}
```
> **编译问题处理:**
> - **代码问题**:自行调整修复
> - **框架兼容问题**:联系官方或发送邮件至 `2513189129@qq.com`
### 第五步:产品模式验证
1. 三个端口全部编译完成后,进入 **Admin端 → 开发 → 插件列表**
2. 点击 **插件打包** 按钮,完成插件打包
3. 打包完成后,**卸载插件**,然后**重新安装插件**
4. 在产品模式下验证插件各个端口功能是否正常,包括:
- Admin 管理端功能
- WAP/H5 端功能
- 微信小程序端功能
## 五、测试检查清单
### 框架基础功能
- [ ] 框架安装成功
- [ ] Admin 端正常运行
- [ ] Uni-app H5 端正常运行
- [ ] 微信小程序端正常运行
### 插件安装
- [ ] 插件 `info.json` 中 `support_version` 已修改为 `2.0.0`
- [ ] 插件安装成功,无报错
### 开发模式
- [ ] Admin 端插件功能正常
- [ ] Uni-app H5 端插件功能正常
- [ ] 微信小程序端插件功能正常
### 编译
- [ ] Admin 端插件编译成功
- [ ] Uni-app H5 端插件编译成功
- [ ] 微信小程序端插件编译成功
### 产品模式
- [ ] 插件打包成功
- [ ] 卸载重装后 Admin 端功能正常
- [ ] 卸载重装后 WAP/H5 端功能正常
- [ ] 卸载重装后微信小程序端功能正常
## 六、问题反馈
| 问题类型 | 处理方式 |
|----------|----------|
| 插件代码问题 | 自行调整修复 |
| 框架兼容问题 | 联系官方客服 |