在Conan中打包和复用CMake函数模块的最佳实践

背景介绍

在现代C++项目中，我们经常需要编写一些通用的CMake函数来简化构建过程。这些函数可能包括设置编译器标志、添加测试目标、配置代码生成等实用功能。传统做法是将这些函数直接放在项目代码库中，但随着项目规模扩大和多项目共享需求增加，更好的做法是将这些CMake函数模块化并打包分发。

项目结构示例

假设我们有一个典型项目结构如下：

my-app/
├─ cmake (submodule)/
│  ├─ usefulFunctions.cmake
├─ src/
│  ├─ main.cpp
├─ CMakeLists.txt

其中usefulFunctions.cmake包含了我们想要共享的CMake函数。

传统CMake安装方式

在纯CMake环境中，我们可以使用install命令来安装这些CMake函数文件：

include(GNUInstallDirs)
install(
    FILES       ${CMAKE_CURRENT_LIST_DIR}/usefulFunctions.cmake
    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/
)

这种方式虽然可行，但缺乏版本管理和依赖解析能力，这正是Conan可以解决的问题。

使用Conan打包CMake函数模块

Conan提供了两种主要方式来共享CMake代码：

1. 作为工具依赖(tool_requires)

当你的CMake模块不包含任何特定于平台的代码，纯粹是构建辅助功能时，可以将其打包为工具依赖。

创建conanfile.py时需要注意：

from conan import ConanFile

class CMakeFunctionsConan(ConanFile):
    name = "cmake_functions"
    version = "1.0"
    
    exports_sources = "usefulFunctions.cmake"
    
    def package(self):
        self.copy("usefulFunctions.cmake", dst="lib/cmake")
    
    def package_info(self):
        # 让使用者知道在哪里可以找到这个cmake模块
        self.cpp_info.builddirs = ["lib/cmake"]

2. 作为常规依赖(requires)

如果你的CMake模块与特定库相关，可以作为常规依赖打包：

from conan import ConanFile

class MyLibraryConan(ConanFile):
    name = "mylibrary"
    version = "1.0"
    
    exports_sources = "*.cmake", "src/*"
    
    def package(self):
        self.copy("*.cmake", dst="lib/cmake")
        self.copy("*.h", dst="include")
        self.copy("*.lib", dst="lib")
    
    def package_info(self):
        self.cpp_info.libs = ["mylibrary"]
        self.cpp_info.builddirs = ["lib/cmake"]

在消费者项目中使用

在消费者项目的conanfile.py中：

# 对于工具依赖
tool_requires("cmake_functions/1.0")

# 对于常规依赖
requires("mylibrary/1.0")

然后在CMake中可以直接包含这些模块：

# 查找并包含我们的实用函数
include(usefulFunctions)

# 使用其中定义的函数
my_custom_function()

最佳实践建议

1. 命名规范：为CMake模块使用独特的命名前缀，避免与其他包冲突
2. 版本控制：每次修改CMake函数都应该升级版本号
3. 文档说明：在包描述中清晰说明提供的CMake函数及其用法
4. 测试验证：为CMake函数编写测试用例，确保它们在不同环境下正常工作
5. 依赖管理：如果CMake函数依赖其他Conan包，确保正确声明这些依赖

常见问题解决

1. 路径问题：确保在package_info()中正确设置builddirs，这样CMake才能找到你的模块
2. 作用域问题：注意CMake函数中使用的变量作用域，避免污染调用者的命名空间
3. 兼容性问题：考虑不同CMake版本间的兼容性，使用适当的cmake_minimum_required

通过将CMake函数模块打包为Conan包，我们可以实现跨项目的代码复用，同时享受Conan提供的版本管理和依赖解析功能，大大提高了C++项目的可维护性和协作效率。