---
title: FileReader
slug: Web/API/FileReader
tags:
  - API
  - File API
  - Files
  - Interface
  - Reference
translation_of: Web/API/FileReader
---
<p>{{APIRef("File API")}}</p>

<p><code><strong>FileReader</strong></code> 对象允许Web应用程序异步读取存储在用户计算机上的文件（或原始数据缓冲区）的内容，使用 {{domxref("File")}} 或 {{domxref("Blob")}} 对象指定要读取的文件或数据。</p>

<p>其中File对象可以是来自用户在一个{{ HTMLElement("input") }}元素上选择文件后返回的{{ domxref("FileList") }}对象,也可以来自拖放操作生成的 <a href="/zh-CN/docs/Web/API/DataTransfer" title="En/DragDrop/DataTransfer"><code>DataTransfer</code></a>对象,还可以是来自在一个{{ domxref("HTMLCanvasElement") }}上执行<code>mozGetAsFile()</code>方法后返回结果。</p>

<p>重要提示： FileReader仅用于以安全的方式从用户（远程）系统读取文件内容 它不能用于从文件系统中按路径名简单地读取文件。 要在JavaScript中按路径名读取文件，应使用标准Ajax解决方案进行服务器端文件读取，如果读取跨域，则使用CORS权限。</p>

<p>{{AvailableInWorkers}}</p>

<h2 id="构造函数">构造函数</h2>

<dl>
 <dt>{{domxref("FileReader.FileReader", "FileReader()")}}</dt>
 <dd>返回一个新构造的<code>FileReader</code>。</dd>
</dl>

<p>有关详细信息和示例，请参阅<a href="/zh-CN/Using_files_from_web_applications" title="en/Using files from web applications">如何在web应用程序中使用文件</a>。</p>

<h2 id="Method_overview" name="Method_overview">属性</h2>

<dl>
 <dt>{{domxref("FileReader.error")}} {{readonlyinline}}</dt>
 <dd>一个{{domxref("DOMException")}}，表示在读取文件时发生的错误 。</dd>
 <dt>{{domxref("FileReader.readyState")}} {{readonlyinline}}</dt>
 <dd>表示<code>FileReader</code>状态的数字。取值如下：
 <table class="standard-table">
  <tbody>
   <tr>
    <td class="header">常量名</td>
    <td class="header">值</td>
    <td class="header">描述</td>
   </tr>
   <tr>
    <td><code>EMPTY</code></td>
    <td><code>0</code></td>
    <td>还没有加载任何数据.</td>
   </tr>
   <tr>
    <td><code>LOADING</code></td>
    <td><code>1</code></td>
    <td>数据正在被加载.</td>
   </tr>
   <tr>
    <td><code>DONE</code></td>
    <td><code>2</code></td>
    <td>已完成全部的读取请求.</td>
   </tr>
  </tbody>
 </table>
 </dd>
 <dt>{{domxref("FileReader.result")}} {{readonlyinline}}</dt>
 <dd>文件的内容。该属性仅在读取操作完成后才有效，数据的格式取决于使用哪个方法来启动读取操作。</dd>
</dl>

<h3 id="事件处理">事件处理</h3>

<dl>
 <dt>{{domxref("FileReader.onabort")}}</dt>
 <dd>处理{{event("abort")}}事件。该事件在读取操作被中断时触发。</dd>
 <dt>{{domxref("FileReader.onerror")}}</dt>
 <dd>处理{{event("error")}}事件。该事件在读取操作发生错误时触发。</dd>
 <dt>{{domxref("FileReader.onload")}}</dt>
 <dd>处理{{event("load")}}事件。该事件在读取操作完成时触发。</dd>
 <dt>{{domxref("FileReader.onloadstart")}}</dt>
 <dd>处理{{event("loadstart")}}事件。该事件在读取操作开始时触发。</dd>
 <dt>{{domxref("FileReader.onloadend")}}</dt>
 <dd>处理{{event("loadend")}}事件。该事件在读取操作结束时（要么成功，要么失败）触发。</dd>
 <dt>{{domxref("FileReader.onprogress")}}</dt>
 <dd>处理{{event("progress")}}事件。该事件在读取{{domxref("Blob")}}时触发。</dd>
</dl>

<div class="note">
<p>因为 <code>FileReader</code> 继承自{{domxref("EventTarget")}}，所以所有这些事件也可以通过{{domxref("EventTarget.addEventListener()","addEventListener")}}方法使用。</p>
</div>

<h2 id="Properties" name="Properties">方法</h2>

<dl>
 <dt>{{domxref("FileReader.abort()")}}</dt>
 <dd>中止读取操作。在返回时，<code>readyState</code>属性为<code>DONE</code>。</dd>
 <dt>{{domxref("FileReader.readAsArrayBuffer()")}} {{gecko_minversion_inline("7.0")}}</dt>
 <dd>开始读取指定的 {{domxref("Blob")}}中的内容, 一旦完成, result 属性中保存的将是被读取文件的 {{domxref("ArrayBuffer")}} 数据对象.</dd>
 <dt>{{domxref("FileReader.readAsBinaryString()")}} {{non-standard_inline}}</dt>
 <dd>开始读取指定的{{ domxref("Blob") }}中的内容。一旦完成，<code>result</code>属性中将包含所读取文件的原始二进制数据。</dd>
 <dt>{{domxref("FileReader.readAsDataURL()")}}</dt>
 <dd>开始读取指定的{{ domxref("Blob") }}中的内容。一旦完成，<code>result</code>属性中将包含一个<code>data:</code> URL格式的Base64字符串以表示所读取文件的内容。</dd>
 <dt>{{domxref("FileReader.readAsText()")}}</dt>
 <dd>开始读取指定的{{ domxref("Blob") }}中的内容。一旦完成，<code>result</code>属性中将包含一个字符串以表示所读取的文件内容。</dd>
</dl>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName("File API", "#dfn-filereader", "FileReader")}}</td>
   <td>{{Spec2("File API")}}</td>
   <td>Initial definition</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容">浏览器兼容</h2>

{{Compat("api.FileReader")}}

<h2 id="See_also" name="See_also">相关链接</h2>

<ul>
 <li><a href="/zh-CN/Using_files_from_web_applications" title="en/Using files from web applications">如何在web应用程序中使用文件</a></li>
 <li>{{domxref("File")}}</li>
 <li>{{domxref("Blob")}}</li>
</ul>