增强模块联邦支持,添加动态导入远程模块的声明,更新示例项目以展示新组件结构和配置,调整 Vite 配置以支持更灵活的远程组件加载。

This commit is contained in:
jxxghp
2025-05-06 08:53:33 +08:00
parent 643ca35aed
commit d349d2b500
19 changed files with 1834 additions and 459 deletions

View File

@@ -1,24 +1,42 @@
# MoviePilot 插件远程组件示例
这是 MoviePilot 插件远程组件的示例项目,展示了如何正确配置和开发与主应用兼容的远程组件。
这是 MoviePilot 插件远程组件的示例项目,展示了如何正确配置和开发与主应用兼容的远程组件。本示例实现了三个标准组件Page详情页面、Config配置页面和Dashboard仪表板组件
## 开发环境准备
## 1. 开发环境准备
### 安装依赖
1. 安装依赖:
```bash
npm install
# 或
yarn
```
2. 开发模式运行
### 开发模式运行
```bash
npm run dev
# 或
yarn dev
```
## 配置说明
## 2. 项目结构
```
plugin-component/
├── src/
│ ├── components/
│ │ ├── Page.vue # 插件详情页面组件
│ │ ├── Config.vue # 插件配置页面组件
│ │ └── Dashboard.vue # 插件仪表板组件
│ ├── App.vue # 本地开发入口组件
│ └── main.js # 本地开发入口文件
├── vite.config.js # Vite和模块联邦配置
├── index.html # 本地开发HTML入口
└── package.json # 依赖配置
```
## 3. 配置说明
### vite.config.js
@@ -31,82 +49,113 @@ export default defineConfig({
plugins: [
vue(),
federation({
name: 'remoteApp',
name: 'my_plugin', // 插件名称建议与插件ID保持一致
filename: 'remoteEntry.js',
exposes: {
'./PluginComponent': './src/App.vue', // 暴露组件
'./Page': './src/components/Page.vue',
'./Config': './src/components/Config.vue',
'./Dashboard': './src/components/Dashboard.vue',
},
shared: {
vue: {
singleton: true,
requiredVersion: false
}
vue: { requiredVersion: false },
vuetify: { requiredVersion: false }
}
})
],
build: {
target: 'esnext', // 支持顶层await
minify: false,
target: 'esnext', // 必须设置为esnext以支持顶层await
minify: false, // 开发阶段建议关闭混淆
cssCodeSplit: false,
rollupOptions: {
output: {
minifyInternalExports: false
format: 'esm', // 必须使用ESM格式
entryFileNames: '[name].js',
chunkFileNames: '[name].js',
}
}
},
server: {
port: 5001, // 使用不同于主应用的端口
cors: true, // 启用CORS
origin: 'http://localhost:5001'
}
})
```
### 组件开发
## 4. 组件规范
主组件 (src/App.vue) 需要遵循以下规则:
- 使用 Vue 3 组合式 API
- 注册 `action` 事件用于与主应用通信
- 避免直接使用 Vue Router 等全局依赖
### Page.vue详情页面
示例组件结构
详情页面用于展示插件的数据和状态
- 接收 `action` 事件用于通知主应用刷新数据
- 可以包含交互功能和数据展示
```vue
<template>
<div class="plugin-component">
<h2>{{ title }}</h2>
<div v-if="loading">加载中...</div>
<div v-else>
<!-- 组件内容 -->
<pre>{{ data }}</pre>
<button @click="refreshData">刷新</button>
</div>
</div>
</template>
<script setup>
import { ref, onMounted } from 'vue'
// 组件状态
const title = ref('插件示例')
const loading = ref(true)
const data = ref(null)
// 向主应用发送事件
// 自定义事件,用于通知主应用刷新数据
const emit = defineEmits(['action'])
// 刷新数据
async function refreshData() {
loading.value = true
// API 调用...
loading.value = false
// 通知主应用
// 通知主应用刷新数据
function notifyRefresh() {
emit('action')
}
</script>
```
// 初始化
onMounted(() => {
refreshData()
### Config.vue配置页面
配置页面用于接收和保存插件配置:
- 接收 `initialConfig` 属性获取初始配置
- 发出 `save` 事件保存配置数据
```vue
<script setup>
// 接收初始配置
const props = defineProps({
initialConfig: {
type: Object,
default: () => ({})
}
})
// 自定义事件,用于保存配置
const emit = defineEmits(['save'])
// 保存配置
function saveConfig() {
emit('save', configData)
}
</script>
```
### Dashboard.vue仪表板组件
仪表板组件用于在主页上显示插件数据:
- 接收 `config` 属性获取仪表板配置
- 接收 `allowRefresh` 属性控制是否允许自动刷新
```vue
<script setup>
// 接收配置和刷新控制
const props = defineProps({
config: {
type: Object,
default: () => ({})
},
allowRefresh: {
type: Boolean,
default: true
}
})
</script>
```
## 构建生产版本
## 5. 构建和部署
### 构建生产版本
```bash
npm run build
@@ -114,11 +163,25 @@ npm run build
yarn build
```
构建后 `dist/remoteEntry.js` 是远程组件的入口文件,需要配置到后端让 MoviePilot 能够访问。
构建后 `dist` 目录生成以下关键文件:
## 插件后端配置
- `remoteEntry.js` - 模块联邦入口文件
- `Page.js` - 详情页面组件
- `Config.js` - 配置页面组件
- `Dashboard.js` - 仪表板组件
插件后端代码中,需要实现以下方法来提供组件信息:
### 部署到插件后端
将构建后的文件部署到插件后端确保可通过以下URL访问
- `/api/plugin/component/{插件ID}/remoteEntry.js`
- `/api/plugin/component/{插件ID}/Page.js`
- `/api/plugin/component/{插件ID}/Config.js`
- `/api/plugin/component/{插件ID}/Dashboard.js`
## 6. 插件后端集成
在插件的后端代码中,实现以下方法来集成远程组件:
```python
def get_render_mode() -> str:
@@ -128,41 +191,34 @@ def get_render_mode() -> str:
"""
return "vue"
def get_form_file() -> Tuple[str, Dict[str, Any]]:
def get_remote_urls() -> Dict[str, Any]:
"""
获取插件配置页面JS代码源文件与get_from二选一使用
:return: 1、编译后的JS代码插件目录下相对路径2、默认数据结构
获取远程组件地址
:return: 远程组件信息包含id和url
"""
return "/dist/page.js", {}
def get_page_file() -> Optional[str]:
"""
获取插件数据页面JS代码源文件与get_page二选一使用
:return: 编译后的JS代码插件目录下相对路径
"""
return "/dist/config.js", {}
return {
"id": "my_plugin", # 插件ID
"url": "/path/to/component" # 可选,自定义组件路径
}
```
## 排查常见问题
## 7. 常见问题排查
### 顶层 await 报错
### 模块加载问题
确保在 `vite.config.js` 中设置 `build.target``'esnext'`
如果遇到模块加载问题,请检查:
### 共享依赖加载失败
1. 确保 `build.target` 设置为 `esnext`
2. 验证共享依赖配置是否正确
3. 检查网络请求是否成功
4. 查看浏览器控制台错误信息
确保正确配置共享依赖:
```js
shared: {
vue: {
singleton: true,
requiredVersion: false // 关闭版本检查
}
}
```
### 代码调试
### 组件无法加载
在开发阶段可以:
1. 检查网络请求是否成功
2. 确认 JS 文件可以被正确访问
3. 查看浏览器控制台是否有详细错误信息
1. 使用浏览器开发者工具进行调试
2. 启用 Vite 的详细日志:`localStorage.setItem('debug', 'vite:*')`
3. 使用 `console.log` 输出调试信息
更多详细说明请参考 [模块联邦开发指南](../../docs/module-federation-guide.md) 和 [模块联邦问题排查指南](../../docs/federation-troubleshooting.md)。