HoloLens 2 Unity 应用中的 WebView2

本文面向在沉浸式HoloLens 2 Unity应用程序中使用 WebView2 的开发人员。

重要

Hololens 2 上的 WebView2 继续可用。 但是,已停止对 Hololens 2 上的 WebView2 的支持;没有计划的 bug 修复或内容更新,并且技术支持已结束。 在 Hololens 2 上使用 WebView2 的应用程序不能保证继续工作。

HoloLens 2 上的 WebView2 和用于Unity的 WebView 插件均处于预览状态,在正式发布之前可能会更改。

WebView2 仅适用于运行Windows 11更新HoloLens 2设备。 有关详细信息,请参阅更新HoloLens 2。

有关HoloLens 2上已启用 WebView2 的 2D 应用程序,请参阅 WinUI 2 (UWP) 应用中的 WebView2 入门。

限制和已知问题

使用 WebView2 开发HoloLens 2 Unity应用时,请注意一些限制和已知问题:

  • 弹出窗口:弹出窗口在 HoloLens 2 Unity 应用中的 WebView2 中无法正常工作,但它们在设备上的 2D XAML 应用中工作正常。 避免弹出窗口,并使用替代技术或 UI 设计,例如使用 HTML、CSS 和 JavaScript 的 WebView 中的自定义类似弹出窗口的元素。

  • 新窗口:HoloLens 2上的 WebView2 实例默认在同一窗口中导航,这与桌面上的不同。 请遵循此默认行为来获得更好的用户体验。 此外,无法启动 DevTools 窗口。

  • 企业身份验证:HoloLens 2上的 WebView2 目前不支持利用 OS 级令牌的自动单 Sign-On (SSO) 。 用户仍可以通过提供凭据登录,但需要设备级身份验证的情况除外。 Cookie 存储按预期工作。

  • 用户交互:与本机HoloLens 2板不同,WebView2 最好使用远距交互手部射线进行交互。 可能不支持轻扫触摸和滚动交互。

  • 性能:大量使用 JavaScript 或高级渲染的复杂网站可能会影响系统性能或主机应用程序的帧速率。 有关与性能相关的一般限制和建议,请参阅 混合现实文档中的了解 混合现实的性能。 另请参阅下面的 性能优化。

性能优化

优化 HoloLens 2 Unity 应用中 WebView2 的性能对于流畅的用户体验至关重要。 下面是一些建议:

  • 限制 WebView2 实例的数量:建议在Unity应用中仅使用一个 WebView2 实例。 重复使用同一实例或根据需要将其删除并创建一个新实例。 请记住,从场景中删除 WebView prefab 可能不会破坏基础 WebView2 实例。 必须对游戏对象调用 Destroy() 方法才能正确销毁它。

  • 应用常规Unity优化技术:若要优化 WebView2 性能,请使用标准Unity优化方法,例如遮挡剔除或限制更新速率。 有关详细信息,请参阅混合现实文档中Unity的性能建议。

  • 分析并监视 WebView2 性能:可通过多种方式分析HoloLens 2 Unity应用程序的性能:

    • Unity Profiler:Unity中的内置工具,可用于测量和优化各种平台上的应用程序性能,包括HoloLens 2。

    • 可视探查器:混合现实工具包的一项功能,可提供应用程序性能的应用程序内视图。

    • PIX:适用于 Windows 的性能优化和调试工具,也可用于分析HoloLens 2上的Unity应用程序。

HoloLens 2 Unity 应用中的 WebView2 入门中的步骤 7 - 扩展 WebView2 功能 (预览版) 中演示了一些导航方法。 本部分对该演示进行了扩展。

另请参阅:

IWebView 接口

接口 IWebView 公开与页面导航相关的一些方法、事件和属性。 此处公开的主要功能是使用 导航到给定 URL Load(Uri url)的功能:

public interface IWebView
{
    // Non-navigation methods are removed for clarity.

    event WebView_OnNavigated Navigated;

    Uri Page { get; }

    void Load(Uri url);

    void Reload(bool ignoreCache);
}

IWithBrowserHistory 接口

接口 IWithBrowserHistory 公开与页面导航相关的一些方法和事件。 这主要允许开发人员向前和向后导航,就像你期望的典型 Web 浏览体验一样:

public interface IWithBrowserHistory : IWebView
{
    // Non-navigation methods are removed for clarity.

    event WebView_OnCanGoForwardUpdated CanGoForwardUpdated;

    event WebView_OnCanGoBackUpdated CanGoBackUpdated;

    void GoBack();

    void GoForward();
}

SetVirtualHostNameToFolderMapping 和 SetVirtualHostMapping

CoreWebView2.SetVirtualHostNameToFolderMapping 方法启用虚拟主机名和文件夹路径之间的映射,使使用该主机名的网站可以访问它。 此方法将本地域名映射到本地文件夹,以便 WebView2 控件在尝试访问该域的资源时从指定的本地文件夹加载内容。

用于Unity的 WebView 插件通过 IWithVirtualHost 接口公开此功能,该接口具有一个方法SetVirtualHostMapping(string hostName, string folderPath):

public interface IWithVirtualHost : IWebView
{
    void SetVirtualHostMapping(string hostName, string folderPath);
}

若要使用 SetVirtualHostMapping 方法,请将 设置为 hostName 任何有效的 URL 一致性字符串,例如 webview2.sample。 folderPath 可以是绝对路径或相对于应用程序的工作目录的路径,例如 Assets\Html。

假设我们在 下Assets\Html有一个名为 的 demo.html HTML 文件,以下代码片段演示了使用 webView 插件进行Unity加载demo.html:

using Microsoft.MixedReality.WebView;

public class WebViewExample : MonoBehaviour
{
    private void Start()
    {
        var webViewComponent = gameObject.GetComponent<WebView>();

        webViewComponent.GetWebViewWhenReady((IWebView webView) =>
        {
            ((IWithVirtualHost)webView).SetVirtualHostMapping("webview2.sample", "Assets\\Html");

            // Navigate to our local content.
            webViewComponent.Load(new Uri("http://webview2.sample/demo.html"));
        });
    }
}

Input

有多种方法可用于处理混合现实应用程序的Unity中的输入。

无论在 Unity 应用程序中使用哪种输入系统,都需要各种应用程序输入事件和用于Unity的 WebView 插件之间的互作代码。 这意味着将这些事件 ((例如指针事件) )转换为 WebViewMouseEventData 对象,然后通过 IWithMouseEvent 接口将这些事件转发到插件:

public interface IWithMouseEvents : IWithInputEvents
{
    void MouseEvent(WebViewMouseEventData mouseEvent);
}

WebView2 不知道Unity的输入系统,并且其坐标系可能与Unity场景不同。 因此,当存在指针向下事件时,其坐标必须转换为 WebView2 控件的坐标系。 此外,需要将指针关闭事件转换为适当的 WebViewMouseEventData 事件类型。

简单示例:

using Microsoft.MixedReality.WebView;

public class WebViewExample : MonoBehaviour, IPointerDownHandler
{
    // WebView setup steps skipped for brevity

    public void OnPointerDown(PointerEventData eventData)
    {
        IWithMouseEvents mouseEventsWebView = webView as IWithMouseEvents;

        // Call hypothetical function which converts the event's x, y into the WebView2's coordinate space.
        var hitCoord = ConvertToWebViewSpace(eventData.position.x, eventData.position.y);

        WebViewMouseEventData mouseEvent = new WebViewMouseEventData
        {
            X = hitCoord.x,
            Y = hitCoord.y,
            Type = WebViewMouseEventData.EventType.MouseDown,
            Button = WebViewMouseEventData.MouseButton.ButtonLeft,
            TertiaryAxisDeviceType = WebViewMouseEventData.TertiaryAxisDevice.PointingDevice
        };

        // Propagate the event to the WebView plugin.
        mouseEventsWebView.MouseEvent(mouseEvent);
    }
}

在上面的示例中,指针向下事件将转换为WebViewMouseEventData对象并转发到 WebView 插件,以便Unity。 它实质上已转换为鼠标按下事件。 若要创建鼠标单击事件,需要以类似的方式处理指针向上事件。

在上面的示例中, ConvertToWebViewSpace 故意未实现。

另请参阅

API 参考:

Hololens 文档:

混合现实文档:

Unity文档: