Conan 2与CMake结合多配置的最佳实践及相关问题咨询

1. 替代手动两步构建的更优方案 #

有几种方案可以让你回到单步构建体验，同时避免跨平台参数传递错误：

集成CMake Presets实现单步构建 #

把Conan的依赖安装逻辑嵌入CMake Presets，执行cmake --build --preset custom-preset时会自动先运行Conan安装：

1. 在CMakePresets.json的configurePreset中添加preConfigureCommand，并利用CMake平台条件判断自动匹配profile：

{
  "configurePresets": [
    {
      "name": "custom-preset",
      "generator": "Ninja",
      "preConfigureCommand": [
        "$<IF:$<PLATFORM_ID:Windows>,conan install conanfile.py -pr:a=win_profile --build=\"missing\" -of=CONAN_ARTIFACTS_FOLDER,conan install conanfile.py -pr:a=linux_profile --build=\"missing\" -of=CONAN_ARTIFACTS_FOLDER>"
      ],
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release"
      }
    }
  ]
}

团队成员无需手动区分平台，执行预设构建命令即可完成全流程。

用Conan CMake集成模块嵌入逻辑 #

在CMakeLists.txt开头加入Conan自动安装逻辑，把依赖管理完全交给CMake处理：

cmake_minimum_required(VERSION 3.25)
project(MyProject)

# 加载Conan集成模块
find_package(Conan REQUIRED)

# 自动检测系统配置，执行Conan安装
conan_cmake_autodetect(settings)
conan_cmake_install(PATH_OR_REFERENCE .
                    SETTINGS ${settings}
                    BUILD missing
                    OUTPUT_FOLDER CONAN_ARTIFACTS_FOLDER
                    PROFILE_AUTO detect)
# 加载Conan生成的依赖配置
conan_load_buildinfo()

# 后续项目配置...

PROFILE_AUTO detect会让Conan自动检测当前系统生成对应profile，彻底省去手动指定的麻烦。

跨平台脚本封装（备选） #

如果不想修改CMake配置，写个简单的Python脚本统一处理所有步骤：

import subprocess
import platform

def main():
    # 自动匹配profile
    profile = "win_profile" if platform.system() == "Windows" else "linux_profile"
    # 执行Conan安装
    subprocess.run(
        ["conan", "install", "conanfile.py", f"-pr:a={profile}", "--build=missing", "-of=CONAN_ARTIFACTS_FOLDER"],
        check=True,
        shell=platform.system() == "Windows"
    )
    # 执行CMake构建
    subprocess.run(["cmake", "--build", "--preset", "custom-preset"], check=True)

if __name__ == "__main__":
    main()

团队成员只需运行这个脚本，不用关心平台差异和参数细节。

2. 项目层面统一配置output-folder、build行为 #

完全可以在项目层面固化这些配置，避免手动传参出错：

在conanfile.py中全局配置 #

直接在项目的conanfile.py中定义默认的build行为和输出目录，所有成员执行conan install时会自动继承：

from conan import ConanFile
import os

class MyProjectConan(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def configure(self):
        # 全局设置build行为为"missing"（可改为"*"或特定包名，比如"zlib/*"）
        self.conf.define("tools.build:build", "missing")
        # 统一输出目录为项目根目录下的CONAN_ARTIFACTS_FOLDER
        self.conf.define("tools.build:output_folder", os.path.join(self.recipe_folder, "CONAN_ARTIFACTS_FOLDER"))

    # 如需针对特定包单独设置build行为，可在requirements中指定
    def requirements(self):
        self.requires("zlib/1.2.13", build="never")  # 强制不构建zlib

这样团队成员执行conan install时，无需手动添加--build和-of参数，默认会使用项目定义的配置。

项目级默认profile集合 #

在项目根目录创建profiles文件夹，存放Windows和Linux的专属profile文件（比如profiles/win、profiles/linux），然后在conanfile.py中自动加载对应平台的profile：

from conan import ConanFile
from conan.tools.cmake import CMakeToolchain
import os

class MyProjectConan(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def generate(self):
        tc = CMakeToolchain(self)
        # 根据当前系统加载项目内的profile
        profile_name = "win" if self.settings.os == "Windows" else "linux"
        profile_path = os.path.join(self.recipe_folder, "profiles", profile_name)
        tc.load_profile(profile_path)
        tc.generate()

这种方式把profile纳入项目版本控制，确保所有成员使用一致的编译配置，无需手动指定-pr:a参数。

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