内容

使用 dart:html 库对浏览器进行编程、操作 DOM 中的对象和元素,以及访问 HTML5 API。DOM 代表文档对象模型,它描述了 HTML 页面的层次结构。

dart:html 的其他常见用途包括操作样式(CSS)、使用 HTTP 请求获取数据,以及使用 WebSocket 交换数据。HTML5(和 dart:html)还有许多本节未涵盖的其他 API。只有 Web 应用程序才能使用 dart:html,命令行应用程序不能使用。

要在 Web 应用程序中使用 HTML 库,请导入 dart:html

dart
import 'dart:html';

操作 DOM

#

要使用 DOM,您需要了解窗口文档元素节点

一个 Window 对象表示 Web 浏览器的实际窗口。每个 Window 都包含一个 Document 对象,该对象指向当前加载的文档。Window 对象还可以访问各种 API,例如 IndexedDB(用于存储数据)、requestAnimationFrame(用于动画)等。在标签式浏览器中,每个标签都有自己的 Window 对象。

使用 Document 对象,您可以在文档中创建和操作 Element 对象。请注意,文档本身是一个元素,可以对其进行操作。

DOM 对 Node 树进行建模。这些节点通常是元素,但它们也可以是属性、文本、注释和其他 DOM 类型。除了没有父节点的根节点之外,DOM 中的每个节点都有一个父节点,可能有多个子节点。

查找元素

#

要操作元素,您首先需要一个表示它的对象。您可以使用查询获取此对象。

使用顶级函数 querySelector()querySelectorAll() 查找一个或多个元素。你可以按 ID、类、标签、名称或这些的任意组合进行查询。CSS 选择器规范指南 定义了选择器的格式,例如使用 # 前缀指定 ID,使用句点 (.) 指定类。

querySelector() 函数返回与选择器匹配的第一个元素,而 querySelectorAll() 返回与选择器匹配的元素集合。

dart
// Find an element by id (an-id).
Element idElement = querySelector('#an-id')!;

// Find an element by class (a-class).
Element classElement = querySelector('.a-class')!;

// Find all elements by tag (<div>).
List<Element> divElements = querySelectorAll('div');

// Find all text inputs.
List<Element> textInputElements = querySelectorAll(
  'input[type="text"]',
);

// Find all elements with the CSS class 'class'
// inside of a <p> that is inside an element with
// the ID 'id'.
List<Element> specialParagraphElements = querySelectorAll('#id p.class');

操作元素

#

你可以使用属性更改元素的状态。Node 及其子类型 Element 定义了所有元素都具有的属性。例如,所有元素都具有 classeshiddenidstyletitle 属性,你可以使用这些属性设置状态。Element 的子类定义了其他属性,例如 AnchorElementhref 属性。

考虑在 HTML 中指定锚元素的这个示例

html
<a id="example" href="/another/example">link text</a>

这个 <a> 标签指定了一个带有 href 属性和一个文本节点(可通过 text 属性访问)的元素,该文本节点包含字符串“链接文本”。要更改链接指向的 URL,你可以使用 AnchorElement 的 href 属性

dart
var anchor = querySelector('#example') as AnchorElement;
anchor.href = 'https://dart.ac.cn';

你经常需要在多个元素上设置属性。例如,以下代码设置了所有具有“mac”、“win”或“linux”类的元素的 hidden 属性。将 hidden 属性设置为 true 与将 display: none 添加到 CSS 具有相同的效果。

html
<!-- In HTML: -->
<p>
  <span class="linux">Words for Linux</span>
  <span class="macos">Words for Mac</span>
  <span class="windows">Words for Windows</span>
</p>
dart
// In Dart:
const osList = ['macos', 'windows', 'linux'];
final userOs = determineUserOs();

// For each possible OS...
for (final os in osList) {
  // Matches user OS?
  bool shouldShow = (os == userOs);

  // Find all elements with class=os. For example, if
  // os == 'windows', call querySelectorAll('.windows')
  // to find all elements with the class "windows".
  // Note that '.$os' uses string interpolation.
  for (final elem in querySelectorAll('.$os')) {
    elem.hidden = !shouldShow; // Show or hide.
  }
}

当正确的属性不可用或不方便时,你可以使用 Element 的 attributes 属性。此属性是一个 Map<String, String>,其中键是属性名称。有关属性名称及其含义的列表,请参阅 MDN 属性页面。 以下是设置属性值的一个示例

dart
elem.attributes['someAttribute'] = 'someValue';

创建元素

#

你可以通过创建新元素并将其附加到 DOM 来添加到现有的 HTML 页面。以下是创建段落 (<p>) 元素的一个示例

dart
var elem = ParagraphElement();
elem.text = 'Creating is easy!';

你还可以通过解析 HTML 文本来创建元素。任何子元素也会被解析并创建。

dart
var elem2 = Element.html(
  '<p>Creating <em>is</em> easy!</p>',
);

请注意,在前面的示例中,elem2 是一个 ParagraphElement

通过向元素分配父元素来将新创建的元素附加到文档。可以将元素添加到任何现有元素的子元素中。在以下示例中,body 是一个元素,并且可以从 children 属性中访问其子元素(作为 List<Element>)。

dart
document.body!.children.add(elem2);

添加、替换和移除节点

#

请记住,元素只是一种节点。可以使用 Node 的 nodes 属性查找节点的所有子元素,该属性返回一个 List<Node>(与 children 相反,后者会省略非元素节点)。拥有此列表后,可以使用通常的列表方法和运算符来操作节点的子元素。

要将节点添加为其父元素的最后一个子元素,请使用列表 add() 方法

dart
querySelector('#inputs')!.nodes.add(elem);

要替换节点,请使用 Node replaceWith() 方法

dart
querySelector('#status')!.replaceWith(elem);

要删除节点,请使用 Node remove() 方法

dart
// Find a node by ID, and remove it from the DOM if it is found.
querySelector('#expendable')?.remove();

操作 CSS 样式

#

CSS 或层叠样式表定义了 DOM 元素的显示样式。可以通过向元素附加 ID 和类属性来更改其外观。

每个元素都有一个 classes 字段,它是一个列表。只需向此集合添加和删除字符串即可添加和删除 CSS 类。例如,以下示例将 warning 类添加到元素

dart
var elem = querySelector('#message')!;
elem.classes.add('warning');

通过 ID 查找元素通常非常有效。可以使用 id 属性动态设置元素 ID

dart
var message = DivElement();
message.id = 'message2';
message.text = 'Please subscribe to the Dart mailing list.';

可以使用方法级联来减少此示例中的冗余文本

dart
var message = DivElement()
  ..id = 'message2'
  ..text = 'Please subscribe to the Dart mailing list.';

虽然使用 ID 和类将元素与一组样式关联是最佳做法,但有时需要将特定样式直接附加到元素

dart
message.style
  ..fontWeight = 'bold'
  ..fontSize = '3em';

处理事件

#

要响应外部事件(例如点击、焦点更改和选择),请添加事件侦听器。可以将事件侦听器添加到页面上的任何元素。事件分派和传播是一个复杂的问题;研究详细信息,如果您不熟悉 Web 编程。

使用 element.onEvent.listen(function) 添加事件处理程序,其中 Event 是事件名称,function 是事件处理程序。

例如,以下是如何处理按钮上的点击

dart
// Find a button by ID and add an event handler.
querySelector('#submitInfo')!.onClick.listen((e) {
  // When the button is clicked, it runs this code.
  submitData();
});

事件可以在 DOM 树中向上和向下传播。要发现最初触发事件的元素,请使用 e.target

dart
document.body!.onClick.listen((e) {
  final clickedElem = e.target;
  // ...
});

要查看可以为其注册事件侦听器的所有事件,请在 Element 及其子类的 API 文档中查找“onEventType”属性。一些常见事件包括

  • 更改
  • 模糊
  • 按下键
  • 松开键
  • 按下鼠标
  • 松开鼠标

使用 HttpRequest 处理 HTTP 资源

#

应避免直接使用 dart:html 来进行 HTTP 请求。HttpRequest 类在 dart:html 中是平台相关的,并且与单一实现相关联。相反,请使用更高级别的库,如 package:http

从互联网获取数据 教程说明了如何使用 package:http 进行 HTTP 请求。

使用 WebSocket 发送和接收实时数据

#

WebSocket 允许您的 Web 应用与服务器交互式地交换数据,无需轮询。服务器创建 WebSocket 并侦听以 ws:// 开头的 URL 上的请求,例如 ws://127.0.0.1:1337/ws。通过 WebSocket 传输的数据可以是字符串或 blob。通常,数据是 JSON 格式的字符串。

要在您的 Web 应用中使用 WebSocket,首先创建一个 WebSocket 对象,将 WebSocket URL 作为参数传递

dart
var ws = WebSocket('ws://echo.websocket.org');

发送数据

#

要在 WebSocket 上发送字符串数据,请使用 send() 方法

dart
ws.send('Hello from Dart!');

接收数据

#

要在 WebSocket 上接收数据,请注册消息事件的侦听器

dart
ws.onMessage.listen((MessageEvent e) {
  print('Received message: ${e.data}');
});

消息事件处理程序接收 MessageEvent 对象。该对象的 data 字段包含来自服务器的数据。

处理 WebSocket 事件

#

您的应用可以处理以下 WebSocket 事件:open、close、error 和(如前所述)message。下面是一个创建 WebSocket 对象并为 open、close、error 和 message 事件注册处理程序的方法示例

dart
void initWebSocket([int retrySeconds = 1]) {
  var reconnectScheduled = false;

  print('Connecting to websocket');

  void scheduleReconnect() {
    if (!reconnectScheduled) {
      Timer(Duration(seconds: retrySeconds),
          () => initWebSocket(retrySeconds * 2));
    }
    reconnectScheduled = true;
  }

  ws.onOpen.listen((e) {
    print('Connected');
    ws.send('Hello from Dart!');
  });

  ws.onClose.listen((e) {
    print('Websocket closed, retrying in $retrySeconds seconds');
    scheduleReconnect();
  });

  ws.onError.listen((e) {
    print('Error connecting to ws');
    scheduleReconnect();
  });

  ws.onMessage.listen((MessageEvent e) {
    print('Received message: ${e.data}');
  });
}

更多信息

#

本节只是简单介绍了 dart:html 库的使用。有关更多信息,请参阅 dart:html 的文档。Dart 还有其他库用于更专业的 Web API,例如 Web 音频IndexedDBWebGL

有关 Dart Web 库的更多信息,请参阅 Web 库概览