FileReader API

无需后端服务器,异步读取和解释上传的文件。
网站是如何在不存储任何数据的情况下解释上传的文件的吗?FileReader API就是答案!它允许客户端应用程序异步读取和解释上传的文件。

要在您自己的客户端应用程序中执行此操作,您还需要了解File APIBlob API。这些是您将使用FileReader API读取的对象。您还可以使用FileReader API来分析从拖放操作中获取的文件。

注意:这与较新的File System API不同,后者提供了浏览器(和客户端JavaScript)访问本地文件系统的功能。

尽管这个API已经存在一段时间了(Chrome在版本6中开始支持它),但现代用法的部分支持时间并不长,例如File API(在Chrome 13中发布)和File()构造函数(在Chrome 38中发布)。

基础知识

FileReader API在基本用法中,可以与<input type="file" />结合使用。一旦通过文件浏览器选择了文件,或者将文件拖放到文件字段上,就会在输入元素上创建一个新的File对象。

FileReader可以与任何File对象一起使用,但我们将探讨一个基本的用法场景。

让我们尝试将File对象传递给FileReader API,如下所示:

function readFile(file) {
    const fileReader = new FileReader();
    fileReader.readAsText(file);
}

然而,上面的示例还不够完整。FileReader API默认是异步的,并且不使用Promises。相反,您可以监听几个事件。

现在,让我们专注于以下事件:

  • load:在成功加载文件时触发
  • error:在读取文件失败时触发
function readFile() {
    const fileReader = new FileReader();
    const resultContainer = document.getElementById('result');
    const file = document.getElementById('uploaded-file').files[0];

    if (file) {
        fileReader.readAsText(file);
    }
    
    fileReader.addEventListener('load', () => {
        resultContainer.innerText = fileReader.result
    }, { once: true });
}

请注意,在上面的示例中,我们将resultContainer的文本设置为FileReader触发load事件后所获得的结果。

fileReader对象上的result属性正是您所期望的:FileReader从文件中读取的内容包含在result属性中。

虽然它无法读取每种类型文件的内容,但FileReader提供了以下方法:

  • readAsText()
  • readAsDataURL()
  • readAsArrayBuffer()

方法:readAsText()

首先是FileReader API提供的非常基础的文本方法。您应该只在较小的文件上使用此方法,因为它会将整个文件读入内存。对于较大的文件,您应该使用readAsArrayBuffer(),因为它返回一个Promise,并且对于较大的文件更加可预测。

在上面的示例中,我们将传递给readFile()的文件并记录readAsText方法的结果。如果我们想读取任何类型的基于文本的文件,例如 .txt.csv等,这将非常有用。

<label>
  Upload file
  <input type="file" id="testfile" accept=".txt" onchange="readFile()">
</label>
<br> <br>
<div>
  Contents of Text File:
  <div id="result"></div>
</div>
function readFile() {
  const fileReader = new FileReader();
  const resultContainer = document.getElementById("result");
  const file = document.querySelector("input[type=file]").files[0];

  if (file) {
    fileReader.readAsText(file); // Read the file so fileReader.result is populated.
  }

  fileReader.addEventListener(
    "load",
    () => {
      resultContainer.textContent = fileReader.result;
    },
    { once: true }
  );
}

方法:readAsDataURL()

此方法可用于读取图像,类似于如果它们是数据URL字符串时与图像进行交互的方式。这正是此方法的作用:将图像作为base64编码的数据URL返回。

注意:它是readAsDataURL - URL中所有字母都大写 - 而不是readAsDataUrl。使用后者会导致错误 - 它是区分大小写的。

让我们看下面的示例:

<!-- 不要忘记以语义化方式编写HTML! -->
<label>
    <input type="file" id="uploaded-file" onchange="readImage()" name="uploaded-file" accept="image/*">
    上传一张图片。
</label>
<div id="result"></div>

请注意,我使用accept属性将上传的文件限制为图像类型的MIME类型。查阅MDN上有关如何指定要接受的文件类型的信息。

function readImage() {
    const fileReader = new FileReader();
    const file = document.getElementById("uploaded-file").files[0];
    
    if (file) {
        fileReader.readAsDataUrl(file);
    }

    fileReader.addEventListener('load', () => {
        const result = fileReader.result;
        const resultContainer = document.getElementById("result");
        const img = document.createElement("img");
        img.src = result;
        resultContainer.append(img);
    }, { once: true })
}

在上面的示例中,我们:

  • 创建一个FileReader
  • 然后监听load事件的发生(意味着文件读取会话成功)
  • 然后创建一个<img>元素,并将图像作为数据URL放入src属性中
  • 最后,将创建的img添加到我们为图像创建的<div>容器中
<label>
  Upload file
  <input type="file" id="testfile" accept="image/*" onchange="readImage()">
</label>
<br> <br>
<div>
  Image that was uploaded:
  <div id="result"></div>
</div>
function readImage() {
  const fileReader = new FileReader();
  const file = document.querySelector("input[type=file]").files[0];

  if (file) {
    fileReader.readAsDataURL(file);
  }

  fileReader.addEventListener(
    "load",
    () => {
      const result = fileReader.result;
      const resultContainer = document.getElementById("result");
      const img = document.createElement("img");
      img.src = result;
      resultContainer.append(img);
    },
    { once: true }
  );
}

此API非常适用于简单的浏览器操作,甚至可以用于上传图像/文本/文件到后端服务器时的实时状态更新。要在主要社交网络上更新个人资料图片?您可以使用FileReader API来复制此操作。

FileReader事件

FileReader上还有几个其他事件值得了解。

  • abort - 文件读取已被中止(取消)
  • progress - 在读取期间定期触发
  • loadstart / loadend - 可用于在文件加载开始或结束时触发某些操作

这些事件是从ProgressEvent接口扩展的。通过监听FileReader上的progress事件,您可以通过将ProgressEvent上的loaded除以total属性来计算文件读取进度。

fileReader.addEventListener("progress", (event) => {
  const progress = (event.loaded / event.total) * 100;
  console.log(`读取进度:${progress}%`);
});

进阶

FileReader是一个很棒的API,可用于许多客户端应用程序。它是许多您可能已经使用的应用程序的基础。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 155,348评论 4 355
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 65,906评论 1 283
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,191评论 0 235
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,295评论 0 201
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,606评论 3 283
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,107评论 1 202
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,507评论 2 305
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,217评论 0 193
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,848评论 1 234
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,183评论 2 238
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,734评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,084评论 2 247
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,608评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,921评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,627评论 0 190
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,103评论 2 261
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,054评论 2 257

推荐阅读更多精彩内容