Qt WebEngine 平颱注意事項

從源代碼構建 Qt WebEngine

靜態構建不被支持。

The requirements for building Qt modules from source are listed separately for each supported platform:

此外,需要以下工具為構建 Qt WebEngine 模塊:

所有平颱

On all platforms, the following tools are required at build time:

  • C++20 compiler support
  • CMake 3.19 or newer
  • Python 3 with html5lib library
  • Bison, Flex
  • GPerf
  • Node.js version 14 or later

Windows

在 Windows,需要以下額外工具:

  • Visual Studio 2019 or later, or clang-cl version 10 or later
  • ATL (活動模闆庫),通常包括在 Visual Studio 安裝中
  • Windows 11 SDK version 10.0.22621.0 or later

注意: It is not recommended to use tools from msys2 or cygwin to build Qt WebEngine as it may result in build errors.

Linux

On Linux, Clang or GCC version 10 or later is required.

Qt WebEngine 要求 pkg-config 以檢測其大多數依賴。以下 pkg-config 文件要求:

  • dbus-1
  • fontconfig

若 Qt 被配置為 xcb ,以下 pkg-config 文件也是必需的:

  • libdrm
  • xcomposite
  • xcursor
  • xi
  • xrandr
  • xscrnsaver
  • xtst

macOS

在 macOS,需要以下:

  • macOS 10.14 or later
  • Xcode 12.0 or later
  • macOS 11 SDK or later

注意: 無法為 macOS 的 32 位模式構建 Qt WebEngine (使用 macx-clang-32 mkspec ).

使用早期 Qt 版本構建 Qt WebEngine

Building Qt WebEngine with earlier Qt versions (down to the last LTS version) is supported. It means that Qt WebEngine 6.4 can be built with Qt 6.2.x, Qt 6.3.x, and Qt 6.4.

要使用早期 Qt 版本構建 Qt Webengine:

  1. 下載 qtwebengine 源代碼。
  2. 從早期 Qt 版本運行 qmake && make (&& make install) .

Mac APP 商店兼容性

Applications using Qt WebEngine are not compatible with the Mac App Store, because:

  • The Chromium part of the code uses several private API methods, which are prohibited by the App Store.
  • Applications submitted to the App Store must be code-signed with the App Sandbox feature enabled. The App Sandbox feature interferes with Chromium's own sandbox initialization, which results in Chromium not being properly initialized. This also ties in with the private API usage. Furthermore, standalone Chromium itself is not officially tested with the App Sandbox enabled, and even if work is done to bypass the App Store's restrictions, that would not guarantee correct behavior of the library.

支持帶雙 GPU 的 MacBook macOS Airplay

To make Qt WebEngine work correctly when streaming to an AppleTV from a MacBook that supports GPU switching, it is important to add the NSSupportsAutomaticGraphicsSwitching option to the application Info.plist file, with the value set to YES . Otherwise rendering issues might occur when creating new web engine view instances after Airplay is switched on or off.

默認支持 QSurfaceFormat OpenGL Profile (配置文件)

If a new default QSurfaceFormat with a modified OpenGL profile has to be set, it should be set before the application instance is declared, to make sure that all created OpenGL contexts use the same OpenGL profile.

On macOS, if the default QSurfaceFormat is set after the application instance, the application will exit with qFatal (), and print a message that the default QSurfaceFormat should be set before the application instance.

沙盒支持

Qt WebEngine 為 Chromium 渲染過程提供開箱即用的沙盒支持。

在 Linux,注意以下限定:

  • 內核必須支持匿名名稱空間特徵 (內核版本 3.8 或更高版本)。不管怎樣,在 Debian、Ubuntu 且其它 Debian 派生分發,此特徵是關閉的默認情況下。可以打開它通過設置 /proc/sys/kernel/unprivileged_userns_clone 到 1。
  • 內核必須支持 seccomp-bpf 特徵 (內核版本 3.5 或更高版本)。
  • Setuid 沙盒不受支持,因此被禁用。

要明確禁用沙盒,使用以下選項之一:

  • 設置 QTWEBENGINE_DISABLE_SANDBOX 環境變量到 1。
  • 傳遞 --no-sandbox 命令行自變量,給用戶應用程序可執行文件。
  • Set QTWEBENGINE_CHROMIUM_FLAGS to --no-sandbox .

更多信息,見 使用命令行參數 .

Docker 環境下的內存需求

當在 Docker 容器中運行 Qt WebEngine 範例並瀏覽內容繁重站點時,可能報告 BUS 錯誤 (SIGBUS)。通常,這是由於 Docker 運行過小內存空間 (譬如 64MB) 容器導緻的。要修復此問題,增加內存空間大小。

可訪問性和性能

Qt WebEngine enables accessibility support for web pages when the following conditions are met:

  • Qt Core is configured and built with accessibility support enabled.
  • The QPA plugin is notified by the operating system that accessibility should be activated. This happens for example when using a screen reader application on Windows or VoiceOver on macOS.

On some old Linux configurations, accessibility can cause a significant slowdown on large HTML pages.

Because of that, Qt WebEngine accessibility support can be disabled on Linux, by setting the QTWEBENGINE_ENABLE_LINUX_ACCESSIBILITY environment variable to 0.

Windows 全屏應用程序中的彈齣窗口

Because of a limitation in the Windows compositor, applications that show a fullscreen web engine view will not properly display popups or other top-level windows. The reason and workaround is described in 基於 OpenGL 的窗口全屏 .

Windows Application Manifest

A manifest is an XML file that is read when the program starts and informs Windows how to run the program. Some Qt WebEngine features may require adding a manifest file for the user application to work correctly on Windows.

The following snippets show the manifest file's structure and how to embed it into the program.

注意: These code snippets are taken from the WebEngine Quick 納米瀏覽器 範例。

The manifest file defines which Windows versions the application supports. httpUserAgent needs this information to report the correct Windows version.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
    <application>
    <!--The ID below indicates application support for Windows Vista -->
    <supportedOS Id="{e2011457-1546-43c5-a5fe-008deee3d3f0}"/>
    <!--The ID below indicates application support for Windows 7 -->
    <supportedOS Id="{35138b9a-5d96-4fbd-8e2d-a2440225f93a}"/>
    <!--The ID below indicates application support for Windows 8 -->
    <supportedOS Id="{4a2f28e3-53b9-4441-ba9c-d69d4a4a6e38}"/>
    <!--The ID below indicates application support for Windows 8.1 -->
    <supportedOS Id="{1f676c76-80e1-4239-95bb-83d0f6d0da78}"/>
    <!--The ID below indicates application support for Windows 10/11 -->
    <supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}"/>
    </application>
</compatibility>
</assembly>
					

To embed the file into the executable, add it to the sources:

    ...
qt_add_executable(quicknanobrowser
    main.cpp
    utils.h
)
if(WIN32)
    set_property(
        TARGET quicknanobrowser
        APPEND PROPERTY
            SOURCES quicknanobrowser.exe.manifest)
endif()
    ...
					

更多信息,見 Application manifest documentation page .