isowords
这个仓库包含了 isowords 的完整源代码,这是一款在消失的立方体上进行的 iOS 文字搜索游戏。连接相邻的字母来组成单词,单词越长越好,当一个字母被使用三次时,其所在的立方体就会被移除,露出里面更多的字母!
现在可在 App Store 下载!
关于
isowords 是一个完全用 Swift 构建的大型复杂应用。iOS 客户端的逻辑基于 Composable Architecture 构建,UI 主要使用 SwiftUI 构建,少量使用 SceneKit。服务器也使用 Swift 构建,采用了我们实验性的 Web 服务器库。
我们在 Point-Free 上发布了一个4集的视频系列,涵盖了这些主题以及更多内容。Point-Free 是一个探索函数式编程和 Swift 语言的视频系列,由 Brandon Williams 和 Stephen Celis 主持。
你可能会对以下几点感兴趣:
Composable Architecture
整个应用程序由 Composable Architecture 驱动,这是我们在 Point-Free 上从头开始构建的一个库,提供了用于构建应用程序的工具,重点关注可组合性、模块化和可测试性。这意味着:
- 整个应用的状态保存在一个单一的事实来源中,称为
Store
。 - 整个应用的行为由一个单一的单元实现,称为
Reducer
,它由许多其他 reducer 组成。 - 所有有副作用的操作都被明确地表示为从 reducer 返回的值。
- 依赖项被明确地表示为简单的数据类型,包装其实际实现,以及各种模拟实例。
以这种方式设计应用程序有很多好处:
- 大型、复杂的功能可以分解为更小的子域,这些子域可以通过简单的状态变更进行通信。通常在 SwiftUI 中,这是通过在
ObservableObject
实例中访问单例来完成的,但在 Composable Architecture 中这是不必要的。 - 我们控制依赖项,而不是让它们控制我们。即使你在代码中使用了
StoreKit
、GameCenter
、UserNotifications
或任何其他第三方 API,也不意味着你必须牺牲在模拟器中运行应用程序、使用 SwiftUI 预览或编写简洁测试的能力。 - 可以很快地编写详尽的测试。我们测试非常详细的用户流程,捕捉微妙的边缘情况,并断言效果如何执行以及它们的输出如何反馈到应用程序中。
- 编写集成测试以测试应用程序的多个独立部分变得很简单。
超模块化
应用程序采用超模块化的风格构建。在撰写本 README 时,客户端和服务器被分为 86 个模块。这允许我们在不构建整个应用程序的情况下处理功能,从而改善编译时间和 SwiftUI 预览的稳定性。它还使我们能够轻松地发布 App Clip,其大小必须小于 10 MB(未压缩),通过选择最少的代码和资源来构建。
客户端/服务器单一代码库
iOS 客户端和服务器的代码都包含在这个单一的代码库中。这使得同时运行客户端和服务器变得容易,我们甚至可以同时调试它们,例如在服务器中设置断点,当模拟器发出 API 请求时触发。
我们还在客户端和服务器之间共享了大量代码:
- 描述玩家、谜题、移动等的核心类型。
- 游戏逻辑,如随机谜题生成器、谜题验证、字典等。
- 服务器用于处理请求的路由器与 iOS 客户端用于向服务器发出 API 请求的代码完全相同。新路由只需指定一次,就立即可用于客户端和服务器。
- 我们编写了同时测试服务器和 iOS 客户端的集成测试。在测试过程中,客户端发出的 API 请求实际上在后台运行真实的服务器代码。
- 还有更多...
自动生成 App Store 截图和预览视频
我们上传到 App Store 的应用截图和预览视频是自动生成的。
-
截图由测试套件使用我们的 SnapshotTesting 库生成,负责构建一个非常具体的状态,我们将其加载到屏幕上,并提供周围的图形。
-
预览视频是通过运行精简版应用程序的屏幕录制生成的,该版本在立方体上嵌入特定字母并运行一系列动作来模拟用户玩游戏。可以通过在 Xcode 中选择
TrailerPreview
目标并在模拟器中运行来在本地运行该应用程序。
预览应用
有时我们想要在不构建整个应用程序的情况下单独测试某个功能。SwiftUI 预览很适合这种情况,但它们也有局限性,比如当你需要使用预览不可用的 API,或者需要调试更复杂的流程等。
因此,我们创建了迷你应用程序,它们只构建构成整个应用程序的 86+ 个模块中的一小部分。设置这些应用程序只需要最少的工作。你只需在 Xcode 项目中指定所需的依赖项,然后创建一个入口点来启动功能。
例如,这里是创建预览应用程序以单独运行新手引导流程所需的全部代码。如果我们受制于完整应用程序来测试这个功能,我们就需要不断地删除并重新安装应用程序,因为这个屏幕只在首次启动时显示。
开始使用
这个仓库包含了运行整个 isowords 应用程序的客户端和服务器代码,以及广泛的测试套件。要运行它们:
-
确保已安装
git-lfs
,以便可以获取应用资产(图像等)。例如,使用 Homebrew:$ brew install git-lfs # 下载并安装 Git LFS $ git lfs install # 为你的用户设置 Git LFS
-
获取代码:
git clone https://github.com/pointfreeco/isowords cd isowords
-
引导应用程序:
- 如果你只对构建 iOS 客户端感兴趣,则运行以下引导命令:
make bootstrap-client
- 如果你想构建客户端和服务器,请确保已安装并运行 PostgreSQL,然后运行以下引导命令:
make bootstrap
- 如果你只对构建 iOS 客户端感兴趣,则运行以下引导命令:
-
打开 Xcode 项目
App/isowords.xcodeproj
。 -
要在本地运行客户端,在 Xcode 中选择
isowords
目标并运行(⌘R
)。 -
要在本地运行服务器,在 Xcode 中选择
server
目标并运行(⌘R
)。
了解更多
本 README 中讨论的大多数概念都在 Point-Free 上有深入的讨论。Point-Free 是一个探索函数式编程和 Swift 语言的视频系列,由 Brandon Williams 和 Stephen Celis 主持。
相关项目
这个应用程序使用了一些由我们构建并在 Point-Free 上讨论的开源项目,包括:
- Case Paths
- Composable Architecture
- Custom Dump
- Gen
- Identified Collections
- Overture
- Tagged
- SnapshotTesting
许可证
本仓库中的源代码仅可用于教育目的,不得用于商业目的。有关更多信息,请参阅我们的完整许可证。