迁移到 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 兼容性

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

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

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

在您的 pubspec 中的 dependencies 中添加 web

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 名称”。

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的帮助程序中。如果您的代码依赖于该实现的细节，您可能能够复制必要的代码。但是，如果您认为这不可行，或者如果该代码对其他用户也有益，请考虑提交问题或上传拉取请求到package:web以支持该成员。

在dart:html中，回调会自动进行区域化。在package:web中并非如此。当前区域中没有回调的自动绑定。

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

package:web的核心包含external交互成员，但没有提供dart:html默认提供的其他功能。为了减轻这些差异，package:web包含helpers，以便在处理许多无法通过核心交互直接获得的用例时提供额外的支持。帮助程序库包含各种成员，以公开 Dart Web 库中的一些遗留功能。

例如，核心package:web仅支持添加和删除事件监听器。相反，您可以使用流帮助程序，它使您可以轻松地使用 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中找到所有帮助程序及其文档。它们将持续更新，以帮助用户迁移并简化 Web API 的使用。

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

• 将url_launcher升级到package:web

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