XcodeBuild¶

XcodeBuild 构建助手是对 Xcode 命令行调用的封装。它将抽象诸如 xcodebuild -project app.xcodeproj -configuration <config> -arch <arch> ... 之类的调用。

XcodeBuild 助手的使用方式如下：

from conan import conanfile
from conan.tools.apple import XcodeBuild

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"

    def build(self):
        xcodebuild = XcodeBuild(self)
        xcodebuild.build("app.xcodeproj")

参考¶

class XcodeBuild(conanfile)¶

__init__(conanfile)¶

XcodeBuild.build(xcodeproj, target=None, configuration=None, cli_args=None)¶

调用 xcodebuild 来构建 Xcode 项目。

参数:

xcodeproj – 要构建的 xcodeproj 文件。
target – 要构建的目标。如果此参数传递给 build() 方法，它将向构建系统调用添加 -target 参数。如果未传递，它将传递 -alltargets 参数来构建所有目标。
configuration – 要使用的构建配置（例如，Debug、Release）。默认为配方的 settings.build_type。
cli_args – 直接传递给 xcodebuild 的额外选项（字符串列表）。示例：["-xcconfig", "<path/to/file.xcconfig>"] 或自定义 Xcode 构建设置，如 ["BUILD_LIBRARY_FOR_DISTRIBUTION=YES"]。

返回:

已启动的 xcodebuild 命令的返回码。

XcodeBuild.build() 方法内部实现了对 xcodebuild 的调用，类似于：

$ xcodebuild -project app.xcodeproj -configuration <configuration> -arch <architecture> <sdk> <verbosity> -target <target>/-alltargets *_DEPLOYMENT_TARGET=settings.os.version <cli_args>

其中

configuration 是配置，通常是 Release 或 Debug，除非通过 configuration 参数显式传递，否则将从 settings.build_type 获取。
architecture 是构建架构，是从 settings.arch 到 Apple 定义的常见架构（‘i386’、‘x86_64’、‘armv7’、‘arm64’ 等）的映射。
sdk 根据 os.sdk 和 os.sdk_version 的值设置，它们定义了 SDKROOT Xcode 构建设置。例如，设置 os.sdk=iOS 和 os.sdk_version=8.3` 将向构建系统传递 SDKROOT=iOS8.3。如果您在 **[conf]** 中定义了 tools.apple:sdk_path，此值将优先，并直接传递 SDKROOT=<tools.apple:sdk_path>，因此 **请注意**，对于这种情况，位于该路径下的 sdk 应设置您的 os.sdk 和 os.sdk_version 设置值。
verbosity 是构建的详细程度级别，如果通过 **[conf]** 中的 tools.build:verbosity 设置，则可以取值 ‘verbose’ 或 ‘quiet’。

cli_args 是通过 cli_args 参数传递的附加命令行参数。这些参数可以包括自定义构建设置，如 BUILD_LIBRARY_FOR_DISTRIBUTION=YES。您还可以通过传递 SYMROOT 和 OBJROOT 设置来重定向构建工件到 Conan 构建文件夹。

def build(self):
  xcodebuild = XcodeBuild(self)
  xcodebuild.build("app.xcodeproj", cli_args=[f"SYMROOT={self.build_folder}",
                                              f"OBJROOT={self.build_folder}"])

传递给 xcodebuild 的附加参数（但在 cli_args 之前）。

根据配置文件中 os 和 os.version 的值设置部署目标，例如 MACOSX_DEPLOYMENT_TARGET=10.15 或 IPHONEOS_DEPLOYMENT_TARGET=15.0。

conf¶

tools.build:verbosity（或备用的 tools.compilation:verbosity），它接受 quiet 或 verbose，并为 XcodeBuild.install() 设置 -verbose 或 -quiet 标志。
tools.apple:sdk_path sdk 位置的路径，将优先设置 SDKROOT 值，而不是从 os.sdk 和 os.sdk_version 设置组合值。