如何使用 QJSEngine 构建 API

我从Qt开始，我的一个项目是使用QJSEngine来评估javascript，我想为脚本提供一个完整的API，包括类和全局函数。

现在我的程序只提供 ECMAScript 默认的东西(eval、encodeURI、parseInt 等(，但我需要向代码公开一些自定义类，比如浏览器 API(WebSocket 类、Image 类、文档对象(。例如：

var obj = new CustomClass("", 0);
var ret = obj.customClassMethod("[...]!");
customFunction(ret);

我需要在C++中定义类的行为，它无助于评估类定义并让用户代码运行。

与 QScriptEngine 相反，如果自定义类使用 Q_SCRIPT_DECLARE_QMETAOBJECT 宏从QObject继承，则可以添加自定义类，QJSEngine不直接提供此功能。

您仍然可以使用 Qt Meta-object 系统为 Javascript 提供接口，但您必须在 C++ 中实例化对象并将其添加到 Javascript 上下文中。然后它的插槽、用Q_INVOKABLE定义的方法和用Q_PROPERTY定义的属性都可以从 Javascript 运行时中访问。

现在，您可以创建一个工厂，该工厂为包装为 Javascript 对象的给定QJSEngine创建自定义类CustomClass的实例：

class CustomClassFactory : public QObject
{
    Q_OBJECT
public:
  CustomClassFactory(QJSEngine* engine) : m_engine(engine) {}
  Q_INVOKABLE QJSValue createInstance() {
      // The engine takes ownership and destroys the object if no longer required.
      return m_engine->newQObject(new CustomClass());
  }
private:
    QJSEngine* m_engine;
}

需要构造一个工厂实例并将其添加到 Javascript 运行时的全局对象中：

QJSEngine engine;
QJSValue factoryObj = engine.newQObject(new CustomClassFactory());
engine.globalObject().setProperty("_customClassFactory", factoryObj);

现在我们可以用 Javascript 构造对象：

var obj = _customClassFactory.createInstance()

到目前为止，让我们另外将自定义类的构造函数注入到 Javascript 运行时中：

QJSEngine engine;
// Again, the QJSEngine will take ownership of the created object.
QJSValue factoryObj = engine.newQObject(new CustomClassFactory());
engine.globalObject().setProperty("_customClassFactory", factoryObj);
engine.evaluate(
    "function CustomClass() {"
    "    return _customClassFactory.createInstance()"
    "}");

瞧，现在你可以在Javascript中构造C++对象，就像自定义Javascript类一样：

var obj = new CustomClass()

对于上述WebSocket API，您可以为此目的包装QtWebSocket - 这正是我在提出建议方法时所需要的。

请注意，为了简单起见，

我省略了构造函数的参数，但也可以简单地添加它们。

PS：我会在官方文档中添加更多链接，但由于缺乏声誉，我不允许这样做。

在Qt 5.8中，QJSEngine中添加了一个新功能：newQMetaObject

您只需添加静态元对象，例如使用上述函数&MyQObjectDerivedClass::staticMetaObject JSEngine。

然后，您将能够从 QML 中new Javascript 中的这些对象。我发现这是一个非常简洁的解决方案。

正如文档所说，您必须将构造函数标记为Q_INVOKABLE否则您将无法实例化类的对象。

属性系统(二传手/getter(与插槽一样按预期工作。

https://doc.qt.io/qt-5/qjsengine.html#newQMetaObject

这是我的测试代码 - 首先是添加元对象的C++部分

QQmlApplicationEngine engine;
QJSValue jsMetaObject = engine.newQMetaObject(&MyClassOfObject::staticMetaObject);
engine.globalObject().setProperty("MyClassOfObject", jsMetaObject);

我现在可以编写news该类型对象的 JS 并使用 setter/getter 等。此代码实际上存在于用于手动测试的鼠标区域单击处理程序中。

var bob = new MyClassOfObject();
print(bob.x);
bob.x = 918264;
print(bob.x);
print(bob.words);

这是类定义...

class MyClassOfObject : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int x READ getX WRITE setX)
    Q_PROPERTY(int y READ getY WRITE setX)
    Q_PROPERTY(QStringList words READ getWords)    
public:
    Q_INVOKABLE explicit MyClassOfObject(QObject *parent = nullptr);
public slots:
    int getX() const { return x; }
    int getY() const { return y; }
    void setX(int x) { this->x = x; }
    void setY(int y) { this->y = y; }
    QStringList getWords() const;
private:
    int x = -113;
    int y = 616;
    QStringList stringList;
};

从 Qt5.5 开始，QScriptEngine已被弃用，因此将来只应使用QJsEngine。https://wiki.qt.io/New_Features_in_Qt_5.5#Deprecated_Functionality

如果您查找 QScriptEngine 的文档，或者通过搜索"QScriptEngine 示例"，您可以找到一些有关使自定义C++类可用于 QScriptEngine 的内容。

这是一个很好的起点：链接到示例

QScriptEngine 与 QJsEngine 非常相似，所以它对你来说应该不是一个大问题。

希望这对:)有所帮助

相关内容

最新更新

热门标签：