将 node-fetch/form-data 迁移到 Node.js 原生 API

Node v16.15.0 和 v17.5.0 的发布引入了 Fetch API 和 FormData。在此之前，node-fetch 和 form-data 包用于在 Node.js 中使用类似浏览器的 API。要将node-fetch/form-data包迁移到Node.js本机API，可以通过删除第3方包的导入语句来进行一些更改，但是在使用Node.js功能（例如文件）时需要记住一些重要的注意事项系统。本文概述了如何从 node-fetch/form-data 包迁移到 Node.js 原生 API。

迁移概述

 import fs from 'node:fs';
-import FormData from 'form-data';
-import fetch from 'node-fetch';

-const file = fs.createReadStream('secret.txt');
+const file = await fs.openAsBlob('secret.txt', { type: 'text/plain' });
 const form = new FormData();
-form.append('file', file);
+form.append('file', file, 'secret.txt');

 const response = await fetch('https://example.com/upload', {
   method: 'POST',
   body: form,
 });

细节

类型不兼容

form-data 包和 Node.js FormData 不兼容，无法直接用 Fetch API 传递。如果将表单数据传递给原生 Fetch API，则请求正文将为字符串 [object FormData]。

import FormData from 'form-data';

const form = new FormData();
await fetch('https://example.com/upload', {
  method: 'POST',
  body: form,
});

// [object FormData]

form-data 包接受 Node.js 中的 fs.ReadStream。本机 API 接受与浏览器兼容的 Blob。要从文件创建 Blob，我们可以使用 Node.js v19.8.0 中添加的 fs.openAsBlob()。如果将 fs.ReadStream 传递给原生 API 的 FormData，则该值将为 [object Object]。

import fs from 'node:fs';

const file = fs.createReadStream('secret.txt');
const form = new FormData();
form.append('file', file);

// Content-Disposition: form-data; name="file"
// 
// [object Object]

内部行为不相容

form-data 包从 fs.ReadStream 获取文件名并将其用作文件名字段（内部实现）。它还根据文件名确定文件类型并设置 Content-Type 标头（内部实现）。

Blob没有文件名，需要手动指定。如果未指定 Content-Type，本机 API 的 FormData 默认为 application/octet-stream。我们可以从 fs.openAsBlob() 的参数中显式指定 Content-Type。

const file = await fs.openAsBlob('secret.txt');
const form = new FormData();
form.append('file', file);

// Content-Disposition: form-data; name="file"; filename="blob"
// Content-Type: application/octet-stream

const file = await fs.openAsBlob('secret.txt', { type: 'text/plain' });
const form = new FormData();
form.append('file', file, 'secret.txt');

// Content-Disposition: form-data; name="file"; filename="secret.txt"
// Content-Type: text/plain

结论

Fetch API 和 FormData 从 Node.js v21.0.0 开始已变为 Stability: 2（稳定）。 fs.openAsBlob() 在最新版本的 Node.js（截至 2024 年 7 月 27 日的 v22.5.1）中仍然是 Stability: 1（实验性）。在旧运行时运行或使用具有潜在功能更改的实验性 API 时，我们需要小心。

以上是将 node-fetch/form-data 迁移到 Node.js 原生 API的详细内容。更多信息请关注PHP中文网其他相关文章！