blob: 316b42f53ec9e1cbb32fe2c74f895b51d6d9213d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
---
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>
<p>{{CompatibilityTable}}</p>
<div id="compat-desktop">
<table class="compat-table">
<tbody>
<tr>
<th>Feature</th>
<th>Firefox (Gecko)</th>
<th>Chrome</th>
<th>Edge</th>
<th>Internet Explorer</th>
<th>Opera</th>
<th>Safari</th>
</tr>
<tr>
<td>Basic support</td>
<td>{{CompatGeckoDesktop("1.9.2")}}<sup>[1]</sup></td>
<td>7</td>
<td>{{CompatVersionUnknown}}</td>
<td>10</td>
<td>12.02<sup>[2]</sup></td>
<td>6.0</td>
</tr>
<tr>
<td>Support in Web Workers</td>
<td>{{CompatGeckoDesktop(46)}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatVersionUnknown}}</td>
<td>{{CompatNo}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
</tr>
<tr>
<td><code>error</code> property uses {{domxref("DOMException")}}, not {{domxref("DOMError")}}</td>
<td>{{CompatGeckoDesktop(58)}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
</tr>
</tbody>
</table>
</div>
<div id="compat-mobile">
<table class="compat-table">
<tbody>
<tr>
<th>Feature</th>
<th>Firefox Mobile (Gecko)</th>
<th>Android</th>
<th>Edge</th>
<th>IE Mobile</th>
<th>Opera Mobile</th>
<th>Safari Mobile</th>
</tr>
<tr>
<td>Basic support</td>
<td>32</td>
<td>3</td>
<td>{{CompatVersionUnknown}}</td>
<td>10</td>
<td>11.5</td>
<td>6.1</td>
</tr>
<tr>
<td>Support in Web Workers</td>
<td>{{CompatGeckoMobile(46)}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatVersionUnknown}}</td>
<td>{{CompatNo}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
</tr>
<tr>
<td><code>error</code> property uses {{domxref("DOMException")}}, not {{domxref("DOMError")}}</td>
<td>{{CompatGeckoMobile(58)}}</td>
<td>{{CompatUnknown()}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
<td>{{CompatVersionUnknown()}}</td>
<td>{{CompatNo}}</td>
</tr>
</tbody>
</table>
</div>
<p>[1] Prior to Gecko 2.0 beta 7 (Firefox 4.0 beta 7), all {{domxref("Blob")}} parameters below were {{domxref("File")}} parameters; this has since been updated to match the specification correctly. Prior to Gecko 13.0 {{geckoRelease("13.0")}} the <code>FileReader.error</code> property returned a {{domxref("FileError")}} object. This interface has been removed and <code>FileReader.error</code> is now returning the {{domxref("DOMError")}} object as defined in the latest FileAPI draft.</p>
<p>[2] Opera has <a href="http://www.opera.com/docs/specs/presto28/file/">partial support</a> in 11.1.</p>
<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>
|
