正文

如何用CMakeExternalProjectFetchContent轻松管理外部依赖源码编译与集成

/0 浏览量
0514

CMake 是一个跨平台的安装（编译）工具，它能够使用预编译的源码，也可以直接编译源码。在使用 CMake 进行项目开发时，经常会遇到需要集成外部依赖源码的情况。CMakeExternalProjectFetchContent 是一个 CMake 模块，它可以帮助我们轻松地管理外部依赖的源码编译与集成。下面，我将详细介绍一下如何使用 CMakeExternalProjectFetchContent。

1. 简介

CMakeExternalProjectFetchContent 是一个 CMake 模块，它允许你从一个外部源码仓库中获取源码，然后编译并集成到你的项目中。它支持多种外部源码管理工具，如 Git、SVN、Mercurial 等。

2. 安装 CMakeExternalProjectFetchContent

首先，你需要安装 CMakeExternalProjectFetchContent。你可以通过以下命令来安装：

cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX:PATH=/usr/local \
    https://github.com/chriswellington/cmake-externalproject-fetch-content.git

安装完成后，你可以在你的 CMakeLists.txt 文件中包含它：

include(FetchContent)
FetchContent_Declare(
  ExternalProjectFetchContent
  GIT_REPOSITORY https://github.com/chriswellington/cmake-externalproject-fetch-content.git
  GIT_TAG master
)
FetchContent_MakeAvailable(ExternalProjectFetchContent)

3. 使用 CMakeExternalProjectFetchContent

使用 CMakeExternalProjectFetchContent 的基本步骤如下：

3.1. 声明外部依赖

在你的 CMakeLists.txt 文件中，使用 FetchContent_Declare 命令声明外部依赖。你需要指定依赖的名称、源码仓库地址和分支。

FetchContent_Declare(
  MyDependency
  GIT_REPOSITORY https://github.com/your/repo.git
  GIT_TAG v1.0.0
)

3.2. 获取外部依赖

使用 FetchContent_Populate 命令获取外部依赖的源码。这个命令会创建一个名为 FetchContent_Source_<dependency_name> 的变量，其中包含了外部依赖的源码路径。

FetchContent_Populate(MyDependency)

3.3. 编译外部依赖

使用 ExternalProject_Add 命令编译外部依赖。你可以通过 BUILD_COMMAND 指定编译命令，或者通过 CMAKE_ARGS 指定编译选项。

ExternalProject_Add(
  MyDependency
  PREFIX ${CMAKE_BINARY_DIR}/MyDependency
  SOURCE_DIR ${FetchContent_Source_MyDependency}
  CMAKE_ARGS ...
  BUILD_COMMAND ...
  ...
)

3.4. 集成外部依赖

在编译你的项目时，CMake 会自动编译外部依赖，并将其集成到你的项目中。

4. 示例

以下是一个使用 CMakeExternalProjectFetchContent 集成第三方库的示例：

FetchContent_Declare(
  MyDependency
  GIT_REPOSITORY https://github.com/your/repo.git
  GIT_TAG v1.0.0
)

FetchContent_Populate(MyDependency)

ExternalProject_Add(
  MyDependency
  PREFIX ${CMAKE_BINARY_DIR}/MyDependency
  SOURCE_DIR ${FetchContent_Source_MyDependency}
  CMAKE_ARGS ...
  BUILD_COMMAND ...
  ...
)

add_library(MyProject MyProject.cpp)
target_link_libraries(MyProject MyDependency::MyDependency)

在这个示例中，我们声明了一个名为 MyDependency 的外部依赖，然后获取并编译了它的源码。最后，我们将编译好的库链接到了我们的项目 MyProject。

5. 总结

使用 CMakeExternalProjectFetchContent 可以轻松地管理外部依赖的源码编译与集成。通过以上步骤，你可以快速地将外部依赖集成到你的项目中，提高开发效率。

-- 展开阅读全文 --