JS fetch API如何上传文件?

329

我仍在努力理解它。

我可以使用文件输入让用户选择文件(甚至是多个文件):

<form>
  <div>
    <label>Select file to upload</label>
    <input type="file">
  </div>
  <button type="submit">Convert</button>
</form>

我可以使用<填入您的事件处理程序>捕获submit事件。但一旦我这样做了,我该如何使用fetch发送文件呢?

fetch('/files', {
  method: 'post',
  // what goes here? What is the "body" for this? content-type header?
}).then(/* whatever */);

3
在尝试了一些答案失败后,官方文档对我很有帮助:https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Uploading_a_file ,有些事情可以确认:1. 需要将文件包装在FromData中;2. 不需要在请求头中声明“Content-Type: multipart/form-data”。 - Spark.Bao
11个回答

375

我是这样做的:

var input = document.querySelector('input[type="file"]')

var data = new FormData()
data.append('file', input.files[0])
data.append('user', 'hubot')

fetch('/avatars', {
  method: 'POST',
  body: data
})

50
如果您要上传的只是文件(这也是原始问题想要的),则不需要将文件内容包装在 FormData 对象中。fetch 将接受上面的 input.files[0] 作为其 body 参数。 - Klaus
37
如果你有一个处理文件上传的PHP后端,你需要把文件放在一个FormData中,这样$_FILES数组才能正确填充。 - ddelrio1986
4
我注意到在某些情况下,Google Chrome 在请求数据负载中不会显示文件,除非使用了 FormData 部分。这似乎是 Google Chrome 网络面板的一个bug。 - ddelrio1986
8
这应该是正确的答案。另一种方法也可以,但更加复杂。 - jnmandal
1
如果文件不是作为表单数据发送,而是仅作为文件对象发送,您将如何从Express后端读取此文件?express-fileupload或multer是否解析这样的有效负载? - sakib11
显示剩余6条评论

218

以下是一个带有注释的基本示例。在这里,upload 函数是您要查找的:

// Select your input type file and store it in a variable
const input = document.getElementById('fileinput');

// This will upload the file after having read it
const upload = (file) => {
  fetch('http://www.example.net', { // Your POST endpoint
    method: 'POST',
    headers: {
      // Content-Type may need to be completely **omitted**
      // or you may need something
      "Content-Type": "You will perhaps need to define a content-type here"
    },
    body: file // This is your file object
  }).then(
    response => response.json() // if the response is a JSON object
  ).then(
    success => console.log(success) // Handle the success response object
  ).catch(
    error => console.log(error) // Handle the error response object
  );
};

// Event handler executed when a file is selected
const onSelectFile = () => upload(input.files[0]);

// Add a listener on your input
// It will be triggered when a file will be selected
input.addEventListener('change', onSelectFile, false);

13
这个例子为什么包括 Content-Type 标头,但另一个答案说在使用 Fetch API 发送文件时应省略它们?哪一个是正确的? - jjrabbit
68
不要设置Content-Type。我花了很多时间尝试使其工作,然后发现这篇文章说不要设置它。而且它确实起作用了!https://muffinman.io/uploading-files-using-fetch-multipart-form-data/ - Kostiantyn
1
如果文件不是作为表单数据发送,而是仅作为文件对象发送,您将如何从Express后端读取此文件?express-fileupload或multer是否解析这样的有效负载? - sakib11
1
以防万一有人需要从一个地方下载文件并上传到另一个地方:const fileFetch = await fetch(fileDownloadUrl); const fileBlob = await fileFetch.blob(); upload(fileBlob) - TitanFighter
3
其他人在服务器端只得到了一个空对象吗? - avisk
显示剩余2条评论

176

使用 Fetch API 发送文件时需要注意:

在 Fetch 请求中,需要省略 content-type 标头。这样浏览器会自动添加包含表单边界(Form Boundary)的 Content-Type 标头。

Content-Type: multipart/form-data; boundary=—-WebKitFormBoundaryfgtsKTYLsT7PNUVD

表单分界符是用于表单数据的分隔符


45
非常重要!不要在使用fetch获取multipart时使用自己的content-type。我之前完全不知道为什么我的代码无法工作。 - Ernestas Stankevičius
2
fetch - Missing boundary in multipart/form-data POST 在进行multipart/form-data POST时出现了缺少边界的问题。 - Brent Bradburn
3
这太棒了!我浪费了1个小时才明白这个。感谢分享这个技巧。 - Ashwin Prabhu
3
因为尽管这是有用的信息,但它并没有试图回答OP的问题,所以被踩了。 - toraritte
4
这是非常重要的信息,在MDN Fetch文档中没有被涵盖。 - Plasty Grove
在Chrome中,它将默认为text/plain。如果您设置了一些自定义标头,则无法正常工作。 - Pramuditha Chamikara

53

如果你想要多个文件,可以使用这个

var input = document.querySelector('input[type="file"]')

var data = new FormData()
for (const file of input.files) {
  data.append('files',file,file.name)
}

fetch('/avatars', {
  method: 'POST',
  body: data
})

8
请注意,明确传递 file.name 作为文件名并非必需;根据 MDN FormData.append 文档File 对象的默认名称已经是文件名。 - Mark Amery

33

要提交单个文件,您可以直接使用标签的.files数组中的File对象作为fetch()初始化器中body:的值:

const myInput = document.getElementById('my-input');

// Later, perhaps in a form 'submit' handler or the input's 'change' handler:
fetch('https://example.com/some_endpoint', {
  method: 'POST',
  body: myInput.files[0],
});

这是起作用的,因为File继承自Blob,而Blob是在Fetch标准中定义的可接受的BodyInit类型之一。


这是最简单的答案,但是 body: myInput.files[0] 如何导致客户端内存中持有的字节数量? - bhantol
2
我会期望通过这种解决方案,浏览器应该足够聪明,能够流式传输文件而不需要将其读入内存,@bhantol,但我还没有费力去确认(无论是通过实验还是深入规范)。如果你想要确认,你可以尝试使用这种方法上传一个50GB的文件或者其他什么,在每个主流浏览器中尝试一下,并查看你的浏览器是否会尝试使用过多的内存,导致被杀掉。 - Mark Amery
对我没有用。express-fileupload 无法解析请求流。但是 FormData 运行得很好。 - attacomsian
1
乍一看,express-fileupload 看起来是一个用于处理包含文件的 multipart/form-data 请求的服务器端库,因此它与这种直接将文件作为请求正文发送的方法不兼容。 - Mark Amery

21
这里的被接受答案有些过时。截至2020年4月,在MDN网站上看到的推荐方法建议使用FormData,也不要求设置内容类型。https://developer.mozilla.org/zh-CN/docs/Web/API/Fetch_API/Using_Fetch 为方便起见,我引用了代码片段:
const formData = new FormData();
const fileField = document.querySelector('input[type="file"]');

formData.append('username', 'abc123');
formData.append('avatar', fileField.files[0]);

fetch('https://example.com/profile/avatar', {
  method: 'PUT',
  body: formData
})
.then((response) => response.json())
.then((result) => {
  console.log('Success:', result);
})
.catch((error) => {
  console.error('Error:', error);
});

10
只有当服务器期望表单数据时,使用FormData才有效。如果服务器希望POST请求的主体是原始文件,则接受的答案是正确的。 - Clyde
@Clyde 你是什么意思?我以为是客户端决定发送到服务器的内容类型? - avisk
1
是的,但客户端和服务器必须就可以发送什么内容以及如何编码达成一致。编写服务器代码以接受原始POST正文或FormData(标头将显示客户端使用的编码)肯定是可能的,但通常服务器将期望特定的编码,因此您必须发送与之匹配的内容。 - Clyde

10

添加 PHP 端点示例会很好。这是 JavaScript:

const uploadinput = document.querySelector('#uploadinputid');
const uploadBtn = document.querySelector('#uploadBtnid');
uploadBtn.addEventListener('click',uploadFile);

async function uploadFile(){
    const formData = new FormData();
    formData.append('nameusedinFormData',uploadinput.files[0]);    
    try{
        const response = await fetch('server.php',{
            method:'POST',
            body:formData
        } );
        const result = await response.json();
        console.log(result);
    }catch(e){
        console.log(e);

    }
}

这是 PHP:

$file = $_FILES['nameusedinFormData'];
$temp = $file['tmp_name'];
$target_file = './targetfilename.jpg';
move_uploaded_file($_FILES["image"]["tmp_name"], $target_file);

6
问题并未假设用于上传文件的后端技术。 - Andrew Willis
然而不知怎么的,它对于其他人的学习和阅读仍然是有帮助的。 - undefined

5
从Alex Montoya的多文件输入元素方法开始,我们继续探讨。
const inputFiles = document.querySelectorAll('input[type="file"]');
const formData = new FormData();

for (const file of inputFiles) {
    formData.append(file.name, file.files[0]);
}

fetch(url, {
    method: 'POST',
    body: formData })

3

对我来说问题是我使用了response.blob()来填充表单数据。显然在React Native中你不能这样做,所以最终我使用了

data.append('fileData', {
  uri : pickerResponse.uri,
  type: pickerResponse.type,
  name: pickerResponse.fileName
 });

Fetch似乎能够识别这种格式并将文件发送到URI指向的位置。


1

如何使用 HTML5 fetch 在选择时上传单个文件

<label role="button">
  Upload a picture
  <input accept="image/*" type="file" hidden />
</label>

const input = document.querySelector(`input[type="file"]`);

function upload() {
  fetch(uplaodURL, { method: "PUT", body: input.files[0] });
}

input.addEventListener("change", upload); 

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接