跳到主要内容
版本：v8

Swift Package Manager

Swift Package 是苹果官方推出的新一代软件依赖管理工具。过去，Capacitor 一直使用 CocoaPods 来管理内部依赖和插件依赖，但现在正是转向官方支持解决方案的时机。

自 Capacitor 6 起，您可以在 CocoaPods 和 Swift Package Manager (SPM) 之间进行选择。几乎所有当前由官方团队支持的插件都支持 SPM，特别是 capacitor-plugins 仓库中的插件。

我们已尽力确保您在使用 SPM 时无需对 Capacitor 的工作方式做太多改动，但仍有一些要点需要理解。

工作原理​

当 Capacitor 项目使用 SPM 时，我们会使用一个“基础 SPM”包，它作为引用您项目所有依赖项的中心：

基础 SPM 示意图

当您同步新插件时，Capacitor CLI 会修改 CapApp-SPM 包。请务必不要手动修改此目录的内容，因为 CLI 可能会且将会更改其中的内容。

在新 Capacitor 项目中使用 SPM​

首先，我们照常运行 npm init @capacitor/app@latest：

演示步骤 1

现在，我们需要向项目添加 iOS 平台：

npm install @capacitor/ios

接着构建 Web 项目：

npm run build

完成后，我们可以添加 iOS 项目。我们需要在常规的 add 命令中添加 --packagemanager SPM 选项：

npx cap add ios --packagemanager SPM

现在您可以使用 npx cap open ios 打开 iOS 项目，并从那里运行您的应用程序。

添加并使用支持 SPM 的 Capacitor 插件​

现在，让我们为这个项目添加一个插件并尝试使用它。

首先安装 Capacitor App 插件：

npm install @capacitor/app

然后同步 Web 应用。这会将 App 插件的 SPM 添加到 iOS 项目中：

npx cap sync

现在您可以正常使用 App 插件了。

在现有 Capacitor 项目中使用 SPM​

首先，请确保您已备份项目的当前状态，无论是通过源码控制还是其他方式。

删除您的 iOS 目录​

如果您完全没有手动修改过 Xcode 项目，一种迁移方法是删除 ios 目录，然后运行 npx cap add ios --packagemanager SPM。这将移除 CocoaPods 模板项目，并用 SPM 模板项目替换它。

使用我们的迁移工具​

Capacitor CLI 提供了一个命令来帮助从 CocoaPods 迁移到 Swift Package Manager。不过，仍需两个手动步骤。需要注意以下几点：包含 Cordova 插件的项目应该可以工作，但某些插件可能无法正常工作，因为我们需要为它们生成 Package.swift 文件。此外，如果项目使用了没有 SPM 版本的 Capacitor 插件，将无法正常工作，并且在迁移期间和运行 npx cap sync 时会显示关于不兼容插件的警告。

首先，在项目根目录运行 npx cap spm-migration-assistant。

此工具将：

  • 运行 pod deintegrate 以移除 CocoaPods
  • 删除 Podfile、App.xcworkspace 和 Podfile.lock
  • 创建包含所需文件的 CapApp-SPM 目录
  • 根据您的插件生成 Package.swift，并警告您哪些插件无法包含
  • 向您的 iOS 项目目录添加一个 debug.xcconfig 文件

然后运行 npx cap open ios，您应该会看到类似以下的内容：

迁移步骤 1

选中 App，然后选择 Package Dependencies 标签页，在此页面点击 + 号来添加依赖：

迁移步骤 2

您应该会看到类似以下的对话框——选择 Add Local...：

迁移步骤 3

在此对话框中选择 CapApp-SPM，然后点击 Add Package：

迁移步骤 4

当出现此屏幕时，再次点击 Add Package：

迁移步骤 5

完成后，您应该会看到类似这样的屏幕。现在，请继续阅读下一节关于添加 debug.xconfig 的内容。

迁移步骤 6

向项目添加 debug.xcconfig​

在 App 的 Info 标签页中，选择 Add Configuration file...：

XCConfig 步骤 1

然后选择名为 debug.xcconfig 的文件：

XCConfig 步骤 2

最后选择 xcconfig 作为您的选择：

XCConfig 步骤 3

至此，您已完成所有步骤，可以像往常一样构建和运行了。

将现有插件转换为 SPM​

如果您的插件除了必需的 [Name]Plugin.m 和 [Name]Plugin.h 文件外只包含 Swift 代码，您可以使用 capacitor-plugin-converter。

此工具将进行以下更改：

  • 向您的主 Swift 插件文件 [Name]Plugin.swift 添加以下必需内容：
    • 使您的类符合 CAPBridgedPlugin 协议。
    • 向您的类添加 3 个变量：identifier、jsName 和 pluginMethods：
      • identifier 对应于 CAP_PLUGIN 宏的第一个参数。
      • jsName 对应于 CAP_PLUGIN 宏的第二个参数。
      • pluginMethods 将是传递给 CAP_PLUGIN 宏的方法数组。
  • 将在插件文件夹的根目录创建一个 Package.swift 文件。
  • 将删除以下不再需要的文件：
    • Plugin.xcodeproj
    • Plugin.xcworkspace
    • Plugin/Info.plist
    • PluginTests/Info.plist
    • Podfile
  • 为遵循 SPM 最佳实践，项目文件将被移动到 Sources 和 Tests 目录。
  • 插件的 package.json 将发生以下变化：
    • files 数组将添加这些文件或目录：
      • ios/Sources
      • ios/Tests
      • Package.swift
    • verify:ios 将更改为 xcodebuild -scheme YourPluginName -destination generic/platform=iOS，以使其继续按预期工作。
  • 您的插件 podspec 将被更改，使 s.source_files 现在指向 Sources 目录而不是 Plugin 目录。

有关更多信息，请参阅 capacitor-plugin-converter 仓库中的文档。

故障排除​

添加插件后，可以尝试在 Xcode 中“重置包缓存”：

演示步骤 1

Contents

编辑此页