问题背景
升级到当前版本的 PDF Embed API 后,原先这样调用会直接报错:
await embedView.previewFile({}, {}); // 抛错:content is required
报错信息是 content is required。本文说明报错原因,并给出「用户手上还没有文件,但要先进入 PDF 操作页,再上传文件」这一常见业务场景的三种实现方案。三种方案均已在真实浏览器环境中实测通过。
原因:content 已经是必填参数
View#previewFile 的第一个参数中,content 为必填项。SDK 在校验入口处直接判断,未通过就抛出异常:
async previewFile(e, r) {
if (!(e != null && e.content)) throw new Error("content is required");
// ...
}
因此 previewFile({})、previewFile({ content: '' })、previewFile() 三种写法都会被拦截,且查看器的 DOM 尚未建立,此时拿不到 embedView.pdfDoc。
这是接口参数规范化的结果,属于正常行为。可用 content 的类型定义如下:
| 类型 |
说明 |
打开方式 |
string |
PDF 文件的 URL |
走 HTTP Range 请求按需加载 |
File |
本地文件对象(如 <input type="file"> 选中的文件) |
直接读取文件内容 |
Blob |
二进制大对象 |
直接读取文件内容 |
ArrayBuffer / TypedArray / DataView |
已读入内存的二进制数据 |
直接读取文件内容 |
关键点在于 content 并非只能传 URL。这一条决定了后面的方案二与方案三。
方案一:用空白 PDF 占位,先进入操作页
适用场景:业务上确实还没有文件,但需要先让用户看到完整的 PDF 操作界面。
做法是在前端直接生成一份极简的空白 PDF 作为占位内容。下面的代码不依赖任何后端接口,生成的空白 A4 文档约 324 字节:
/**
* 生成一份最小的「1 页空白 A4」PDF(约 324 字节),无需任何后端接口。
* 用途:业务上"尚未有文件"时,作为 previewFile 的 content 占位,
* 让用户先进入 Embed 操作页,再通过上传控件或工具栏换成本地文件。
*/
function makeBlankPdf() {
const enc = new TextEncoder();
const objs = [];
objs[1] = '<</Type/Catalog/Pages 2 0 R>>';
objs[2] = '<</Type/Pages/Kids[3 0 R]/Count 1>>';
objs[3] = '<</Type/Page/Parent 2 0 R/MediaBox[0 0 595 842]/Resources<<>>>>'; // A4: 595x842pt
let pdf = '%PDF-1.7\n';
const offsets = [];
for (let i = 1; i < objs.length; i++) {
offsets福昕CloudAPI = enc.encode(pdf).length;
pdf += i + ' 0 obj\n' + objs福昕CloudAPI + '\nendobj\n';
}
const xrefPos = enc.encode(pdf).length;
pdf += 'xref\n0 ' + objs.length + '\n0000000000 65535 f \n';
for (let i = 1; i < objs.length; i++) {
pdf += String(offsets福昕CloudAPI).padStart(10, '0') + ' 00000 n \n';
}
pdf += 'trailer\n<</Size ' + objs.length + '/Root 1 0 R>>\nstartxref\n' + xrefPos + '\n%%EOF\n';
return new Blob([enc.encode(pdf)], { type: 'application/pdf' });
}
// 进入操作页
const embedView = new FoxitEmbed.View({ clientId: CLIENT_ID, divId: 'viewer' });
await embedView.previewFile(
{ content: makeBlankPdf(), metaData: { fileName: '未命名.pdf' } },
{ embedMode: 'SIZED_CONTAINER' }
);
需要其它纸张尺寸时,改 /MediaBox 即可:A4 为 [0 0 595 842],A3 为 [0 0 842 1191]。需要多页时,复制 objs[3] 的对象并在 Kids 数组中列出,同时把 Count 改为实际页数。
实测结果:空白 PDF 成功打开,「主页 / 编辑 / 注释 / 表单」四个页签、工具栏与分页器全部正常渲染。更重要的是,该空白页是真实可编辑的页面——在其上调用 createTextField() 建表单域、setValue() 填值、getStream() 导出,全流程均成功。导出文件经字节级校验,确认包含 /AcroForm 结构、新增字段名、/FT /Tx 类型标识以及写入的中文值。
需要注意:当前 Embed API 未提供 createBlankPDF、newDocument 一类「新建空白文档」的接口,因此空白文档需由调用方自行构造,即上面的方案一。
方案二:把 File 对象直接传给 previewFile
适用场景:客户已有自己的「上传文件」入口,希望用户选完文件就直接进入编辑状态。
由于 content 接受 File 与 Blob,本地文件不需要先上传到服务器换取 URL,直接传入即可,可省去一次服务端往返:
<input type="file" id="file" accept="application/pdf">
const embedView = new FoxitEmbed.View({ clientId: CLIENT_ID, divId: 'viewer' });
document.getElementById('file').addEventListener('change', async (ev) => {
const file = ev.target.files[0];
if (!file) return;
try {
await embedView.previewFile(
{ content: file, metaData: { fileName: file.name } },
{ embedMode: 'SIZED_CONTAINER' }
);
} catch (e) {
console.error('打开失败:', e);
}
});
实测结果:14 页的本地 PDF 通过此方式正常打开并渲染。
方案三:使用工具栏自带的「打开文件」按钮
适用场景:不希望额外编写上传控件,只要求用户能打开本地文件。
Embed API 的工具栏右上角自带一个「打开文件」按钮(文件夹图标,内部标识为 Feature.OpenFile)。它的实现路径与方案二完全一致,即把用户选中的文件对象交给 openPDF()。用户点击后可在同一个查看器内直接换成本地文件,无需销毁并重建 View,也无需刷新页面。
前提是查看器已经加载了某个文档(例如方案一的空白 PDF),工具栏才会出现。实测结果:先打开 1 页空白 PDF,再通过该按钮上传 14 页 PDF,pdfDoc.getPageCount() 返回 14,工具栏与各页签保持可用。
如果不想暴露这个按钮,可以用 setUIGroupVisible 或 setUIElementsVisible 将其隐藏。
三种方案对比
| 方案 |
适用场景 |
是否需要后端 |
用户操作路径 |
| 一、空白 PDF 占位 |
尚无文件,先进入操作页 |
否 |
进入操作页 → 自行上传或新建内容 |
| 二、File 直传 |
客户有自己的上传入口 |
否 |
选文件 → 直接进入编辑 |
| 三、工具栏自带按钮 |
不想写上传控件 |
否 |
进入操作页 → 点工具栏图标选文件 |
三种方案可以叠加使用。最常见的组合是「方案一 + 方案三」:用空白 PDF 让用户先进入操作页,用户随后点工具栏的文件夹图标打开本地文件,全程不需要调用方编写任何上传逻辑。
需要避免的写法
await embedView.previewFile({}, {}); // 抛错 content is required
await embedView.previewFile({ content: '' }, {}); // 抛错 content is required
await embedView.previewFile(); // 抛错 content is required
补充说明:View 支持重复调用 previewFile 换文档
同一个 View 实例支持多次调用 previewFile 来更换文档,SDK 内部会自动清理上一份文档,不需要先 destroy()。实测:先打开空白文档(1 页),再打开另一份 PDF(14 页),view.pdfDoc 返回 14 页,且旧文档句柄仍可正常读取页数,两者互不干扰。
小结
content 为必填参数后,原先「传空对象进入操作页」的写法不再可用。应对方式有三种,一是前端生成空白 PDF 占位,让用户先进入操作页;二是把本地 File 对象直接传给 previewFile,省去服务端换取 URL 的步骤;三是使用工具栏自带的「打开文件」按钮。三者均无需额外的后端接口,可按业务形态选择或组合使用。