Swift Phoenix 客户端

Swift Version License Platform Carthage compatible Open Source Helpers

关于

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

我们会尽力保持此库与 phoenix.js 同步更新,但如果缺少某些内容,请创建 issue,或者更好的是,提交 PR 来解决此问题。

示例项目

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

SwiftPhoenixClient

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

安装

CocoaPods

您可以通过将以下内容添加到您的 Podfile 中,使用 CocoaPods 安装 SwiftPhoenix Client。 请记住,为了使用 Swift Phoenix Client,最低 iOS 目标版本必须为 '9.0'

pod "SwiftPhoenixClient", '~> 5.3'

并运行 pod install。 从那里,您需要在任何要使用它的类中添加 import SwiftPhoenixClient

Carthage

如果您使用 Carthage 来管理您的依赖项,只需将 SwiftPhoenixClient 添加到您的 Cartfile 中即可

github "davidstump/SwiftPhoenixClient" ~> 5.3

然后运行 carthage update

如果这是您第一次在项目中使用 Carthage,则需要按照 Carthage 上的说明 完成一些额外的步骤。

SwiftPackageManager

注意:以下说明适用于在没有 Xcode UI 的情况下使用 SwiftPM。 最简单的方法是转到您的 Project Settings -> Swift Packages 并从那里添加 SwiftPhoenixClient。

要在不使用 Xcode 集成的情况下,使用 Apple 的 Swift 包管理器进行集成,请将以下内容作为依赖项添加到您的 Package.swift

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

然后将 "SwiftPhoenixClient" 指定为您希望使用 SwiftPhoenixClient 的 Target 的依赖项。

用法

使用 Swift Phoenix Client 非常简单(如果您使用过 phoenix.js 客户端,则会非常熟悉)。

有关详细说明,请参见 用法指南。 您还可以查看 文档

示例

查看此 repo 中的 ViewController,了解使用 Phoenix Chat Example 的简单 iOS 聊天应用程序的简要示例

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

开发

查看 wiki 页面以了解 入门指南

感谢

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

许可证

SwiftPhoenixClient 在 MIT 许可证下可用。 有关更多信息,请参见 LICENSE 文件。