Qt WebChannel JavaScript API

设置 JavaScript API

要与QWebChannel或WebChannel通信，客户端必须使用并设置由qwebchannel.js. 对于在Qt WebEngine中运行的客户端，您可以通过qrc:///qtwebchannel/qwebchannel.js. 对于外部客户端，您需要将文件复制到您的 Web 服务器。然后实例化一个QWebChannel对象并传递给它一个传输对象和一个回调函数，一旦通道的初始化完成并且发布的对象变得可用，它们就会被调用。

传输对象实现了一个最小的消息传递接口。它应该是一个带有send()函数的对象，它接受一个字符串化的 JSON 消息并将其传输到服务器端QWebChannelAbstractTransport对象。此外，onmessage当收到来自服务器的消息时，应该调用它的属性。或者，您可以使用WebSocket来实现接口。

请注意，一旦传输对象完全可操作，就应该构造JavaScript QWebChannel对象。对于 WebSocket，这意味着您应该在套接字的处理程序中创建QWebChannelonopen。查看Qt WebChannel Standalone Example以了解这是如何完成的。

与 QObject 交互

一旦调用了传递给QWebChannel对象的回调，通道就完成了初始化，HTML 客户端可以通过该channel.objects属性访问所有发布的对象。因此，假设一个对象是使用标识符“foo”发布的，那么我们可以与它进行交互，如下例所示。请注意，HTML 客户端和 QML/C++ 服务器之间的所有通信都是异步的。属性缓存在 HTML 端。此外请记住，只有可以转换为 JSON 的 QML/C++ 数据类型才能正确（反）序列化，从而可供 HTML 客户端访问。

 new QWebChannel(yourTransport, function(channel) {
 
      // Connect to a signal:
      channel.objects.foo.mySignal.connect(function() {
          // This callback will be invoked whenever the signal is emitted on the C++/QML side.
          console.log(arguments);
      });
 
      // To make the object known globally, assign it to the window object, i.e.:
      window.foo = channel.objects.foo;
 
      // Invoke a method:
      foo.myMethod(arg1, arg2, function(returnValue) {
          // This callback will be invoked when myMethod has a return value. Keep in mind that
          // the communication is asynchronous, hence the need for this callback.
          console.log(returnValue);
      });
 
      // Read a property value, which is cached on the client side:
      console.log(foo.myProperty);
 
      // Writing a property will instantly update the client side cache.
      // The remote end will be notified about the change asynchronously
      foo.myProperty = "Hello World!";
 
      // To get notified about remote property changes,
      // simply connect to the corresponding notify signal:
      foo.onMyPropertyChanged.connect(function(newValue) {
          console.log(newValue);
      });
 
      // One can also access enums that are marked with Q_ENUM:
      console.log(foo.MyEnum.MyEnumerator);
  });

重载的方法和信号

当您发布QObject具有重载方法的方法时，QWebChannel会将方法调用解析为最佳匹配。请注意，由于 JavaScript 的类型系统，只有一个“数字”类型最适合映射到 C++“double”。当重载仅在类数字参数的类型上有所不同时，QWebChannel将始终选择最匹配 JavaScript 'number' 类型的重载。当您连接到重载信号时，QWebChannel客户端默认情况下将仅连接到该名称的第一个重载信号。此外，方法和信号的重载可以通过它们的完整QMetaMethod签名明确地请求。QObject假设我们在 C++ 端有以下子类：

 class Foo : public QObject
 {
     Q_OBJECT
 slots:
     void foo(int i);
     void foo(double d);
     void foo(const QString &str);
     void foo(const QString &str, int i);

 signals:
     void bar(int i);
     void bar(const QString &str);
     void bar(const QString &str, int i);
 };

然后你可以像这样在 JavaScript 端与这个类进行交互：

 // methods
 foo.foo(42); // will call the method named foo which best matches the JavaScript number parameter, i.e. foo(double d)
 foo.foo("asdf"); // will call foo(const QString &str)
 foo.foo("asdf", 42); // will call foo(const QString &str, int i)
 foo["foo(int)"](42); // explicitly call foo(int i), *not* foo(double d)
 foo["foo(QString)"]("asdf"); // explicitly call foo(const QString &str)
 foo["foo(QString,int)"]("asdf", 42); // explicitly call foo(const QString &str, int i)

 // signals
 foo.bar.connect(...); // connect to first signal named bar, i.e. bar(int i)
 foo["bar(int)"].connect(...); // connect explicitly to bar(int i)
 foo["bar(QString)"].connect(...); // connect explicitly to bar(const QString &str)
 foo["bar(QString,int)"].connect(...); // connect explicitly to bar(const QString &str, int i)