WinUI 2 (UWP) 示例应用

此 WebView2 示例演示如何使用 WebView2 控件和 WebView2 API 在 WinUI 2 (UWP) 应用中实现 Web 浏览器。

  • 示例名称: webview2_sample_uwp
  • 存储库目录: webview2_sample_uwp
  • 解决方案文件: webview2_sample_uwp.sln

已安装的 NuGet 包

此示例包括以下 NuGet 包:

  • Microsoft.NETCore.UniversalWindowsPlatform
  • Microsoft.UI.Xaml - Prerelease - 包含 Microsoft.Web.WebView2 SDK 作为依赖项。

为了演示最新功能,WebView2Samples 存储库中的此示例设置为使用预发行版的 WinUI 2 SDK (在 NuGet 包管理器) 中列为 Microsoft.UI.Xaml ,而不是稳定版本。 WinUI 2 SDK 包含兼容版本的 WebView2 SDK,作为 Microsoft.UI.Xaml 的依赖项。

步骤 1 - 查看自述文件

  1. 在单独的窗口或选项卡中,在 GitHub: README 文件中简要读取此项目的呈现 README.md 文件,以便webview2_sample_uwp。 然后返回到此页面,并继续执行以下步骤。

    还可以在 Visual Studio 中查看 README.md 源文件 (未呈现的) 。 在文件管理器或 Visual Studio > 解决方案资源管理器中,打开该文件:

    <your-repos-directory>/WebView2Samples/SampleApps/webview2_sample_uwp/README.md

    或者:

    <your-repos-directory>/WebView2Samples-main/SampleApps/webview2_sample_uwp/README.md

步骤 2 - 安装 Visual Studio

Microsoft Visual Studio 是必需的。 此示例不支持 Microsoft Visual Studio Code。

  1. 如果 Visual Studio (尚未安装所需的最低版本) ,请在单独的窗口或选项卡中,请参阅在_为 WebView2 设置开发环境_时安装 Visual Studio。 按照该部分中的步骤操作,然后返回到此页并继续执行以下步骤。

步骤 3 - 安装 Microsoft Edge 的预览频道

  1. 如果尚未安装 Microsoft Edge (Beta、Dev 或 Canary) 的预览频道,请参阅在_为 WebView2 设置开发环境_时安装 Microsoft Edge 的预览频道。 按照该部分中的步骤操作,然后返回到此页并继续执行以下步骤。

步骤 4 - 下载或克隆 WebView2Samples 存储库

  1. 如果尚未完成,请将存储库下载或克隆 WebView2Sample 到本地驱动器。 在单独的窗口或选项卡中,请参阅“为 WebView2 设置开发环境”中的“下载 WebView2Samples 存储库”。 按照该部分中的步骤操作,然后返回到此页,然后继续下文。

步骤 5 - 在 Visual Studio 中打开解决方案

  1. 在本地驱动器上 .sln ,在 Visual Studio 中的目录中打开该文件:

    • <your-repos-directory>/WebView2Samples/SampleApps/webview2_sample_uwp/webview2_sample_uwp.sln

    或者:

    • <your-repos-directory>/WebView2Samples-main/SampleApps/webview2_sample_uwp/webview2_sample_uwp.sln

步骤 6 - 如果出现提示,请安装工作负载

  1. 如果出现提示,请安装请求的任何 Visual Studio 工作负载。 在单独的窗口或选项卡中,请参阅在_为 WebView2 设置开发人员环境_时安装 Visual Studio 工作负载。 按照该部分中的步骤操作,然后返回到此页,然后继续下文。

步骤 7 - 使用初始 NuGet 包生成和运行项目

解决方案资源管理器显示webview2_sample_uwp项目:

解决方案资源管理器在 Visual Studio 中打开的webview2_sample_uwp示例

使用存储库中的示例中安装的 NuGet 包的版本生成并运行项目:

  1. “解决方案配置” 下拉列表中,选择一个配置,例如 “调试”。

  2. “解决方案平台 ”下拉列表中,选择一个平台,例如 x64

    在 Visual Studio 顶部设置生成目标

  3. 解决方案资源管理器中,右键单击webview2_sample_uwp项目,然后选择 “生成”。

    项目生成。

  4. 选择 “调试 > 开始调试 ” () F5

    最初会出现一个空网格窗口:

    运行的webview2_sample_uwp项目,初始为空网格

    然后,示例应用窗口显示网页内容:

    运行webview2_sample_uwp项目,显示网页内容

  5. 在 Visual Studio 中,选择 “调试 > 停止调试”。 Visual Studio 关闭应用。

接下来,根据以下部分更新项目的 NuGet 包。

步骤 8 - 更新 NuGet 包

在此步骤中,我们将更新项目的 NuGet 包,以获取 WinUI 2 SDK 的最新预发行版本。 WinUI 2 SDK 包括兼容的 WebView2 SDK 预发行版或版本。

更新项目的 NuGet 包:

  1. 在 Visual Studio 中,在解决方案资源管理器中,右键单击webview2_sample_uwp项目 (而不是它上面的解决方案节点) ,然后选择 “管理 NuGet 包”。

    NuGet 包管理器面板在 Visual Studio 中打开。

  2. NuGet 包管理器中,单击 “已安装 ”选项卡。

  3. 选中 “包括预发行版 ”复选框。

    列出了 Microsoft.UI.Xaml 包的预发行版本,指示 WinUI 2 SDK。 Microsoft.UI.Xaml 包包括 WebView2 SDK;Microsoft.Web.WebView2Microsoft.UI.Xaml 包的 “依赖项”部分中列出。 更新 Microsoft.UI.Xaml 包也会导致对兼容的 WebView2 SDK 进行更新。

  4. NuGet 包管理器中,单击更新选项卡。

  5. 单击左侧的 Microsoft.UI.Xaml 卡。

  6. “版本” 文本框中,确保选择了 最新预发行 版。

  7. 单击右侧的 “更新” 按钮:

    要安装 Microsoft.UI.Xaml 的 NuGet 包管理器

    获取可能需要几分钟的最新包后,“ 预览更改 ”对话框将打开。 Microsoft.Web.WebView2 (WebView2 SDK) 分别列在 “预览更改 ”对话框中:

    用于安装 Microsoft.UI.Xaml 包的“预览更改”对话框

  8. 单击 “确定” 按钮。

  9. 将显示 “许可证接受 ”对话框:

    用于安装 Microsoft.UI.Xaml 包的“许可证接受”对话框

  10. 单击 “我接受 ”按钮。 在 Visual Studio 中,将显示该 readme.txt 文件,表示已安装 WinUI 包:

    安装 Microsoft.UI.Xaml 包后readme.txt文件,报告已安装 WinUI NuGet 包

    自述文件列出了一些类似于我们将添加的代码行。

  11. 使用类似的步骤更新 Microsoft.NETCore.UniversalWindowsPlatform NuGet 包。

    获取最新的 UWP 包(可能需要几分钟)后,将显示 “预览更改 ”对话框:

    用于安装 UWP 包的“预览更改”对话框

  12. 选择“全部保存****文件 > ”。

    现在,你已为项目安装了 Microsoft.UI.Xaml 包,它是 WinUI (WinUI 2) 。 检查生成的已安装包,如下所示:

  13. 在 NuGet 包管理器中,单击 “已安装 ”选项卡,并检查更新后的包:

    • Microsoft.NETCore.UniversalWindowsPlatform
    • Microsoft.UI.Xaml - 预发行版

    已更新的已安装包

  14. 关闭 NuGet 包管理器 窗口。

步骤 9 - 使用更新的包生成和运行项目

现在,NuGet 包已更新,请再次生成并运行项目:

  1. 解决方案资源管理器中,右键单击webview2_sample_uwp项目,然后选择 “生成”。

    项目生成。

  2. 选择 “调试 > 开始调试 ” () F5

    最初会出现一个空网格窗口:

    运行的webview2_sample_uwp项目,初始为空网格

    然后,示例应用窗口显示网页内容:

    运行webview2_sample_uwp项目,显示网页内容

  3. 在 Visual Studio 中,选择 “调试 > 停止调试”。 Visual Studio 关闭应用。

步骤 10 - 检查代码

  1. 在 Visual Studio 代码编辑器中,检查代码:

    Visual Studio 中的 MainPage.xaml

另请参阅