File 类 抽象 接口

文件系统上的文件引用。

File 对象包含可以执行操作的 路径。您可以使用 parent 属性（从 FileSystemEntity 继承而来）获取文件的父目录。

使用文件路径创建一个新的 File 对象，以便从您的程序中访问文件系统上的指定文件。

var myFile = File('file.txt');

File 类包含用于操作文件及其内容的多种方法。使用此类中的方法，您可以打开和关闭文件，从它们中读取和写入，创建和删除它们，并检查它们的存在。

在读取或写入文件时，您可以使用流（通过 openRead），随机访问操作（通过 open），或方便的方法，例如 readAsString。

此类中的大多数方法都存在同步和异步的配对，例如，readAsString 和 readAsStringSync。除非您有使用方法同步版本的特定原因，否则请优先使用异步版本，以避免阻塞您的程序。

如果路径是链接

如果 path 是符号链接而不是文件，那么 File 的方法将操作链接的最终目标，除了 delete 和 deleteSync，它们将操作链接。

从文件中读取

以下代码示例使用异步的 readAsString 方法读取文件的全部内容作为字符串。

import 'dart:async';
import 'dart:io';

void main() {
  File('file.txt').readAsString().then((String contents) {
    print(contents);
  });
}

读取文件的一种更灵活和有用的方法是使用 Stream。使用 openRead 打开文件，它返回一个提供文件数据的流，以字节数据块的形式。在文件内容可用时读取流以处理文件内容。您可以使用各种转换器连续操作文件内容以将其转换为所需格式，或为其输出做准备。

您可能想使用流来读取大型文件，使用转换器操作数据，或与另一个 API（如 WebSocket）兼容。

import 'dart:io';
import 'dart:convert';
import 'dart:async';

void main() async {
  final file = File('file.txt');
  Stream<String> lines = file.openRead()
    .transform(utf8.decoder)       // Decode bytes to UTF-8.
    .transform(LineSplitter());    // Convert stream to individual lines.
  try {
    await for (var line in lines) {
      print('$line: ${line.length} characters');
    }
    print('File is now closed.');
  } catch (e) {
    print('Error: $e');
  }
}

向文件写入

要向文件写入字符串，请使用 writeAsString 方法

import 'dart:io';

void main() async {
  final filename = 'file.txt';
  var file = await File(filename).writeAsString('some content');
  // Do something with the file.
}

您也可以使用流向文件写入。使用 openWrite 打开文件，它返回一个 IOSink，您可以将数据写入其中。确保使用 IOSink.close 方法关闭接收器。

import 'dart:io';

void main() async {
  var file = File('file.txt');
  var sink = file.openWrite();
  sink.write('FILE ACCESSED ${DateTime.now()}\n');
  await sink.flush();

  // Close the IOSink to free system resources.
  await sink.close();
}

异步方法的使用

为了避免程序意外阻塞，一些方法是异步的，并返回一个Future。例如，获取文件长度的length方法返回一个Future。等待Future准备好时获取结果。

import 'dart:io';

void main() async {
  final file = File('file.txt');

  var length = await file.length();
  print(length);
}

除了length之外，exists、lastModified、stat等方法也是异步的。

其他资源

• 库浏览中的文件和目录部分。

• 编写命令行应用程序教程，其中包含有关文件和目录的信息。