迁移到 package:web

Dart 的 package:web 公开了对浏览器 API 的访问，从而实现了 Dart 应用程序和 Web 之间的互操作。使用 package:web 与浏览器交互并操作 DOM 中的对象和元素。

import 'package:web/web.dart';

void main() {
  final div = document.querySelector('div')!;
  div.text = 'Text set at ${DateTime.now()}';
}

package:web 的目标是通过解决现有 Dart Web 库的几个问题来改进 Dart 公开 Web API 的方式

1. Wasm 兼容性

   只有使用 dart:js_interop 和 dart:js_interop_unsafe，包才能与 Wasm 兼容。package:web 基于 dart:js_interop，因此默认情况下，它在 dart2wasm 上受支持。

   Dart 核心 Web 库，如 dart:html 和 dart:svg，在编译到 Wasm 时不受支持。

2. 保持现代

   package:web 使用 Web IDL 为 IDL 中的每个声明自动生成 互操作成员 和 互操作类型。直接生成引用，而不是像 dart:html 中的其他成员和抽象，使 package:web 更加简洁、易于理解、更一致，并且更能够与 Web 发展的未来保持同步。

3. 版本控制

   由于它是一个包，package:web 可以比 dart:html 这样的库更容易地进行版本控制，并在发展过程中避免破坏用户代码。它还使代码不那么排他性，更开放地接受贡献。开发人员可以创建自己的 替代互操作声明，并将它们与 package:web 一起使用，而不会发生冲突。

这些改进自然会导致 package:web 和 dart:html 之间的一些实现差异。最影响现有包的更改，如 IDL 重命名 和 类型测试，将在以下迁移部分中解决。虽然为了简洁起见，我们仅提及 dart:html，但相同的迁移模式适用于任何其他 Dart 核心 Web 库，如 dart:svg。

删除 dart:html 导入并将其替换为 package:web/web.dart

import 'dart:html' as html; // Remove
import 'package:web/web.dart' as web; // Add

将 web 添加到您的 pubspec 中的 dependencies

dart pub add web

以下部分涵盖了从 dart:html 到 package:web 的一些常见迁移问题。

对于任何其他迁移问题，请查看 dart-lang/web 仓库并提交问题。

dart:html 中的许多符号都从其原始 IDL 声明中重命名，以更符合 Dart 样式。例如，appendChild 变成了 append，HTMLElement 变成了 HtmlElement 等。

相比之下，为了减少混淆，package:web 使用了 IDL 定义中的原始名称。可以使用 dart fix 来转换 dart:html 和 package:web 之间已重命名的类型。

更改导入后，任何重命名的对象都将是新的“未定义”错误。您可以通过以下方式解决这些错误

• 从 CLI 中，通过运行 dart fix --dry-run。
• 在您的 IDE 中，通过选择 dart fix：重命名为“package:web name”。

dart fix 涵盖了许多常见的类型重命名。如果您遇到没有 dart fix 来重命名的 dart:html 类型，请首先通过提交 问题 告知我们。

然后，您可以通过查找其定义来尝试手动发现现有 dart:html 成员的 package:web 类型名称。dart:html 成员定义上的 @Native 注解的值告诉编译器将该类型的任何 JS 对象视为其注解的 Dart 类。例如，@Native 注解告诉我们 dart:html 的 HtmlElement 成员的本地 JS 名称是 HTMLElement，因此 package:web 名称也将是 HTMLElement

@Native("HTMLElement")
class HtmlElement extends Element implements NoncedElement { }

要查找 package:web 中未定义成员的 dart:html 定义，请尝试以下任一方法

• 在 IDE 中按住 Ctrl 或 Command 键单击未定义的名称，然后选择转到定义。
• 在 dart:html API 文档中搜索该名称，并在注解下查看其页面。

类似地，您可能会发现未定义的 package:web API，其对应的 dart:html 成员的定义使用关键字 native。检查定义是否使用了 @JSName 注解进行重命名；注解的值将告诉您该成员在 package:web 中使用的名称

@JSName('appendChild')
Node append(Node node) native;

native 是一个内部关键字，在此上下文中与 external 的含义相同。

使用 dart:html 的代码通常会利用运行时检查，如 is。当与 dart:html 对象一起使用时，is 和 as 会验证该对象是否是 @Native 注解中的 JS 类型。相比之下，所有 package:web 类型都被具体化为 JSObject。这意味着运行时类型测试将在 dart:html 和 package:web 类型之间产生不同的行为。

为了能够执行类型测试，请迁移任何使用 is 类型测试的 dart:html 代码，以使用 互操作方法，如 instanceOfString 或更方便且类型化的 isA 助手（从 Dart 3.4 开始可用）。JS 类型页面的 兼容性、类型检查和强制转换 部分详细介绍了替代方案。

obj is Window; // Remove
obj.instanceOfString('Window'); // Add

dart:html 中的许多 API 在其类型签名中支持各种 Dart 类型。由于 dart:js_interop 限制了可以编写的类型，因此 package:web 中的某些成员现在需要您在调用成员之前转换值。请从 JS 类型页面的转换部分了解如何使用互操作转换方法。

window.addEventListener('click', callback); // Remove
window.addEventListener('click', callback.toJS); // Add

通常，您可以发现哪些方法需要转换，因为它们会被标记为某种形式的异常

A value of type '...' can't be assigned to a variable of type 'JSFunction?'

代码通常会基于是否支持 dart:html 使用条件导入来区分原生和 Web

export 'src/hw_none.dart'
    if (dart.library.io) 'src/hw_io.dart'
    if (dart.library.html) 'src/hw_html.dart';

但是，由于在编译为 Wasm 时不支持 dart:html，因此现在正确的替代方法是使用 dart.library.js_interop 来区分原生和 Web

export 'src/hw_none.dart'
    if (dart.library.io) 'src/hw_io.dart'
    if (dart.library.js_interop) 'src/hw_web.dart';

dart:html 类支持虚拟分发，但是由于 JS 互操作使用扩展类型，因此无法实现虚拟分发。类似地，对 package:web 类型使用 dynamic 调用将不会按预期工作（或者，它们可能会侥幸继续工作，但在删除 dart:html 后将停止工作），因为它们的成员仅在静态情况下可用。迁移所有依赖虚拟分发的代码以避免此问题。

虚拟分发的一个用例是模拟。如果您有一个模拟类 implements 一个 dart:html 类，则它不能用于实现 package:web 类型。相反，最好模拟 JS 对象本身。有关更多信息，请参阅模拟教程。

dart:html 类也可能包含具有非平凡实现的 API。这些成员可能存在也可能不存在于 package:web 的helpers中。如果您的代码依赖于该实现的具体细节，您或许可以复制必要的代码。但是，如果您认为这不可行，或者该代码对其他用户也很有益，请考虑提交一个问题或上传一个拉取请求到 package:web 以支持该成员。

在 dart:html 中，回调会自动进行区域化。而 package:web 则不然。当前区域中没有回调的自动绑定。

如果这对您的应用程序很重要，您仍然可以使用区域，但您必须通过绑定回调来自己编写它们。有关更多详细信息，请参阅#54507。目前还没有可自动执行此操作的转换 API 或 helper。

package:web 的核心包含 external 互操作成员，但不提供 dart:html 默认提供的其他功能。为了缓解这些差异，package:web 包含helpers，以在处理许多无法通过核心互操作直接使用的用例时提供额外的支持。helper 库包含各种成员，用于公开 Dart Web 库中的一些旧版功能。

例如，核心 package:web 仅支持添加和删除事件侦听器。相反，您可以使用 stream helpers，它可以轻松地使用 Dart Stream 订阅事件，而无需自己编写该代码。

// dart:html version
InputElement htmlInput = InputElement();
await htmlInput.onBlur.first;

// package:web version
HTMLInputElement webInput = document.createElement('input') as HTMLInputElement;
await webInput.onBlur.first;

您可以在 package:web/helpers 的仓库中找到所有 helpers 及其文档。它们将不断更新，以帮助用户进行迁移并使其更容易使用 Web API。

以下是一些已从 dart:html 迁移到 package:web 的软件包示例

• 将 url_launcher 升级到 package:web

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