工程开发
apollo-kotlin avatar

apollo-kotlin

使用 Apollo Kotlin 的开发指南,这是一个适用于 Android、JVM 和 Kotlin Multiplatform (KMP) 的 GraphQL 客户端程序库。

简介

Apollo Kotlin 技能为使用 Apollo Kotlin 程序库 (v4+) 将 GraphQL 整合到 Android、JVM 和 Kotlin Multiplatform (KMP) 项目中提供了一个全面的框架。此技能专为移动开发者和后端开发者设计,简化了从 GraphQL 操作和 schema 生成类型安全 Kotlin 模型的过程,确保跨异构平台的强健数据处理。它通过管理请求的全生命周期(从初始配置到执行时执行与缓存管理),弥合了客户端需求与远程 GraphQL 服务之间的差距。

  • 在 Gradle 项目中配置 Apollo Kotlin,包含对 Android、JVM 和 KMP 模块的支持。

  • 管理 GraphQL schema 下载与代码生成设置,包括自定义标量映射与适配器配置。

  • 构建并自定义包含身份验证拦截器、请求日志记录与错误处理的 ApolloClient。

  • 实现高效的数据获取模式,包括使用 Kotlin Flow 的查询 (Queries)、变更 (Mutations) 与反应式订阅 (Subscriptions)。

  • 设置并利用规范化缓存 (Normalized Cache) 来实现离线优先能力、优化的状态管理,以及跨应用程序画面的数据一致性。

  • 通过脚本辅助工具管理与更新 Apollo Kotlin 程序库版本及缓存依赖。

  • 确保所有 schema 与操作文件皆已纳入版本控制,以实现可重现的构建。

  • 优先使用现代的 com.apollographql.cache 程序库,而非旧版替代方案以获得最佳性能。

  • 在升级前使用提供的脚本查询 Apollo Kotlin 与规范化缓存的可用版本。

  • 应用 @typePolicy 指令来定义复杂对象的自定义缓存键,确保规范化缓存运作正常。

  • 请务必使用 Apollo Kotlin v4 或更高版本,以利用最新的性能提升、API 稳定性与功能集。

  • 通过整合测试与适当的错误处理来验证所有网络相关逻辑,以区分网络故障与 GraphQL 特定错误。

仓库统计

Star 数
58
Fork 数
4
Open Issue 数
2
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 18:36
在 GitHub 查看