将 Flutter 模块集成到您的 iOS 项目中

在第二种方法中，您需要编辑现有的 Xcode 项目，生成必要的框架，并将它们嵌入到您的应用中。Flutter 会为 Flutter 本身、您编译的 Dart 代码以及您的每个 Flutter 插件生成 iOS 框架。嵌入这些框架并更新您现有应用程序的构建设置。

此方法不需要额外的软件或硬件要求。请在以下用例中使用此方法

• 您的团队成员无法安装 Flutter SDK 和 CocoaPods
• 您不想在现有的 iOS 应用中使用 CocoaPods 作为依赖管理器

Flutter 无法处理 xcframeworks 的公共依赖项。如果宿主应用和 Flutter 模块的插件都定义了相同的 pod 依赖项，并且您使用此选项集成 Flutter 模块，则会导致错误。这些错误包括诸如 Multiple commands produce 'CommonDependency.framework' 之类的问题。

为了解决此问题，请将 Flutter 模块 podspec 文件中的每个插件源码链接到宿主应用的 Podfile。链接源码而不是插件的 xcframework 框架。下一节将解释如何 生成该框架。

为防止出现公共依赖项导致的错误，请使用带有 --no-plugins 标志的 flutter build ios-framework。

以下示例假设您要将框架生成到 /path/to/MyApp/Flutter/。

$ flutter build ios-framework --output=/path/to/MyApp/Flutter/

每次更改 Flutter 模块中的代码时，请运行此命令。

生成的项目结构应类似于此目录树。

如何将生成的框架链接、嵌入到您现有的 Xcode 应用中，取决于框架的类型。

• 链接并嵌入动态框架。
• 链接静态框架。永远不要嵌入它们。

Flutter 插件可能会产生 静态或动态框架。链接静态框架，永远不要嵌入它们。

如果您将静态框架嵌入到 iOS 应用中，您将无法将该应用发布到 App Store。发布将失败，并出现 Found an unexpected Mach-O header code 归档错误。

要链接必要的框架，请遵循此流程。

1. 选择要链接的框架。

   1. 在 Project Navigator（项目导航器）中，点击您的项目。

   2. 点击 Build Phases（构建阶段）选项卡。

   3. 展开 Link Binary With Libraries（用库链接二进制文件）。

      

   4. 点击 +（加号）。

   5. 点击 Add Other...，然后点击 Add Files...。

   6. 在 Choose frameworks and libraries to add:（选择要添加的框架和库：）对话框中，导航到 /path/to/MyApp/Flutter/Release/ 目录。

   7. 按住 Cmd 点击该目录中的框架，然后点击 Open。

      

2. 更新库路径以应对构建模式。

   1. 启动 Finder。

   2. 导航到 /path/to/MyApp/ 目录。

   3. 右键点击 MyApp.xcodeproj 并选择 Show Package Contents（显示包内容）。

   4. 使用 Xcode 打开 project.pbxproj。该文件将在 Xcode 的文本编辑器中打开。这也会锁定 Project Navigator，直到您关闭文本编辑器。

      

   5. 在 /* Begin PBXFileReference section */ 中查找类似于以下文本的行。

      312885572C1A441C009F74FF /* Flutter.xcframework */ = {
        isa = PBXFileReference;
        expectedSignature = "AppleDeveloperProgram:S8QB4VV633:FLUTTER.IO LLC";
        lastKnownFileType = wrapper.xcframework;
        name = Flutter.xcframework;
        path = Flutter/Release/Flutter.xcframework;
        sourceTree = "<group>";
      };
      312885582C1A441C009F74FF /* App.xcframework */ = {
        isa = PBXFileReference;
        lastKnownFileType = wrapper.xcframework;
        name = App.xcframework;
        path = Flutter/Release/App.xcframework;
        sourceTree = "<group>";
      };
      

      content_copy

   6. 将前一步中突出显示的 Release 文本更改为 $(CONFIGURATION)。此外，请用引号将路径括起来。

      312885572C1A441C009F74FF /* Flutter.xcframework */ = {
        isa = PBXFileReference;
        expectedSignature = "AppleDeveloperProgram:S8QB4VV633:FLUTTER.IO LLC";
        lastKnownFileType = wrapper.xcframework;
        name = Flutter.xcframework;
        path = "Flutter/$(CONFIGURATION)/Flutter.xcframework";
        sourceTree = "<group>";
      };
      312885582C1A441C009F74FF /* App.xcframework */ = {
        isa = PBXFileReference;
        lastKnownFileType = wrapper.xcframework;
        name = App.xcframework;
        path = "Flutter/$(CONFIGURATION)/App.xcframework";
        sourceTree = "<group>";
      };
      

      content_copy

3. 更新搜索路径。

   1. 点击 Build Settings（构建设置）选项卡。

   2. 导航到 Search Paths（搜索路径）

   3. 双击 Framework Search Paths（框架搜索路径）右侧的内容。

   4. 在组合框中，点击 +（加号）。

   5. 输入 $(inherited)，然后按下 Enter。

   6. 点击 +（加号）。

   7. 输入 $(PROJECT_DIR)/Flutter/$(CONFIGURATION)/，然后按下 Enter。

      

链接框架后，它们应该会显示在目标 (target) 的 General（常规）设置的 Frameworks, Libraries, and Embedded Content（框架、库和嵌入内容）部分中。

要嵌入您的动态框架，请完成以下程序。

1. 导航到 General > Frameworks, Libraries, and Embedded Content。

2. 点击您的每个动态框架并选择 Embed & Sign（嵌入并签名）。

   

   不要包含任何静态框架，包括 FlutterPluginRegistrant.xcframework。

3. 点击 Build Phases（构建阶段）选项卡。

4. 展开 Embed Frameworks（嵌入框架）。您的动态框架应显示在该部分中。

   

5. 构建项目。

   1. 在 Xcode 中打开 MyApp.xcworkspace。

      请务必打开 MyApp.xcworkspace，而不是打开 MyApp.xcodeproj。.xcworkspace 文件包含 CocoaPod 依赖项，而 .xcodeproj 则不包含。

   2. 选择 Product > Build 或按下 Cmd + B。

1. 生成 Flutter LLDB 文件。

   1. 在您的 Flutter 应用程序中，如果尚未运行，请重新运行 flutter build ios-framework

   $ flutter build ios-framework --output=/path/to/MyApp/Flutter/
   

   content_copy

   这将在 /path/to/MyApp/Flutter/ 目录中生成 LLDB 文件。

2. 设置 LLDB 初始化文件。

   1. 转到 Product > Scheme > Edit Scheme。

   2. 选择左侧边栏中的 Run（运行）部分。

   3. 将 LLDB Init File 设置为以下内容

      $(PROJECT_DIR)/Flutter/flutter_lldbinit
      

      content_copy

      如果您的方案已经有 LLDB Init File，您可以将 Flutter 的 LLDB 文件添加到其中。Flutter 的 LLDB 初始化文件的路径必须相对于您项目的 LLDB 初始化文件的位置。

      例如，如果您的 LLDB 文件位于 /path/to/MyApp/.lldbinit，您应该添加以下内容

      command source --relative-to-command-file "Flutter/flutter_lldbinit"
      

      content_copy

此方法将 Flutter 生成为 CocoaPods podspec，而不是向其他开发人员、机器或持续集成系统分发庞大的 Flutter.xcframework。Flutter 仍然会为您的编译后的 Dart 代码以及每个 Flutter 插件生成 iOS 框架。嵌入这些框架并更新您现有应用程序的构建设置。

此方法不需要额外的软件或硬件要求。请在以下用例中使用此方法

• 您的团队成员无法安装 Flutter SDK 和 CocoaPods
• 您不想在现有的 iOS 应用中使用 CocoaPods 作为依赖管理器

Flutter 无法处理 xcframeworks 的公共依赖项。如果宿主应用和 Flutter 模块的插件都定义了相同的 pod 依赖项，并且您使用此选项集成 Flutter 模块，则会导致错误。这些错误包括诸如 Multiple commands produce 'CommonDependency.framework' 之类的问题。

为了解决此问题，请将 Flutter 模块 podspec 文件中的每个插件源码链接到宿主应用的 Podfile。链接源码而不是插件的 xcframework 框架。下一节将解释如何 生成该框架。

为防止出现公共依赖项导致的错误，请使用带有 --no-plugins 标志的 flutter build ios-framework。

此方法仅适用于 beta 或 stable 发布渠道。

以下示例假设您要将框架生成到 /path/to/MyApp/Flutter/。

$ flutter build ios-framework --output=/path/to/MyApp/Flutter/

每次更改 Flutter 模块中的代码时，请运行此命令。

生成的项目结构应类似于此目录树。

使用 CocoaPods 的宿主应用可以将 Flutter 引擎添加到其 Podfile 中。

pod 'Flutter', :podspec => '/path/to/MyApp/Flutter/[build mode]/Flutter.podspec'

Flutter 插件可能会产生 静态或动态框架。链接静态框架，永远不要嵌入它们。

如果您将静态框架嵌入到 iOS 应用中，您将无法将该应用发布到 App Store。发布将失败，并出现 Found an unexpected Mach-O header code 归档错误。

要链接必要的框架，请遵循此流程。

1. 选择要链接的框架。

   1. 在 Project Navigator（项目导航器）中，点击您的项目。

   2. 点击 Build Phases（构建阶段）选项卡。

   3. 展开 Link Binary With Libraries（用库链接二进制文件）。

      

   4. 点击 +（加号）。

   5. 点击 Add Other...，然后点击 Add Files...。

   6. 在 Choose frameworks and libraries to add:（选择要添加的框架和库：）对话框中，导航到 /path/to/MyApp/Flutter/Release/ 目录。

   7. 按住 Cmd 点击该目录中的框架，然后点击 Open。

      

2. 更新库路径以应对构建模式。

   1. 启动 Finder。

   2. 导航到 /path/to/MyApp/ 目录。

   3. 右键点击 MyApp.xcodeproj 并选择 Show Package Contents（显示包内容）。

   4. 使用 Xcode 打开 project.pbxproj。该文件将在 Xcode 的文本编辑器中打开。这也会锁定 Project Navigator，直到您关闭文本编辑器。

      

   5. 在 /* Begin PBXFileReference section */ 中查找类似于以下文本的行。

      312885572C1A441C009F74FF /* Flutter.xcframework */ = {
        isa = PBXFileReference;
        expectedSignature = "AppleDeveloperProgram:S8QB4VV633:FLUTTER.IO LLC";
        lastKnownFileType = wrapper.xcframework;
        name = Flutter.xcframework;
        path = Flutter/Release/Flutter.xcframework;
        sourceTree = "<group>";
      };
      312885582C1A441C009F74FF /* App.xcframework */ = {
        isa = PBXFileReference;
        lastKnownFileType = wrapper.xcframework;
        name = App.xcframework;
        path = Flutter/Release/App.xcframework;
        sourceTree = "<group>";
      };
      

      content_copy

   6. 将前一步中突出显示的 Release 文本更改为 $(CONFIGURATION)。此外，请用引号将路径括起来。

      312885572C1A441C009F74FF /* Flutter.xcframework */ = {
        isa = PBXFileReference;
        expectedSignature = "AppleDeveloperProgram:S8QB4VV633:FLUTTER.IO LLC";
        lastKnownFileType = wrapper.xcframework;
        name = Flutter.xcframework;
        path = "Flutter/$(CONFIGURATION)/Flutter.xcframework";
        sourceTree = "<group>";
      };
      312885582C1A441C009F74FF /* App.xcframework */ = {
        isa = PBXFileReference;
        lastKnownFileType = wrapper.xcframework;
        name = App.xcframework;
        path = "Flutter/$(CONFIGURATION)/App.xcframework";
        sourceTree = "<group>";
      };
      

      content_copy

3. 更新搜索路径。

   1. 点击 Build Settings（构建设置）选项卡。

   2. 导航到 Search Paths（搜索路径）

   3. 双击 Framework Search Paths（框架搜索路径）右侧的内容。

   4. 在组合框中，点击 +（加号）。

   5. 输入 $(inherited)，然后按下 Enter。

   6. 点击 +（加号）。

   7. 输入 $(PROJECT_DIR)/Flutter/$(CONFIGURATION)/，然后按下 Enter。

      

链接框架后，它们应该会显示在目标 (target) 的 General（常规）设置的 Frameworks, Libraries, and Embedded Content（框架、库和嵌入内容）部分中。

要嵌入您的动态框架，请完成以下程序。

1. 导航到 General > Frameworks, Libraries, and Embedded Content。

2. 点击您的每个动态框架并选择 Embed & Sign（嵌入并签名）。

   

   不要包含任何静态框架，包括 FlutterPluginRegistrant.xcframework。

3. 点击 Build Phases（构建阶段）选项卡。

4. 展开 Embed Frameworks（嵌入框架）。您的动态框架应显示在该部分中。

   

5. 构建项目。

   1. 在 Xcode 中打开 MyApp.xcworkspace。

      请务必打开 MyApp.xcworkspace，而不是打开 MyApp.xcodeproj。.xcworkspace 文件包含 CocoaPod 依赖项，而 .xcodeproj 则不包含。

   2. 选择 Product > Build 或按下 Cmd + B。

1. 生成 Flutter LLDB 文件。

   1. 在您的 Flutter 应用程序中，如果尚未运行，请重新运行 flutter build ios-framework

   $ flutter build ios-framework --output=/path/to/MyApp/Flutter/
   

   content_copy

   这将在 /path/to/MyApp/Flutter/ 目录中生成 LLDB 文件。

2. 设置 LLDB 初始化文件。

   1. 转到 Product > Scheme > Edit Scheme。

   2. 选择左侧边栏中的 Run（运行）部分。

   3. 将 LLDB Init File 设置为以下内容

      $(PROJECT_DIR)/Flutter/flutter_lldbinit
      

      content_copy

      如果您的方案已经有 LLDB Init File，您可以将 Flutter 的 LLDB 文件添加到其中。Flutter 的 LLDB 初始化文件的路径必须相对于您项目的 LLDB 初始化文件的位置。

      例如，如果您的 LLDB 文件位于 /path/to/MyApp/.lldbinit，您应该添加以下内容

      command source --relative-to-command-file "Flutter/flutter_lldbinit"
      

      content_copy