CMake 中集成 NuGet 包：构建 WinUI3 桌面应用

2024-10-01 04:21:15

在使用 CMake 构建 C++ WinUI3 桌面应用程序时，你可能会遇到 NuGet 包管理方面的问题。WinUI3 项目通常依赖于一些 NuGet 包来提供各种功能，例如 UI 控件、网络通信等等。而 CMake 本身并不直接支持 NuGet 包管理，这给开发者带来了一些挑战。

本文将介绍如何在 CMake 项目中集成 NuGet 包，并提供一些解决方案，帮助你解决这个问题。

问题分析

CMake 是一个跨平台的构建系统，它使用 CMakeLists.txt 文件来项目的构建过程。而 NuGet 是 Windows 平台下的包管理系统，它使用 package.config 文件或 packages.lock.json 文件来管理项目的依赖项。

当你在 Visual Studio 中创建 WinUI3 项目时，Visual Studio 会自动生成 package.config 或 packages.lock.json 文件，并使用 MSBuild 来管理 NuGet 包。但是，当你使用 CMake 构建 WinUI3 项目时，CMake 并不会自动识别这些文件，你需要手动处理 NuGet 包的下载、安装和链接。

解决方案

以下是一些在 CMake 项目中集成 NuGet 包的解决方案：

1. 使用 FetchContent 模块下载 NuGet 包

CMake 的 FetchContent 模块可以用来下载外部项目或文件。你可以使用它来下载 NuGet 包的源代码或预编译二进制文件。

首先，你需要找到 NuGet 包的下载地址。你可以在 NuGet 官网或包的 GitHub 仓库中找到下载链接。

然后，在你的 CMakeLists.txt 文件中，使用 FetchContent_Declare 命令声明要下载的包：

FetchContent_Declare(
  MyPackage
  URL https://example.com/MyPackage.zip
)

接着，使用 FetchContent_MakeAvailable 命令下载并解压包：

FetchContent_MakeAvailable(MyPackage)

最后，将下载的包链接到你的项目中：

target_link_libraries(MyProject MyPackage)

2. 使用 vcpkg 管理 NuGet 包

vcpkg 是一个跨平台的 C++ 包管理器，它可以用来管理 NuGet 包和其他 C++ 库。

首先，你需要安装 vcpkg。你可以在 vcpkg 的 GitHub 仓库中找到安装说明。

然后，使用 vcpkg install 命令安装所需的 NuGet 包：

vcpkg install MyPackage

vcpkg 会自动下载并安装包，并将其集成到你的 CMake 项目中。你只需要在 CMakeLists.txt 中使用 find_package 找到对应的包即可。

3. 使用 CMake 的 ExternalProject 模块

ExternalProject 模块可以用来管理外部项目的构建过程。你可以使用它来构建 NuGet 包的源代码，并将其链接到你的项目中。

首先，你需要找到 NuGet 包的源代码地址。你可以在 NuGet 官网或包的 GitHub 仓库中找到源代码链接。

然后，在你的 CMakeLists.txt 文件中，使用 ExternalProject_Add 命令添加外部项目：

ExternalProject_Add(
  MyPackage
  URL https://github.com/MyPackage/MyPackage.git
  CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/MyPackage
)

接着，使用 add_dependencies 命令将外部项目的构建过程添加到你的项目的构建过程中：

add_dependencies(MyProject MyPackage)

最后，将构建好的外部项目链接到你的项目中：

target_include_directories(MyProject PRIVATE ${CMAKE_BINARY_DIR}/MyPackage/include)
target_link_libraries(MyProject PRIVATE ${CMAKE_BINARY_DIR}/MyPackage/lib/MyPackage.lib)

4. 手动下载和安装 NuGet 包

你也可以手动下载 NuGet 包，并将其安装到你的项目中。

首先，你需要下载 NuGet 包的源代码或预编译二进制文件。

然后，将下载的文件解压到你的项目目录中。

最后，在你的 CMakeLists.txt 文件中，将包的 include 目录添加到 include_directories 命令中，并将包的库文件添加到 target_link_libraries 命令中。

示例：使用 `FetchContent` 集成 Newtonsoft.Json 包

假设你的项目需要使用 Newtonsoft.Json 包，你可以使用 FetchContent 模块来下载并集成它。

首先，在你的 CMakeLists.txt 文件中，添加以下代码：

include(FetchContent)

FetchContent_Declare(
  NewtonsoftJson
  URL https://www.nuget.org/api/v2/package/Newtonsoft.Json/13.0.1
)

FetchContent_MakeAvailable(NewtonsoftJson)

target_include_directories(MyProject PRIVATE ${NewtonsoftJson_SOURCE_DIR}/include)
target_link_libraries(MyProject PRIVATE ${NewtonsoftJson_SOURCE_DIR}/lib/native/release/Newtonsoft.Json.lib)

这段代码会下载 Newtonsoft.Json 包，并将其 include 目录和库文件添加到你的项目中。