内容

dart:io 库提供 API 来处理文件、目录、进程、套接字、WebSocket 以及 HTTP 客户端和服务器。

一般来说,dart:io 库实现并推广异步 API。同步方法很容易阻塞应用程序,使其难以扩展。因此,大多数操作通过 Future 或 Stream 对象返回结果,这是 Node.js 等现代服务器平台常见的模式。

dart:io 库中为数不多的同步方法在方法名称上明确标记了 Sync 后缀。本文档不介绍同步方法。

要使用 dart:io 库,必须导入它

dart
import 'dart:io';

文件和目录

#

I/O 库使命令行应用能够读取和写入文件以及浏览目录。你有两种选择来读取文件内容:一次性读取或流式读取。一次性读取文件需要足够的内存来存储文件的所有内容。如果文件非常大,或者你希望在读取时对其进行处理,则应使用 Stream,如 流式读取文件内容 中所述。

以文本形式读取文件

#

在读取使用 UTF-8 编码的文本文件时,可以使用 readAsString() 读取整个文件内容。当各个行很重要时,可以使用 readAsLines()。在这两种情况下,都会返回一个 Future 对象,该对象将文件的内容作为一或多个字符串提供。

dart
void main() async {
  var config = File('config.txt');

  // Put the whole file in a single string.
  var stringContents = await config.readAsString();
  print('The file is ${stringContents.length} characters long.');

  // Put each line of the file into its own string.
  var lines = await config.readAsLines();
  print('The file is ${lines.length} lines long.');
}

以二进制形式读取文件

#

以下代码将整个文件作为字节读取到一个整数列表中。对 readAsBytes() 的调用返回一个 Future,该 Future 在结果可用时提供结果。

dart
void main() async {
  var config = File('config.txt');

  var contents = await config.readAsBytes();
  print('The file is ${contents.length} bytes long.');
}

处理错误

#

要捕获错误以避免导致未捕获的异常,可以在 Future 上注册一个 catchError 处理程序,或者(在 async 函数中)使用 try-catch

dart
void main() async {
  var config = File('config.txt');
  try {
    var contents = await config.readAsString();
    print(contents);
  } catch (e) {
    print(e);
  }
}

流式传输文件内容

#

使用 Stream 一次读取少量文件。你可以使用 Stream APIawait for,它属于 Dart 的 异步支持 的一部分。

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

void main() async {
  var config = File('config.txt');
  Stream<List<int>> inputStream = config.openRead();

  var lines = utf8.decoder.bind(inputStream).transform(const LineSplitter());
  try {
    await for (final line in lines) {
      print('Got ${line.length} characters from stream');
    }
    print('file is now closed');
  } catch (e) {
    print(e);
  }
}

写入文件内容

#

你可以使用 IOSink 将数据写入文件。使用 File openWrite() 方法获取可以写入的 IOSink。默认模式 FileMode.write 会完全覆盖文件中的现有数据。

dart
var logFile = File('log.txt');
var sink = logFile.openWrite();
sink.write('FILE ACCESSED ${DateTime.now()}\n');
await sink.flush();
await sink.close();

要添加到文件的末尾,请使用可选的 mode 参数指定 FileMode.append

dart
var sink = logFile.openWrite(mode: FileMode.append);

要写入二进制数据,请使用 add(List<int> data)

列出目录中的文件

#

查找目录的所有文件和子目录是一个异步操作。list() 方法返回一个流,在遇到文件或目录时发出一个对象。

dart
void main() async {
  var dir = Directory('tmp');

  try {
    var dirList = dir.list();
    await for (final FileSystemEntity f in dirList) {
      if (f is File) {
        print('Found file ${f.path}');
      } else if (f is Directory) {
        print('Found dir ${f.path}');
      }
    }
  } catch (e) {
    print(e.toString());
  }
}

其他常见功能

#

File 和 Directory 类包含其他功能,包括但不限于

  • 创建文件或目录:File 和 Directory 中的 create()
  • 删除文件或目录:File 和 Directory 中的 delete()
  • 获取文件长度:File 中的 length()
  • 获取对文件的随机访问:File 中的 open()

请参阅 FileDirectory 的 API 文档,了解方法的完整列表。

HTTP 客户端和服务器

#

dart:io 库提供命令行应用程序可用于访问 HTTP 资源以及运行 HTTP 服务器的类。

HTTP 服务器

#

HttpServer 类提供用于构建 Web 服务器的底层功能。您可以匹配请求处理程序、设置标头、流式传输数据等。

以下示例 Web 服务器返回简单的文本信息。此服务器侦听端口 8888 和地址 127.0.0.1(本地主机),响应路径 /dart 的请求。对于任何其他路径,响应是状态代码 404(未找到页面)。

dart
void main() async {
  final requests = await HttpServer.bind('localhost', 8888);
  await for (final request in requests) {
    processRequest(request);
  }
}

void processRequest(HttpRequest request) {
  print('Got request for ${request.uri.path}');
  final response = request.response;
  if (request.uri.path == '/dart') {
    response
      ..headers.contentType = ContentType(
        'text',
        'plain',
      )
      ..write('Hello from the server');
  } else {
    response.statusCode = HttpStatus.notFound;
  }
  response.close();
}

HTTP 客户端

#

您应该避免直接使用 dart:io 发出 HTTP 请求。HttpClient 类在 dart:io 中是与平台相关的,并且与单个实现相关联。相反,请使用更高级别的库,例如 package:http

从互联网获取数据 教程解释了如何使用 package:http 发出 HTTP 请求。

更多信息

#

此页面展示了如何使用 dart:io 库的主要功能。除了本节中讨论的 API 之外,dart:io 库还为 进程套接字Web 套接字 提供 API。有关服务器端和命令行应用程序开发的更多信息,请参阅 服务器端 Dart 概览