跳到主要内容

dart:io

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

通常,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,当结果可用时,它会提供结果。

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() 方法返回一个 Stream,当遇到文件或目录时,它会发出一个对象。

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 (localhost),响应对路径 /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 请求。dart:io 中的 HttpClient 类与平台相关且绑定于单一实现。相反,请使用 package:http 等更高级的库。

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

更多信息

#

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