dart:io

内容 keyboard_arrow_down keyboard_arrow_up

文件和目录
HTTP 客户端和服务器
- HTTP 服务器
- HTTP 客户端
更多信息

more_horiz

The 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 对象，该对象在可用时提供文件的内容，以一个或多个字符串形式。

dartvoid 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.');
}

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

dartvoid 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

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

使用 Stream 一次读取文件的一小部分内容。您可以使用 Stream API 或 await for（Dart 的异步支持的一部分）。

dartimport '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 会完全覆盖文件中现有的数据。

dartvar 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，该 Stream 在遇到文件或目录时发出一个对象。

dartvoid 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()

有关方法的完整列表，请参考 File 和 Directory 的 API 文档。

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

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

以下示例 Web 服务器返回简单的文本信息。该服务器监听端口 8888 和地址 127.0.0.1（localhost），并响应对路径 /dart 的请求。对于任何其他路径，响应将是状态码 404（页面未找到）。

dartvoid 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();
}

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

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

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

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面最后更新于 2024-04-09。查看源代码或报告问题.

dart:io

文件和目录

将文件读取为文本

将文件读取为二进制

处理错误

流式传输文件内容

写入文件内容

列出目录中的文件

其他常用功能

HTTP 客户端和服务器

HTTP 服务器

HTTP 客户端

更多信息