Visual Studio 2022构建时自动下载外部项目的方法

针对你需要在构建时自动拉取GitHub外部库的需求，以下是几个比git submodule更灵活的方案：

方案1：使用vcpkg（推荐） #

vcpkg是微软官方的C++包管理器，完美适配Visual Studio 2022，能自动从GitHub拉取源码并完成编译、链接：

• 先在本地安装vcpkg，执行vcpkg integrate install将其与Visual Studio关联
• 在项目根目录创建vcpkg.json，添加目标库的依赖（如果库不在vcpkg官方注册表，可直接指定git源）：

  {
    "dependencies": [
      {
        "name": "your-target-library",
        "source": {
          "type": "git",
          "url": "https://github.com/[用户名]/[仓库名].git",
          "branch": "main"
        }
      }
    ]
  }
  

• 后续构建项目时，vcpkg会自动检查依赖是否存在，不存在则下载、编译并关联到你的项目。协作电脑只需安装vcpkg，无需手动操作库的拉取。

方案2：MSBuild自定义构建任务 #

直接在VS项目的.vcxproj文件中添加前置构建步骤，通过PowerShell或curl实现自动下载：

• 打开项目的.vcxproj文件，在<Project>节点内添加以下内容：

  <Target Name="FetchExternalLibrary" BeforeTargets="Build">
    <!-- 配置库的下载地址和存放目录 -->
    <PropertyGroup>
      <LibraryZipUrl>https://github.com/[用户名]/[仓库名]/archive/refs/heads/main.zip</LibraryZipUrl>
      <LibraryRootDir>$(SolutionDir)external\your-library</LibraryRootDir>
      <TempZipPath>$(LibraryRootDir).zip</TempZipPath>
    </PropertyGroup>
    <!-- 创建存放目录 -->
    <MakeDir Directories="$(LibraryRootDir)" Condition="!Exists('$(LibraryRootDir)')" />
    <!-- 下载压缩包 -->
    <Exec Command="Invoke-WebRequest -Uri $(LibraryZipUrl) -OutFile $(TempZipPath)" Condition="!Exists('$(TempZipPath)')" />
    <!-- 解压到目标目录 -->
    <Exec Command="Expand-Archive -Path $(TempZipPath) -DestinationPath $(LibraryRootDir) -Force" Condition="Exists('$(TempZipPath)')" />
  </Target>
  

• 每次构建项目前，VS会自动执行这个任务，检查库是否存在，不存在则下载解压，适合简单的依赖场景。

方案3：CMake ExternalProject_Add（VS兼容） #

如果你熟悉CMake的工作流，Visual Studio 2022对CMake项目的支持非常完善，直接在CMakeLists.txt中使用ExternalProject_Add即可：

include(ExternalProject)

ExternalProject_Add(
  external_your_library
  GIT_REPOSITORY https://github.com/[用户名]/[仓库名].git
  GIT_TAG main  # 可指定分支、标签或commit hash
  SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/external/your-library
  BUILD_IN_SOURCE ON  # 如果库本身用CMake构建，可设置为OFF并指定BUILD_COMMAND
  INSTALL_COMMAND ""  # 不需要安装到系统目录
)

# 将外部库与你的项目关联
add_dependencies(your_main_project external_your_library)
target_link_libraries(your_main_project PRIVATE 
  ${CMAKE_CURRENT_SOURCE_DIR}/external/your-library/build/your-library.lib
)

• 打开CMake项目时，VS会自动运行CMake脚本，完成外部库的下载和构建，协作电脑只需配置好CMake环境即可。

方案4：自定义NuGet包 #

如果需要更严格的版本管理，可以将GitHub上的库打包成NuGet包：

• 创建.nuspec配置文件，可选择直接包含编译后的库文件，或指定git源码地址让NuGet自动拉取构建
• 将包发布到本地NuGet源或私有仓库，然后在Visual Studio中通过NuGet包管理器安装该依赖
• 构建时NuGet会自动处理依赖下载，适合需要多版本切换的场景

内容的提问来源于stack exchange，提问作者Eikeike