如何模拟 JavaScript 互操作对象

背景和动机
模拟示例
@JSExport 和 createJSInteropWrapper

在本教程中，你将学习如何模拟 JS 对象，以便你可以测试互操作实例成员，而无需使用真实的实现。

通常通过覆盖实例成员来完成在 Dart 中模拟类。但是，由于扩展类型用于声明互操作类型，所有扩展类型成员都是静态调度的，因此不能使用覆盖。这个限制对于扩展成员也是如此，因此不能模拟实例扩展类型或扩展成员。

虽然这适用于任何非 external 扩展类型成员，但 external 互操作成员是特殊的，因为它们会调用 JS 值上的成员。

dartextension type Date(JSObject _) implements JSObject {
  external int getDay();
}

正如在用法部分讨论的那样，调用 getDay() 将导致在 JS 对象上调用 getDay()。因此，通过使用不同的 JSObject，可以调用 getDay 的不同实现。

为了做到这一点，应该有一些机制来创建一个具有属性 getDay 的 JS 对象，当调用该属性时，会调用一个 Dart 函数。一个简单的方法是创建一个 JS 对象并将属性 getDay 设置为转换后的回调，例如：

dartfinal date = Date(JSObject());
date['getDay'] = (() => 0).toJS;

虽然这种方法可行，但它容易出错，并且在您使用许多互操作成员时无法很好地扩展。它也无法正确处理 getter 或 setter。相反，您应该结合使用 createJSInteropWrapper 和 @JSExport 来声明一个为所有 external 实例成员提供实现的类型。

dartimport 'dart:js_interop';

import 'package:expect/minitest.dart';

// The Dart class must have `@JSExport` on it or at least one of its instance
// members.
@JSExport()
class FakeCounter {
  int value = 0;
  @JSExport('increment')
  void renamedIncrement() {
    value++;
  }
  void decrement() {
    value--;
  }
}

extension type Counter(JSObject _) implements JSObject {
  external int value;
  external void increment();
  void decrement() {
    value -= 2;
  }
}

void main() {
  var fakeCounter = FakeCounter();
  // Returns a JS object whose properties call the relevant instance members in
  // `fakeCounter`.
  var counter = createJSInteropWrapper<FakeCounter>(fakeCounter) as Counter;
  // Calls `FakeCounter.value`.
  expect(counter.value, 0);
  // `FakeCounter.renamedIncrement` is renamed to `increment`, so it gets
  // called.
  counter.increment();
  expect(counter.value, 1);
  expect(fakeCounter.value, 1);
   // Changes in the fake affect the wrapper and vice-versa.
  fakeCounter.value = 0;
  expect(counter.value, 0);
  counter.decrement();
  // Because `Counter.decrement` is non-`external`, we never called
  // `FakeCounter.decrement`.
  expect(counter.value, -2);
}

@JSExport 允许您声明一个可以在 createJSInteropWrapper 中使用的类。createJSInteropWrapper 将创建一个对象字面量，该字面量将类的每个实例成员名称（或重命名）映射到 JS 回调，该回调使用 Function.toJS 创建。当调用时，JS 回调反过来会调用实例成员。在上面的示例中，获取和设置 counter.value 会获取和设置 fakeCounter.value。

您可以通过省略类中的注释，而仅对特定成员进行注释来指定仅导出类的一些成员。您可以在 @JSExport 的文档中查看更多关于更专业导出的详细信息（包括继承）。

请注意，这种机制并非仅限于测试。您可以使用它为任意 Dart 对象提供 JS 接口，从而允许您使用预定义的接口将 Dart 对象导出到 JS。

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

如何模拟 JavaScript 互操作对象

背景和动机

模拟示例

@JSExport 和 createJSInteropWrapper

`@JSExport` 和 `createJSInteropWrapper`