JavaScript 如何读取本地文件

做者: Martin Splitt
译者:前端小智
来源:dev
点赞再看,养成习惯

本文 GitHub https://github.com/qq44924588... 上已经收录,更多往期高赞文章的分类,也整理了不少个人文档,和教程资料。欢迎Star和完善,你们面试能够参照考点复习,但愿咱们一块儿有点东西。javascript

出于安全和隐私的缘由,web应用程序不能直接访问用户设备上的文件。若是须要读取一个或多个本地文件,能够经过使用input fileFileReader来实现。在这篇文章中,咱们将经过一些例子来看看它是如何工做的。前端

文件操做的流程

获取文件

因为浏览器中的 JS 没法从用户的设备访问本地文件,咱们须要为用户提供一种方法来选择一个或多个文件供咱们使用。这能够经过文件选择器<input type='fule' />来完成。java

<input type="file" id="fileInput">

若是想允选择多个文件,能够添加multiple属性:git

<input type="file" id="fileInput" multiple>

咱们能够经过change事件来监听文件的选择,也能够添加另外一个UI元素让用户显式地开始对所选文件的处理。github

input file 具备一个files属性,该属性是File对象的列表(可能有多个选择的文件)。web

<input type="file" id="fileInput">
<script>
    document.getElementById('fileInput').addEventListener('change', function selectedFileChanged() {
      console.log(this.files); // will contain information about the file that was selected.
    });
</script>

File对象以下所示:面试

{
  name: 'test.txt',         // 所选文件的名称
  size: 1024,               // 字节大小
  type: 'text/plain',       // 基于文件扩展名的假定文件类型,这有多是不正确的
  lastModified: 1234567890, // 根据用户系统的最新更改的时间戳
  lastModifiedDate: // 最后修改的时间戳的日期对象
}

读取文件

读取文件,主要使用的是FileReader类。浏览器

该对象拥有的属性:安全

FileReader.error :只读,一个DOMException,表示在读取文件时发生的错误 。微信

FileReader.readyState:只读 表示FileReader状态的数字。取值以下:

常量名 描述
EMPTY 0 尚未加载任何数据
LOADING 1 数据正在被加载
DONE 2 已完成所有的读取请求

FileReader.result:只读,文件的内容。该属性仅在读取操做完成后才有效,数据的格式取决于使用哪一个方法来启动读取操做。

该对象拥有的方法:

readAsText(file, encoding):以纯文本形式读取文件,读取到的文本保存在result属性中。第二个参数表明编码格式。

readAsDataUrl(file):读取文件而且将文件以数据URI的形式保存在result属性中。

readAsBinaryString(file):读取文件而且把文件以字符串保存在result属性中。

readAsArrayBuffer(file):读取文件而且将一个包含文件内容的ArrayBuffer保存咋result属性中。

FileReader.abort():停止读取操做。在返回时,readyState属性为DONE

文件读取的过程是异步操做,在这个过程当中提供了三个事件:progresserrorload事件。

progress:每隔50ms左右,会触发一次progress事件。

error:在没法读取到文件信息的条件下触发。

load:在成功加载后就会触发。

在下面的示例中,咱们将使用readAsTextreadAsDataURL方法来显示文本和图像文件的内容。

例一:读取文本文件

为了将文件内容显示为文本,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]);
});

首先,咱们要确保有一个能够读取的文件。若是用户取消或以其余方式关闭文件选择对话框而不选择文件,咱们就没有什么要读取和退出函数。

而后咱们继续建立一个FileReaderreader的工做是异步的,以免阻塞主线程和UI更新,这在读取大文件(如视频)时很是重要。

reader发出一个'load'事件(例如,相似于Image对象),告诉咱们的文件已经读取完毕。

reader将文件内容保存在其result属性中。此属性中的数据取决于咱们使用的读取文件的方法。在咱们的示例中,咱们使用readAsText方法读取文件,所以result将是一个文本字符串。

例二:显示本地选择的图片

若是咱们想要显示图像,将文件读取为字符串并非颇有用。FileReader有一个readAsDataURL方法,能够将文件读入一个编码的字符串,该字符串能够用做<img>元素的源。本例的代码与前面的代码基本相同,区别是咱们使用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来访问所选文件的内容。


代码部署后可能存在的BUG无法实时知道,过后为了解决这些BUG,花了大量的时间进行log 调试,这边顺便给你们推荐一个好用的BUG监控工具 Fundebug。

原文:https://dev.to/g33konaut/read...


交流

文章每周持续更新,能够微信搜索「 大迁世界 」第一时间阅读和催更(比博客早一到两篇哟),本文 GitHub https://github.com/qq449245884/xiaozhi 已经收录,整理了不少个人文档,欢迎Star和完善,你们面试能够参照考点复习,另外关注公众号,后台回复福利,便可看到福利,你懂的。

相关文章
相关标签/搜索