fix: 修正插件构建配置,与宿主 __FUNJIA_HOST__ 契约对齐

原配置产出的是「在别的系统里跑不起来」的产物,三处一起修:

1. **external 与 globals 对不上**
   原来 external 了 funjia-axios 却没有 output.globals 映射,
   rollup 自己猜的全局名与宿主挂的 window.axios 不一致,插件静默失效。
   现在 external / globals 收口到一张 HOST_GLOBALS 表,只列宿主真正提供的
   三个全局:vue / funjiaui / axios。顺带修掉 external 里 'axois' 的拼写错误。
   element-plus 改为**不 external**(共享它需要宿主 import * as ElementPlus,
   会关掉 tree-shaking 把整个库塞进宿主包),由插件自带。

2. **output.exports 必须是 default**
   视图模型是 export default class,宿主直接把它当类用。
   用 named(或 rollup 见到 __esModule 时自动选 named)会产出命名空间对象
   window.Notice = { default: [class] },表现为「脚本加载成功、控制台无报错、
   但表格一列都不出来」的静默失败。

3. **入口/全局名不再手工改配置文件**
   新增 scripts/build-vm.mjs,用法 `npm run build:vm Notice`:
   由 VIEWMODEL 环境变量驱动 entry 与 lib.name,并对名字做合法性校验、
   对入口文件做存在性校验、失败时列出可用的视图模型。
   脚本内不走 npx(Windows 上 .bin 符号链接缺失时会报「vite 不是内部或外部命令」),
   直接用 process.execPath 跑 vite 的 JS 入口;日志保持纯 ASCII,
   避免控制台 GBK 代码页把中文输出变成乱码。

顺带:
- package.json 的 git 依赖 http:// 改 https://(80 端口不可达),
  funjiaui 升到 v1.4.0(宿主用的版本,装饰器语义要对齐)
- doc.md 补「怎么用」(链路 / 契约 / 注意事项),下半部分代码解析保留

已验证:npm run build:vm Notice 产出 12.2 KiB 的 IIFE,
在 vm 里执行后 window.Notice 是可实例化的类(含 getList / onAdd / getDetail /
onEdit / delByIds 与 operateWidth / isEdit),放进宿主静态目录后
「通知」「标签」两页正常渲染出表格(分别 6 行 / 10 行真实数据,控制台无报错)。
This commit is contained in:
2026-09-25 11:06:07 +08:00
parent af5072e5ef
commit 4eafb9ebfe
5 changed files with 3674 additions and 24 deletions
+83
View File
@@ -1,3 +1,86 @@
> 本文档分两部分:
> 上半部分是**怎么用这个仓库**(构建、上传、与宿主的契约),
> 下半部分是**视图模型代码本身的逐段解析**。
---
# 一、怎么用:从写视图模型到页面上线
## 这个仓库是干什么的
每次构建产出**一个视图模型**的自包含脚本。上传到宿主后端后,
宿主的 `UmRemoteClass` 会在运行时加载它 —— 于是**新增一张表格页不需要改前端代码、
不需要重新打包发版**。
## 完整链路
| 步骤 | 做什么 |
| --- | --- |
| ① | 在 `src/<名字>.ts` 写视图模型(用 funjiaui 的装饰器) |
| ② | `npm run build:vm <名字>`,产出 `dist/<名字>.iife.js` |
| ③ | 把该文件上传到宿主的静态目录(`server/static/`) |
| ④ | 在宿主的 `dataDict` 表 `MENU_JSON` 里加一条路由 `/app/dynamicTable/<小写名字>/<文件名>/<标题>` |
| ⑤ | 宿主加载脚本 → 取 `window[<名字>]` → 渲染表格 |
```bash
npm run build:vm Notice # 产出 dist/Notice.iife.js
npm run build:vm Tag
npm run build:vm # 不带参数时列出可用的视图模型
npm run dev # 本地起宿主演示站(需要后端在 4873)
```
## ⚠️ 与宿主的契约(改构建配置前必读)
宿主项目里 `src/common/host.ts` 的 `PLUGIN_GLOBALS` 是**唯一约定来源**。
本仓库 `vite.config.ts` 的 `HOST_GLOBALS` 必须与它一致:
| 插件 external 的模块 | 宿主提供的全局 |
| --- | --- |
| `vue` | `window.vue` |
| `funjiaui` | `window.funjiaui` |
| `funjia-axios` | `window.axios` |
三条容易踩的规则:
1. **`lib.name` 会成为 IIFE 的全局名。**
宿主取的是 `window[首字母大写的 name]`,所以 `lib.name = 'Notice'`
必须对应菜单路由里的 `notice`。名字只能是合法 JS 标识符(构建时会校验)。
2. **`output.exports` 必须是 `default`,不能是 `named`。**
视图模型是 `export default class`,宿主**直接把它当类**用。
若被包成命名空间(`window.Notice = { default: ... }`),
表现是「脚本加载成功、控制台无报错、但表格一列都不出来」——
最难查的静默失败。代价:视图模型只能有 default 导出。
3. **`vue` 绝不能重复打包,`element-plus` 必须自己打包。**
两份 Vue 会破坏响应式与实例识别(所以 `vue` 是 external);
而 `element-plus` 共享需要宿主 `import * as ElementPlus`、会关掉 tree-shaking、
把整个组件库塞进宿主包,不划算 —— 所以它不设 external,由插件自带。
## 视图模型能依赖什么
- `window.funjiaui` — 装饰器与组件
- `window.vue` — Vue 运行时
- `window.axios` — 宿主已配置好的请求实例(含鉴权与响应解包)
- `window.__FUNJIA_HOST__` — 显式契约对象,含 `contractVersion` / `app` / `api` / `resource`
推荐用 `resource` 而不是自己拼接口路径,这样换系统只改宿主一处:
```js
const { getList, get, add, update, remove } = window.__FUNJIA_HOST__.resource("Notice");
```
## 注意事项
- **插件脚本要纳入版本控制。** 脚本不在库里的话,换台机器部署就会少文件,
而页面只会「空白」或不给你任何提示。
- 运行时脚本**没有类型检查、没有 sourcemap**,字段名写错通常不报错、只是不生效。
视图模型里挂上配置体检(funjiaui 的 `diagnose`)能兜住这类静默失败。
- `npm install` 在本机可能较慢,且 esbuild 的 postinstall 在 Windows 上偶发 `EBUSY`;
可用 `npm install --ignore-scripts` 绕过(不影响构建)。
---
# 二、视图模型代码解析
这段代码是一个使用装饰器实现的Vue表格组件配置类,主要用于管理系统中的通知(Notice)数据的增删改查操作。以下是对代码的详细分析: 这段代码是一个使用装饰器实现的Vue表格组件配置类,主要用于管理系统中的通知(Notice)数据的增删改查操作。以下是对代码的详细分析:
### 1. 核心功能 ### 1. 核心功能
+3423
View File
File diff suppressed because it is too large Load Diff
+4 -3
View File
@@ -5,6 +5,7 @@
"scripts": { "scripts": {
"dev": "vite --port=4444", "dev": "vite --port=4444",
"build": "vite build", "build": "vite build",
"build:vm": "node scripts/build-vm.mjs",
"preview": "vite preview --port=4444" "preview": "vite preview --port=4444"
}, },
"dependencies": { "dependencies": {
@@ -17,9 +18,9 @@
"codemirror": "^6.0.1", "codemirror": "^6.0.1",
"dayjs": "^1.10.7", "dayjs": "^1.10.7",
"element-plus": "2.1.10", "element-plus": "2.1.10",
"funjialib": "git+http://git.funjia.top/funjia/FunJiaLib_Package.git", "funjialib": "git+https://git.funjia.top/funjia/FunJiaLib_Package.git",
"funjiaui": "git+http://git.funjia.top/funjia/FunjiaUI_Vue.git#v1.1.2", "funjiaui": "git+https://git.funjia.top/funjia/FunJiaUI_Vue_Package.git#v1.4.0",
"funjia-axios": "git+http://git.funjia.top/funjia/funjia-axios.git", "funjia-axios": "git+https://git.funjia.top/funjia/funjia-axios.git",
"html-print-element": "^0.0.5", "html-print-element": "^0.0.5",
"html2pdf.js": "^0.10.2", "html2pdf.js": "^0.10.2",
"js-cookie": "^3.0.1", "js-cookie": "^3.0.1",
+67
View File
@@ -0,0 +1,67 @@
#!/usr/bin/env node
/**
* 构建单个视图模型插件。
*
* 用法:
* npm run build:vm Notice # 产出 dist/Notice.iife.js
* npm run build:vm Tag
* npm run build:vm # 不带参数时列出可用的视图模型
*
* ## 两个实现上的注意点
*
* 1. **不走 `npx vite`。** Windows 上 `npx` / `node_modules/.bin` 的解析
* 依赖符号链接,安装不完整或跨盘时会报「'vite' 不是内部或外部命令」。
* 这里直接用 `process.execPath` 跑 vite 自己的 JS 入口,稳定且不依赖 .bin。
* 2. **控制台输出保持纯 ASCII。** 本仓库文档是中文,但这个脚本的输出会经过
* Windows 的 cmd/npm 管道,控制台代码页是 GBK,中文会变成乱码
* (实测 `构建视图模型` → `鏋勫缓瑙嗗浘妯″瀷`)。
* 日志用英文,中文说明留在注释和 README 里。
*/
import { spawnSync } from "node:child_process";
import { existsSync, readdirSync } from "node:fs";
import { fileURLToPath } from "node:url";
import { dirname, resolve } from "node:path";
const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const srcDir = resolve(root, "src");
const viteBin = resolve(root, "node_modules/vite/bin/vite.js");
/** 列出可作为视图模型入口的候选文件(src 顶层的 .ts,排除纯工具模块) */
const listCandidates = () =>
readdirSync(srcDir)
.filter((f) => f.endsWith(".ts"))
.filter((f) => !["api.ts", "env.d.ts"].includes(f))
.map((f) => f.replace(/\.ts$/, ""))
.sort();
const name = process.argv[2] || process.env.VIEWMODEL;
if (!name) {
console.error("Missing view model name. Usage: npm run build:vm <Name>\n");
console.error("Candidates in src/:");
for (const c of listCandidates()) console.error(` - ${c}`);
console.error("\nExample: npm run build:vm Notice");
process.exit(1);
}
if (!existsSync(viteBin)) {
console.error(`vite not found at: ${viteBin}`);
console.error("Run `npm install` first.");
process.exit(1);
}
console.log(`[build:vm] building "${name}" -> dist/${name}.iife.js`);
const result = spawnSync(process.execPath, [viteBin, "build"], {
cwd: root,
stdio: "inherit",
env: { ...process.env, VIEWMODEL: name },
});
if (result.status !== 0) {
console.error(`\n[build:vm] FAILED (exit ${result.status})`);
process.exit(result.status ?? 1);
}
console.log(`\n[build:vm] done. Upload this file: dist/${name}.iife.js`);
console.log(`[build:vm] Also upload dist/${name}.css if it was produced.`);
+97 -21
View File
@@ -4,9 +4,72 @@ import AutoImport from 'unplugin-auto-import/vite'
import Components from 'unplugin-vue-components/vite' import Components from 'unplugin-vue-components/vite'
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers' import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
import ElementPlus from 'unplugin-element-plus/vite' import ElementPlus from 'unplugin-element-plus/vite'
import { existsSync } from 'fs'
import { resolve } from "path"; import { resolve } from "path";
// https://vitejs.dev/config/ /**
* 视图模型插件打包配置。
*
* ## 这个仓库的产出是什么
*
* 每次构建产出**一个视图模型**的 IIFE 脚本,上传到宿主后端的静态目录,
* 由宿主的 `UmRemoteClass` 在运行时加载 —— 于是新增一张表格页不需要改前端代码。
*
* ## 三处与「宿主契约」强绑定的地方,改之前先读宿主项目的 src/common/host.ts
*
* 1. **`lib.name` 会成为 IIFE 的全局名。**
* 宿主取的是 `window[首字母大写的 name]`,所以
* `lib.name = 'Notice'` 必须对应菜单路由里 `/app/dynamicTable/notice/...` 的 `notice`。
* 2. **`external` + `output.globals` 必须与宿主挂的全局一致。**
* 宿主挂的是 `window.vue` / `window.funjiaui` / `window.axios`
* (前两个由 `installHostRuntime()` 安装)。
* 历史问题:这里 external 了 `funjia-axios` 却没有 globals 映射,
* rollup 自己猜的全局名和宿主挂的 `axios` 对不上,插件静默失效。
* 3. **`element-plus` 不 external**,让插件把它打进产物。
* 共享它需要宿主 `import * as ElementPlus`,会关掉 tree-shaking、
* 把整个组件库塞进宿主包,代价不划算。重复一份 element-plus 是无害的;
* 但 `vue` 绝不能重复 —— 两份 Vue 会破坏响应式与实例识别。
*
* ## 用法
*
* ```bash
* # 构建 Notice.ts(产出 dist/Notice.iife.js,上传这个文件)
* npm run build:vm Notice
*
* # 或者用环境变量
* VIEWMODEL=Tag npm run build:vm
* ```
*/
const NAME = process.env.VIEWMODEL || process.env.VIEWMODEL_ENTRY || 'Magnet'
if (!/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(NAME)) {
throw new Error(
`视图模型名不合法: "${NAME}"。\n` +
`它会成为 IIFE 的全局名(lib.name),必须是合法的 JS 标识符:\n` +
`以字母 / _ / $ 开头,其后只含字母、数字、_、$。`
)
}
const ENTRY = `./src/${NAME}.ts`
if (!existsSync(resolve(__dirname, ENTRY))) {
throw new Error(
`找不到入口文件: ${ENTRY}\n` +
`视图模型请放在 src/<名字>.ts,且名字与要构建的视图模型一致。\n` +
`当前 src/ 下已有的视图模型:见 src/ 目录下的 *.ts`
)
}
/**
* external → 全局名映射。**这份表要与宿主 src/common/host.ts 的 PLUGIN_GLOBALS 保持一致。**
*/
const HOST_GLOBALS: Record<string, string> = {
vue: 'vue', // 宿主 window.vue
funjiaui: 'funjiaui', // 宿主 window.funjiaui
'funjia-axios': 'axios', // 宿主 window.axios(带鉴权与解包拦截器)
}
export default defineConfig({ export default defineConfig({
plugins: [vue(), plugins: [vue(),
AutoImport({ AutoImport({
@@ -50,34 +113,47 @@ export default defineConfig({
}, },
}, },
build: { build: {
cssCodeSplit: true, // 如果设置为false,整个项目中的所有 CSS 将被提取到一个 CSS 文件中 cssCodeSplit: true,
sourcemap: false, // 构建后是否生成 source map 文件。如果为 true,将会创建一个独立的 source map 文件 sourcemap: false,
target: 'modules', // 设置最终构建的浏览器兼容目标。默认值是一个 Vite 特有的值——'modules' 还可设置为 'es2015' 'es2016'等 target: 'modules',
chunkSizeWarningLimit: 550, // 单位kb 打包后文件大小警告的限制 (文件大于此此值会出现警告) chunkSizeWarningLimit: 550,
assetsInlineLimit: 4096, // 单位字节(1024等于1kb) 小于此阈值的导入或引用资源将内联为 base64 编码,以避免额外的 http 请求。设置为 0 可以完全禁用此项。 assetsInlineLimit: 4096,
// minify: false, minify: 'terser',
minify:'terser', // 'terser', // 'terser' 相对较慢,但大多数情况下构建后的文件体积更小。'esbuild' 最小化混淆更快但构建后的文件相对更大。 // 产出目录固定 dist,文件名带上视图模型名,上传时不容易拿错
outDir: 'dist',
emptyOutDir: false,
lib: { lib: {
// 入口文件 // 入口与全局名都由 VIEWMODEL 决定,不再手工改这个文件
entry: './src/Magnet.ts', entry: ENTRY,
// 名称 name: NAME,
name: 'Magnet', formats: ['es', 'iife'],
// 格式,可选 'es', 'umd', 'iife' fileName: (format) => (format === 'iife' ? `${NAME}.iife.js` : `${NAME}.es.js`),
formats: ['es','iife']
}, },
rollupOptions: { rollupOptions: {
external: ['element-plus', 'vue', 'path', 'url', 'node','funjiaui','reflect-metadata','lodash-es','axois','funjia-axios'], external: Object.keys(HOST_GLOBALS),
output: { output: {
globals: { globals: HOST_GLOBALS,
"elementPlus": "element-plus", /**
"vue": "vue", * ⚠️ 必须是 `default`,不能是 `named`,也不能省。
}, *
* 视图模型是 `export default class Xxx`,宿主取的是 `window[Xxx]`
* 并**直接当作配置类**交给 UmByClassEnhance。
*
* 若用 `named`(或 rollup 在存在 __esModule 标记时自动选 named),
* 产物会变成 `window.Notice = { default: [class Notice] }` —— 一个命名空间对象。
* 宿主拿到它之后:脚本加载「成功」、控制台没有报错、但表格**渲染不出任何列**,
* 是最难查的一类静默失败。
*
* 代价:视图模型只能有 default 导出。若某个视图模型需要具名导出,
* 构建会明确报错,别为了绕过它改回 named。
*/
exports: 'default',
} }
}, },
terserOptions: { terserOptions: {
compress: { compress: {
drop_console: true, // 生产环境去除console drop_console: true,
drop_debugger: true // 生产环境去除debugger drop_debugger: true
} }
} }
} }