Swift Phoenix Client

关于

SwiftPhoenixClient 是 phoenix.js 的 Swift 版本，允许您的 Swift 项目连接到 Phoenix Websocket 后端。

我们尽力使这个库与 phoenix.js 保持更新，但如果有什么遗漏的地方，请创建一个问题或者，更好的是，创建一个 PR 来解决这个变化。

示例项目

您可以在 Example/ 目录中查看如何使用 SwiftPhoenixClient 的示例。有两个主要类，分别是 BasicViewController 和 ChatRoomViewController。BasicViewController 设计用于针对本地聊天服务器进行测试，而 ChatRoomViewController 则是一个更“完整”的示例，旨在针对 dwyl 的 phoenix-chat-example Heroku 应用。

SwiftPhoenixClient

提供 Phoenix Channels 和 Presence 逻辑的核心模块。它还使用 URLSession 的默认 WebSocket 实现，最低 iOS 版本为 13.0。

安装

CocoaPods

您可以通过在 Podfile 中添加以下内容来安装 SwiftPhoenix Client。请注意，为了使用 Swift Phoenix Client，最低 iOS 目标版本必须为 '9.0'

pod "SwiftPhoenixClient", '~> 5.2'

然后运行 pod install。从那里起，您需要在任何想要使用它的类中添加 import SwiftPhoenixClient。

Carthage

如果您使用 Carthage 管理依赖项，只需将其添加到您的 Cartfile

github "davidstump/SwiftPhoenixClient" ~> 5.2

然后运行 carthage update。

如果您第一次在项目中使用 Carthage，您需要按照在 Carthage 中的说明进行一些额外的步骤。

SwiftPackageManager

注意：以下说明是在没有Xcode UI的情况下使用 SwiftPM。最简单的方法是进入项目设置 -> Swift Packages，然后从那里添加SwiftPhoenixClient。

要使用Apple的Swift包管理器进行集成（不与Xcode集成），请在您的 Package.swift 中添加以下依赖项：

.package(url: "https://github.com/davidstump/SwiftPhoenixClient.git", .upToNextMajor(from: "5.2.2"))

然后指定 "SwiftPhoenixClient" 作为您希望在其中使用SwiftPhoenixClient的目标的依赖项。

使用方法

使用Swift Phoenix客户端非常简单（如果您使用过phoenix.js客户端，将非常熟悉）。

请查看使用指南以获取详细说明。您还可以查看文档

示例

查看该存储库中的 ViewController，以获取使用 Phoenix Chat Example 的简单iOS聊天应用程序的简要示例。

还可以查看IRC上的Swift和Elixir通道。

开发

请查看入门指南的wiki页面。

感谢

非常感谢Daniel Rees对项目的多项贡献和持续维护！

许可证

SwiftPhoenixClient采用MIT许可证。更多详情请参考LICENSE文件。