MongoDB Stitch iOS/Swift SDK
MongoDB Stitch 的官方 iOS/Swift SDK。
索引
文档
讨论
安装
CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它：
$ gem install cocoapodsCocoaPods 1.1.0+ 是构建 Stitch iOS 4.0+ 所必需的。
要将 iOS SDK 集成到您的 Xcode 项目中使用 CocoaPods，请在您的 Podfile 中指定它：
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '11.0'
use_frameworks!
target '<Your Target Name>' do
# For core functionality and the Remote MongoDB Service
pod 'StitchSDK', '= 5.0.0-beta.3'
# optional: for using the AWS service
pod 'StitchSDK/StitchAWSService', '= 5.0.0-beta.3'
# optional: for using the Firebase Cloud Messaging service
pod 'StitchSDK/StitchFCMService', '= 5.0.0-beta.3'
# optional: for using the HTTP service
pod 'StitchSDK/StitchHTTPService', '= 5.0.0-beta.3'
# optional: for using the twilio service
pod 'StitchSDK/StitchTwilioService', '= 5.0.0-beta.3'
end然后，运行以下命令：
$ pod install打开由 pod install 生成的 .xcworkspace 文件，使用自动链接的所有必要的 Stitch 依赖访问您的项目。
示例使用
使用 SDK 创建新的 iOS 应用程序
在 Stitch 上设置应用程序
- 转至 https://stitch.mongodb.com/ 并登录到 MongoDB Atlas。
- 在您的项目中创建一个名为您所需的新应用程序。
- 通过在左侧面板中点击 Stitch Apps 并点击您的应用程序，通过 Atlas 侧面板访问您的应用程序。
- 通过左侧面板中的客户端分区，点击 App ID 分区的复制按钮，复制您的应用程序的客户端应用程序 ID。
- 通过左侧面板中的用户，转到提供者并编辑并启用“允许用户匿名登录”。
在XCode/CocoaPods中使用Stitch设置项目
- 下载并安装XCode
- 使用您期望的名称创建一个新的应用项目。请确保已选择Swift作为所选语言。
- 使用命令行导航到项目中，并运行
pod init。 - 在生成的
Podfile中，在您的应用目标依赖项下添加以下行
pod 'StitchSDK', '= 5.0.0-beta.3'- 运行
pod install - 打开生成的
.xcworkspace文件 - 您的应用项目将配置所有必要的依赖项，以与MongoDB Stitch进行通信。
- 要使用基本Stitch功能，在源文件中导入
import StitchCore。 - 要访问Stitch通过远程MongoDB实例，在源文件中导入
import StitchRemoteMongoDBService。
使用SDK
初始化SDK
- 当您的应用初始化完毕时，运行以下代码以初始化Stitch SDK。您的
AppDelegate.swift中的application(_:didFinishLaunchWithOptions)方法可以是此初始化步骤的合适位置。请确保导入import StitchCore。
// at the top of the file
import StitchCore
// in `application(_:didFinishLaunchWithOptions)`
do {
_ = try Stitch.initializeDefaultAppClient(
withClientAppID: "your-client-app-id"
)
} catch {
print("Failed to initialize MongoDB Stitch iOS SDK: \(error)")
// note: This initialization will only fail if an incomplete configuration is
// passed to a client initialization method, or if a client for a particular
// app ID is initialized multiple times. See the documentation of the "Stitch"
// class for more details.
}- 要获取用于登录和与Stitch通信的客户端，使用
Stitch.defaultAppClient。
// in a view controller's properties, for example
private lazy var stitchClient = Stitch.defaultAppClient!登录
- 我们启用了匿名登录，所以让我们用它来登录；在代码中的任意位置添加以下内容
let client = Stitch.defaultAppClient!
print("logging in anonymously")
client.auth.login(withCredential: AnonymousCredential()) { result in
switch result {
case .success(let user):
print("logged in anonymous as user \(user.id)")
DispatchQueue.main.async {
// update UI accordingly
}
case .failure(let error):
print("Failed to log in: \(error)")
}
}- 现在通过在XCode中转到产品，运行（或按⌘R）来运行您的应用。
- 一旦应用运行，通过转到查看，调试区域，显示调试区域来打开调试区域。
- 您应该看到类似的日志消息
logging in anonymously
logged in anonymously as user 58c5d6ebb9ede022a3d75050
执行函数
- 登录后，执行函数是通过StitchClient的
callFunction()方法实现的
client.callFunction(
withName: "echoArg", withArgs: ["Hello world!"], withRequestTimeout: 5.0
) { (result: StitchResult<String>) in
switch result {
case .success(let stringResult):
print("String result: \(stringResult)")
case .failure(let error):
print("Error retrieving String: \(String(describing: error))")
}
}- 如果你的Stitch应用程序已配置名为“echoArg”的函数，返回其参数，你应该会看到一个如下消息：
String result: Hello world!
在不使用Stitch.defaultAppClient的情况下获取StitchAppClient
如果你不希望只有一个默认初始化的StitchAppClient，你可以使用以下方法，根据你需要的多个应用程序ID初始化任意数量的客户端
do {
let client1 = try Stitch.initializeAppClient(withClientAppID: "your-first-client-app-id")
let client2 = try Stitch.initializeAppClient(withClientAppID: "your-second-client-app-id")
} catch {
print("Failed to initialize MongoDB Stitch iOS SDK: \(error.localizedDescription)")
}你可以在应用程序的任何地方使用返回的客户端
let client1 = try! Stitch.appClient(forAppID: "your-first-client-app-id")
let client2 = try! Stitch.appClient(forAppID: "your-second-client-app-id")