xcodebuild 构建 iOS 应用时 “Copy SPM bundles” 失败的解决方法

2024-10-21 10:30:43

在使用命令行工具 xcodebuild 构建 iOS 应用时，你可能会碰到 “Copy SPM bundles” 失败的情况，这在持续集成和持续交付（CI/CD）环境中尤为常见。错误日志里往往会出现一连串类似 “Copy /path/to/bundle /path/to/bundle (in target '...' from project '...')” 的错误信息，这意味着 Xcode 无法将 Swift Package Manager (SPM) 管理的依赖库的 bundle 文件复制到你的应用程序包中。

这个问题的根源在于 xcodebuild 在处理 SPM 依赖的 bundle 资源方面存在一些特殊性。当你使用 Xcode 图形界面构建项目时，Xcode 会自动处理这些 bundle 的复制过程。但是，当你使用命令行工具时，就需要进行一些额外的配置才能确保 bundle 被正确打包到应用中。

下面，我们来探讨一些可以尝试的解决方案：

1. 启用目标的并行构建

在 xcodebuild 命令中添加 -parallelizeTargets 参数可以启用目标的并行构建。这样做有助于解决某些情况下由于构建顺序导致的 bundle 复制失败的问题。

xcodebuild \
  build \
  -scheme "My Project" \
  -derivedDataPath './customFolder' \
  -destination 'platform=iOS Simulator,name=iPhone 15 Pro Max,OS=17.4' \
  -configuration Release \
  -parallelizeTargets \
  CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO

2. 检查 FRAMEWORK_SEARCH_PATHS

确保你的项目设置中，FRAMEWORK_SEARCH_PATHS 包含了 SPM 依赖库所在的路径。你可以在 Xcode 项目的 Build Settings 中找到这个设置。如果路径设置不正确，Xcode 就找不到 bundle 文件，自然也就无法复制。

3. 手动复制 bundle 文件

这可以作为一种临时解决方案。在构建过程完成后，你可以尝试手动将缺失的 bundle 文件复制到应用程序包中。首先，你需要找到 bundle 文件在 DerivedData 目录中的位置，然后将其复制到应用包的 Frameworks 目录下。

# 找到 DerivedData 目录
DERIVED_DATA_PATH="./customFolder"

# 找到 bundle 文件
BUNDLE_PATH="$DERIVED_DATA_PATH/Build/Products/Release Development-iphonesimulator/My Project.app/Stripe_StripeUICore.bundle"

# 复制到应用包的 Frameworks 目录
cp -R "$BUNDLE_PATH" "$DERIVED_DATA_PATH/Build/Products/Release Development-iphonesimulator/My Project.app/Frameworks"

4. 更新 Xcode 和 SPM

旧版本的 Xcode 和 SPM 可能存在一些 bug，导致 bundle 复制失败。尝试更新到最新版本，也许问题就迎刃而解了。

5. 清理构建缓存

有时候，构建缓存可能会导致一些意想不到的问题。尝试清理构建缓存，然后重新构建项目。

xcodebuild clean

6. 检查依赖库的配置

一些 SPM 依赖库可能需要进行一些特殊的配置才能在命令行构建中正常工作。查阅依赖库的文档，看看有没有相关的说明。

7. 禁用 Xcode 自动解析 Package 的功能

使用 -disableAutomaticPackageResolution 参数可以禁用 Xcode 自动解析 Package 的功能，这有时可以解决一些由于 Package 解析错误导致的问题。

xcodebuild \
  build \
  -scheme "My Project" \
  -derivedDataPath './customFolder' \
  -destination 'platform=iOS Simulator,name=iPhone 15 Pro Max,OS=17.4' \
  -configuration Release \
  -disableAutomaticPackageResolution \
  CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO