出于安全和隐私的原因,web 应用程序不能直接访问用户设备上的文件。如果需要读取一个或多个本地文件,可以通过使用input file
和FileReader
来实现。在这篇文章中,我们将通过一些例子来看看它是如何工作的。
由于浏览器中的 JS 无法从用户的设备访问本地文件,我们需要为用户提供一种方法来选择一个或多个文件供我们使用。这可以通过文件选择器来完成。
如果想允选择多个文件,可以添加multiple
属性:
我们可以通过change
事件来监听文件的选择,也可以添加另一个 UI 元素让用户显式地开始对所选文件的处理。
input file 具有一个files
属性,该属性是File
对象的列表(可能有多个选择的文件)。
document.getElementById('fileInput').addEventListener('change', function selectedFileChanged() {
console.log(this.files); // will contain information about the file that was selected.
});
File
对象如下所示:
{
name: 'test.txt', // 所选文件的名称
size: 1024, // 字节大小
type: 'text/plain', // 基于文件扩展名的假定文件类型,这有可能是不正确的
lastModified: 1234567890, // 根据用户系统的最新更改的时间戳
lastModifiedDate: // 最后修改的时间戳的日期对象
}
读取文件
读取文件,主要使用的是[FileReader][1]类。
「该对象拥有的属性:」
「FileReader.error」 :只读,一个DOMException
,表示在读取文件时发生的错误 。
「FileReader.readyState」:只读 表示 FileReader 状态的数字。取值如下:
常量名值描述EMPTY0还没有加载任何数据LOADING1数据正在被加载DONE2已完成全部的读取请求「FileReader.result」:只读,文件的内容。该属性仅在读取操作完成后才有效,数据的格式取决于使用哪个方法来启动读取操作。
「该对象拥有的方法:」
readAsText(file, encoding)
:以纯文本形式读取文件,读取到的文本保存在result
属性中。第二个参数代表编码格式。
readAsDataUrl(file)
:读取文件并且将文件以数据URI
的形式保存在result
属性中。
readAsBinaryString(file)
:读取文件并且把文件以字符串保存在result
属性中。
readAsArrayBuffer(file)
:读取文件并且将一个包含文件内容的ArrayBuffer
保存咋result
属性中。
FileReader.abort()
:中止读取操作。在返回时,readyState
属性为DONE
。
「文件读取的过程是异步操作,在这个过程中提供了三个事件:progress
、error
、load
事件。」
progress
:每隔50ms
左右,会触发一次progress
事件。
error
:在无法读取到文件信息的条件下触发。
load
:在成功加载后就会触发。
在下面的示例中,我们将使用readAsText
和readAsDataURL
方法来显示文本和图像文件的内容。
为了将文件内容显示为文本,change
需要重写一下:
document.getElementById('fileInput').addEventListener('change', function selectedFileChanged() {
if (this.files.length === 0) {
console.log('请选择文件!');
return;
}
const reader = new FileReader();
reader.onload = function fileReadCompleted() {
// 当读取完成时,内容只在`reader.result`中
console.log(reader.result);
};
reader.readAsText(this.files[0]);
});
首先,我们要确保有一个可以读取的文件。如果用户取消或以其他方式关闭文件选择对话框而不选择文件,我们就没有什么要读取和退出函数。
然后我们继续创建一个FileReader
。reader
的工作是异步的,以避免阻塞主线程和 UI 更新,这在读取大文件(如视频)时非常重要。
reader
发出一个'load'
事件(例如,类似于Image
对象),告诉我们的文件已经读取完毕。
reader
将文件内容保存在其result
属性中。此属性中的数据取决于我们使用的读取文件的方法。在我们的示例中,我们使用readAsText
方法读取文件,因此result
将是一个文本字符串。
如果我们想要显示图像,将文件读取为字符串并不是很有用。FileReader
有一个readAsDataURL
方法,可以将文件读入一个编码的字符串,该字符串可以用作
元素的源。本例的代码与前面的代码基本相同,区别是我们使用readAsDataURL
读取文件并将结果显示为图像:
document.getElementById('fileInput').addEventListener('change', function selectedFileChanged() {
if (this.files.length === 0) {
console.log('No file selected.');
return;
}
const reader = new FileReader();
reader.onload = function fileReadCompleted() {
const img = new Image();
img.src = reader.result;
document.body.appendChild(img);
};
reader.readAsDataURL(this.files[0]);
});
总结
1)由于安全和隐私的原因,JavaScript 不能直接访问本地文件。
2)可以通过 input 类型为 file 来选择文件,并对文件进行处理。
3) file
input 具有带有所选文件的files
属性。
4) 我们可以使用FileReader
来访问所选文件的内容。
作者: Martin Splitt 译者:前端小智 来源:dev
原文:https://dev.to/g33konaut/reading-local-files-with-javascript-25hn
相关热门推荐
CSS 中你需要知道 auto 的一切!
我发现了7个关于 CSS backgroundImage 好用的技巧
Web 隐藏技术:几中隐藏 Web 中的元素方法及优缺点
Vue 中,如何将函数作为 props 传递给组件
如何写出优雅的 JS 代码,变量和函数的正确写法
「前端编程挑战 24」HTML+CSS3 实现粘性导航特效
5个很棒的 React.js 库,值得你亲手试试!
2020年面向前端开发人员的10个很棒的 JS 库
通过几个事例,就可以说明 for...of 循环在 JS 是不可或缺