QWebEngineUrlSchemeHandler Class

Detaillierte Beschreibung

Ein benutzerdefinierter Schema-Handler ist im Großen und Ganzen mit einer Webanwendung vergleichbar, die über HTTP ausgeliefert wird. Da benutzerdefinierte Schemata jedoch direkt in die Web-Engine integriert sind, haben sie den Vorteil, dass sie effizienter und sicherer sind: Es besteht keine Notwendigkeit, HTTP-Nachrichten zu generieren und zu parsen oder Daten über Sockets zu übertragen, und es gibt auch keine Möglichkeit, den Datenverkehr abzufangen oder zu überwachen.

Um ein benutzerdefiniertes URL-Schema für QtWebEngine zu implementieren, müssen Sie zunächst eine Instanz von QWebEngineUrlScheme erstellen und diese mit QWebEngineUrlScheme::registerScheme() registrieren.

Da benutzerdefinierte Schemata direkt in die Web-Engine integriert sind, müssen sie nicht unbedingt die Standard-Sicherheitsregeln befolgen, die für gewöhnliche Webinhalte gelten. Je nach gewählter Konfiguration können Inhalte, die über ein benutzerdefiniertes Schema bereitgestellt werden, Zugriff auf lokale Ressourcen erhalten, so eingestellt werden, dass sie Content-Security-Policy-Regeln ignorieren, oder umgekehrt, dass ihnen der Zugriff auf andere Inhalte vollständig verweigert wird. Wenn normale Inhalte darauf zugreifen sollen, stellen Sie sicher, dass der herkunftsübergreifende Zugriff aktiviert ist, und wenn der Zugriff über HTTPS erfolgt, dass er als sicher gekennzeichnet ist.

Dann müssen Sie eine Klasse erstellen, die von QWebEngineUrlSchemeHandler abgeleitet ist, und die Methode requestStarted() neu implementieren.

Schließlich installieren Sie das Schema-Handler-Objekt über QWebEngineProfile::installUrlSchemeHandler() oder QQuickWebEngineProfile::installUrlSchemeHandler().

class MySchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
    MySchemeHandler(QObject *parent = nullptr);
    void requestStarted(QWebEngineUrlRequestJob *job)
    {
        const QByteArray method = job->requestMethod();
        const QUrl url = job->requestUrl();

        if (isValidUrl(url)) {
            if (method == QByteArrayLiteral("GET"))
                job->reply(QByteArrayLiteral("text/html"), makeReply(url));
            else // Unsupported method
                job->fail(QWebEngineUrlRequestJob::RequestDenied);
        } else {
            // Invalid URL
            job->fail(QWebEngineUrlRequestJob::UrlNotFound);
        }
    }
    bool isValidUrl(const QUrl &url) const // ....
    QIODevice *makeReply(const QUrl &url) // ....
};

int main(int argc, char **argv)
{
    QWebEngineUrlScheme scheme("myscheme");
    scheme.setSyntax(QWebEngineUrlScheme::Syntax::HostAndPort);
    scheme.setDefaultPort(2345);
    scheme.setFlags(QWebEngineUrlScheme::SecureScheme);
    QWebEngineUrlScheme::registerScheme(scheme);

    // ...
    QApplication app(argc, argv);
    // ...

    // installUrlSchemeHandler does not take ownership of the handler.
    MySchemeHandler *handler = new MySchemeHandler(parent);
    QWebEngineProfile::defaultProfile()->installUrlSchemeHandler("myscheme", handler);
}