使用 CMake 创建 C++ 库

Question

我正在尝试创建一个合理的库结构和 CMake 文件，以允许其他 CMake 项目轻松包含此库。我发现了很多类似的问题，但是，它们似乎都没有解决我的确切问题。

我目前的结构如下：

/*MyLibrary/
├── CMakeLists.txt (including lib subdirectories)
├── external/
│   └── googletest/
├── lib/
│   ├── common/
│   │   ├── CMakeList.txt (creates static lib common)
│   │   ├── include/common/*.h
│   │   └── src/*.cpp
│   ├── cipher/
│   │   ├── CMakeList.txt (creates static lib cipher)
│   │   ├── include/cipher/*.h
│   │   └── src/*.cpp
└── test/
    ├── main.cpp (code for executing google test)
    ├── CMakeLists.txt (creates unittest executable)
    ├── common/*Test.cpp
    └── cipher/*Test.cpp
*/

现在我想创建一个具有类似目录结构的项目，但是当我想在该项目中创建一个与MyLibrary 中的静态库之一同名的静态库时出现问题（例如common )。

我正在考虑在项目 CMakeLists 中使用 add_subdirectory(external/MyLibrary) 将库包含到项目中，但由于静态库的名称冲突，因此失败了。

即使我通过重命名库来解决这个问题（我实际上并不认为这是一个优雅的解决方案），我最终还是会遇到 googletest 冲突，因为库和我的项目都依赖于 googletest。

有什么方法可以轻松解决这个问题吗？我在想两种可能性：

• 在 MyLibrary 中，我将从所有名为 libMyLibrary.a 的子库中创建一个静态库，并且只包含该库（首选选项，但我不知道如何在 CMake 中实现它)

• 强制库的用户安装它，并且不要将库作为项目子模块包含（我会选择的最后一个选项）

是否有其他合理的方法来解决它，使我的库与大多数 CMake 项目兼容？如果没有，我怎样才能至少实现上述选项之一？

简而言之：如何为库创建 CMake 文件，以便该库易于包含在其他 CMake 项目中？

如何处理 googletest 等冗余依赖项？

Answer 1

如何为库创建 CMake 文件，以便该库易于包含在其他 CMake 项目中？

没有为此目的的通用方法。

通过使用add_subdirectory() 将您的项目包含到另一个项目中，您可以将项目的内部“打开”给另一个项目。除了使库的目标准备好链接的优点之外，这种方法也有缺点。目标的碰撞、缓存变量的碰撞等问题都会让你头疼。

如果您希望通过add_subdirectory 将您的项目包含到其他项目中，请避免为您的目标使用“通用”名称。例如，使用<my_project_name>_common 而不是common。

一些你不能重命名的目标（比如gtest）。如果您的项目确实不需要这些目标，请创建一个禁用它们的选项：

option(<my_project_name>_TESTING "Enable testing" ON)
if(<my_project_name>_TESTING)
    add_subdirectory(external/googletest)
endif()

有关目标名称冲突的类似问题，另请参见 my answer。