跳到主内容

调试您的 add-to-app 模块

如何运行、调试和热重载您的 add-to-app Flutter 模块。

一旦将 Flutter 模块集成到您的项目中,并使用 Flutter 的平台 API 运行 Flutter 引擎和/或 UI,您就可以像运行普通 Android 或 iOS 应用一样构建和运行您的 Android 或 iOS 应用。

只要您的代码中包含 FlutterActivityFlutterViewController,Flutter 就会为其提供 UI 支持。

概述

#

您可能习惯于在使用 flutter run 或 IDE 中的等效命令时使用整套 Flutter 调试工具。但您也可以在 add-to-app 场景中使用所有的 Flutter 调试功能,例如热重载、性能叠加层、DevTools 和设置断点。

flutter attach 命令提供了这些功能。要运行此命令,您可以使用 SDK 的 CLI 工具、VS Code、IntelliJ IDEA 或 Android Studio。

当您运行 FlutterEngine 后,flutter attach 命令就会建立连接。它会保持连接状态,直到您销毁 FlutterEngine。您可以在启动引擎之前调用 flutter attachflutter attach 命令会等待引擎托管的下一个可用 Dart VM。

从终端调试

#

要从终端进行连接(attach),请运行 flutter attach。要选择特定的目标设备,请添加 -d <deviceId>

flutter attach

该命令应输出类似于以下内容的信息

Syncing files to device iPhone 15 Pro...
 7,738ms (!)

To hot reload the changes while running, press "r".
To hot restart (and rebuild state). press "R".

在 Xcode 和 VS Code 中调试 iOS 扩展

#

在终端中构建 Flutter 应用的 iOS 版本

#

要生成所需的 iOS 平台依赖项,请运行 flutter build 命令。

flutter build ios --config-only --no-codesign --debug
Warning: Building for device with codesigning disabled. You will have to manually codesign before deploying to device.
Building com.example.myApp for device (ios)...

先在 VS Code 中开始调试

#

如果您习惯在 VS Code 中调试大部分代码,请从本节开始。

在 VS Code 中启动 Dart 调试器
#
  1. 要打开 Flutter 应用目录,请转到 File(文件) > Open Folder...(打开文件夹...) 并选择 my_app 目录。

  2. 打开 lib/main.dart 文件。

  3. 如果您可以在多台设备上构建应用,则必须先选择设备。

    转到 View(查看) > Command Palette...(命令面板...)

    你也可以按 Ctrl / Cmd + Shift + P

  4. 输入 flutter select

  5. 点击 Flutter: Select Device(Flutter:选择设备) 命令。

  6. 选择您的目标设备。

  7. 点击调试图标(VS Code 的虫子图标,用于触发 Flutter 应用的调试模式)。这将打开 Debug(调试) 面板并启动应用。等待应用在设备上启动,并观察调试面板显示 Connected(已连接)。调试器首次启动耗时较长。后续启动速度会更快。

    此 Flutter 应用包含两个按钮

    • Launch in browser(在浏览器中启动):此按钮在设备的默认浏览器中打开此页面。
    • Launch in app(在应用中启动):此按钮在您的应用内打开此页面。此按钮仅适用于 iOS 或 Android。桌面应用会启动浏览器。
启用自动连接
#

您可以配置 VS Code,以便在每次开始调试时自动连接到您的 Flutter 模块项目。要启用此功能,请在您的 Flutter 模块项目中创建一个 .vscode/launch.json 文件。

  1. 转到 View(查看) > Run(运行)

    您也可以按 Ctrl / Cmd + Shift + D

    VS Code 会显示 Run and Debug(运行和调试) 侧边栏。

  2. 在此侧边栏中,点击 create a launch.json file(创建 launch.json 文件)

    VS Code 会在顶部显示 Select debugger(选择调试器) 菜单。

  3. 选择 Dart & Flutter

    VS Code 将创建并打开 .vscode/launch.json 文件。

    展开以查看示例 launch.json 文件
    json
    {
        // Use IntelliSense to learn about possible attributes.
        // Hover to view descriptions of existing attributes.
        // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
        "version": "0.2.0",
        "configurations": [
            {
                "name": "my_app",
                "request": "launch",
                "type": "dart"
            },
            {
                "name": "my_app (profile mode)",
                "request": "launch",
                "type": "dart",
                "flutterMode": "profile"
            },
            {
                "name": "my_app (release mode)",
                "request": "launch",
                "type": "dart",
                "flutterMode": "release"
            }
        ]
    }
    
  4. 要进行连接,请转到 Run(运行) > Start Debugging(开始调试)

    你也可以按 F5

在 Xcode 中连接到 Flutter 进程
#

要在 Xcode 中连接到 Flutter 应用

  1. 转到 Debug(调试) > Attach to Process(连接到进程)

  2. 选择 Runner。它应该出现在 Attach to Process(连接到进程) 菜单顶部,位于 Likely Targets(可能的调试目标) 标题下。

先在 Xcode 中开始调试

#

如果您习惯在 Xcode 中调试大部分代码,请从本节开始。

启动 Xcode 调试器
#
  1. 从您的 Flutter 应用目录中打开 ios/Runner.xcworkspace

  2. 使用工具栏中的 Scheme(方案) 菜单选择正确的设备。

    如果没有特定偏好,请选择 iPhone Pro 14

  3. 在 Xcode 中将此 Runner 作为普通应用运行。

    运行完成后,Xcode 底部的 Debug(调试) 区域会显示一条包含 Dart VM 服务 URI 的消息。它类似于以下响应

    2023-07-12 14:55:39.966191-0500 Runner[58361:53017145]
        flutter: The Dart VM service is listening on
        http://127.0.0.1:50642/00wEOvfyff8=/
    
  4. 复制 Dart VM 服务 URI。

在 VS Code 中连接到 Dart VM
#
  1. 要打开命令面板,请转到 View(查看) > Command Palette...(命令面板...)

    您也可以按 Cmd + Shift + P

  2. 输入 debug

  3. 点击 Debug: Attach to Flutter on Device(调试:连接到设备上的 Flutter) 命令。

  4. Paste an VM Service URI(粘贴 VM 服务 URI) 框中,粘贴您从 Xcode 复制的 URI,然后按 Enter

在 Android Studio 中调试 Android 扩展

#
  1. 要打开 Flutter 应用目录,请转到 File(文件) > Open...(打开...) 并选择 my_app 目录。

  2. 打开 lib/main.dart 文件。

  3. 选择一个虚拟 Android 设备。转到工具栏,打开最左侧的下拉菜单,然后点击 Open Android Emulator: <device>(打开 Android 模拟器:<设备>)

    您可以选择任何已安装且不包含 arm64 的模拟器。

  4. 从同一个菜单中,选择虚拟 Android 设备。

  5. 从工具栏中,点击 Run 'main.dart'(运行 'main.dart')

    您也可以按 Ctrl + Shift + R

    应用在模拟器中显示后,请继续下一步。

无需 USB 连接进行调试

#

要在 iOS 或 Android 设备上通过 Wi-Fi 调试您的应用,请使用 flutter attach

在 iOS 设备上通过 Wi-Fi 调试

#

对于 iOS 目标,请完成以下步骤

  1. 按照 iOS 设置指南 中的说明,验证您的设备是否已通过 Wi-Fi 连接到 Xcode。

  2. 在您的 macOS 开发机器上,打开 Xcode > Product(产品) > Scheme(方案) > Edit Scheme...(编辑方案...)

    您也可以按 Cmd + <

  3. 点击 Run(运行)

  4. 点击 Arguments(参数)

  5. Arguments Passed On Launch(启动时传递的参数) 中,点击 +

    1. 如果您的开发机器使用 IPv4,请添加 --vm-service-host=0.0.0.0

    2. 如果您的开发机器使用 IPv6,请添加 --vm-service-host=::0

    <DashImage figure img-class="site-mobile-screenshot border" image="development/add-to-app/debugging/wireless-port.png" caption="添加了 IPv4 网络后的启动参数设置", width="100%" />

要确定您是否在使用 IPv6 网络

#
  1. 打开 Settings(设置) > Wi-Fi

  2. 点击您连接的网络。

  3. 点击 Details...(详细信息...)

  4. 点击 TCP/IP

  5. 检查是否有 IPv6 地址 部分。

    WiFi dialog box for macOS System Settings

    macOS 系统设置的 Wi-Fi 对话框

在 Android 设备上通过 Wi-Fi 调试

#

按照 Android 设置指南 中的说明,验证您的设备是否已通过 Wi-Fi 连接到 Android Studio。