Android Studio / IntelliJ插件

为了帮助您使用

安装

插件可在JetBrains插件库中找到。要从IDE中安装，请转到

截至写作时，此插件支持以下版本

• IntelliJ 2023.2及更高版本
• Android Studio 2023.2 (Iguana)及更高版本

功能

自动代码生成

此插件会在GraphQL文件更改时自动生成模型。这意味着您在编辑文件后无需手动运行./gradlew generateApolloSources。

注意：这是通过在持续模式下运行Gradle实现的，可以在插件设置中禁用。

与GraphQL IntelliJ Plugin集成

此插件依赖于并与GraphQL IntelliJ Plugin集成。Apollo项目的文件结构将自动添加，因此无需创建graphql.config.yml或.graphqlconfig文件。

导航

Kotlin → GraphQL

在编辑Kotlin代码时，图标将出现在对生成的操作和片段类的引用旁边。单击它们将导航到相应的GraphQL定义。

您也可以通过Cmd点击（Mac）或Ctrl点击（Windows/Linux）一个操作、字段、枚举等来访问GraphQL定义。

GraphQL → Kotlin

您可以通过右键单击并选择查找使用情况在查询GraphQL操作、片段、枚举类型/值和输入类型/字段的使用。

未使用的操作/字段

在GraphQL文件中，若对应生成的代码在项目中未被使用，则操作和字段将以灰色显示。

迁移助手

在重构 | Apollo菜单中，您可以找到迁移项目的助手：

• Apollo Android 2.x → Apollo Kotlin 3.x
• 兼容代码生成 → 基于操作的代码生成
• Apollo Kotlin 3.x → Apollo Kotlin 4.x

注意：虽然这些助手会在可能的情况下自动更新您的代码，但有些情况下这是不可能的，需要手动更改。请参阅升级时的迁移指南（3.x，4.x）。

下载架构

通过转到工具 | Apollo | 下载架构下载最新的架构版本。

这使用Introspection端点或您可以在您的Apollo服务上配置的注册表。

在Apollo模拟环境中打开

您可以通过右键单击在 GraphQL 文件中打开 Apollo 沙盒 | 打开方式 | Apollo 沙盒. 这样可以方便地与同事分享 操作，例如。在那里，他们可以执行操作并查看结果。

您也可以从编辑器顶部的 按钮访问。

高延迟字段

如果您项目使用 Apollo GraphOS，插件可以使用收集的指标（"字段洞察"）并在高延迟的字段上报告警告。

默认情况下，延迟超过 100ms 的 字段 会被突出显示。您可以在 设置 | 编辑器 | 检查 | GraphQL | Apollo GraphOS | 高延迟字段 中更改此阈值。

可提供一个快速修复方案，可以将该 字段 使用带有 @defer 指令 的 fragment 封装。

为了插件能夠获取指标，您需要使用其 Apollo GraphOS API 密钥。为此，请转到插件的设置：设置 | 语言 & 框架 | GraphQL | Apollo Kotlin。在这里，您可以在 API 密钥 表格中添加：

• API 密钥：应该以 service: 或 user:
• Graph ID：可以在您的 GraphOS Studio 图表中找到，或者如果您提供了 service: API 密钥，则会自动填充。

规范化缓存查看器

插件提供了一种图形工具来检查标准化缓存。要打开它，请转到工具 | Apollo | 标准化缓存查看器。

从那里您可以点击“从设备拉取”以打开连接的设备或模拟器中的缓存。要打开内存缓存，请参考Apollo调试服务器部分。

您还可以通过将.db文件拖放到工具窗口中打开它，或者点击“打开文件...”选择要打开的文件。

缓存打开后，您可以通过缓存键搜索记录，或者从左侧浏览它们。单击记录将在右侧显示其字段及其值。

每周快照

如果您想尝试最新的功能，您可以为每周快照进行安装。为此，请在设置 | 插件 | ⚙️ | 管理插件仓库 | +中添加以下仓库： https://go.apollo.dev/ij-plugin-snapshots。

然后，通过在市场搜索“Apollo GraphQL”来安装插件，将安装最新的快照。

隐私和数据收集

默认情况下，插件收集匿名使用数据以帮助改进产品。

要退出数据收集，请转到设置 | 语言与框架 | GraphQL | Apollo Kotlin并取消选中发送使用统计信息。

收集的数据

除非您选择退出，否则插件将报告与

• 使用Apollo Kotlin库有关的属性和事件（例如Gradle插件的哪个选项被使用）
• 有关项目的信息（例如Android和Kotlin的版本）
• IDE插件的用法（例如在设置中启用了哪些功能）

属性和事件的确切列表可以在源代码中找到。