MongoDB Stitch iOS/Swift SDK
MongoDB Stitch官方iOS/Swift SDK。
索引
文档
讨论
安装
XCode/iOS
CocoaPods
CocoaPods 是 Cocoa 项目的一个依赖管理器。您可以使用以下命令安装它:
$ gem install cocoapods
CocoaPods 1.1.0+ 是构建 Stitch iOS 4.0+ 所必需的。
要使用 CocoaPods 将 iOS SDK 集成到您的 Xcode 项目中,请在您的 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 并选择您的应用来访问您的应用。
- 复制客户端应用 ID,进入左侧面板的 Clients 部分,在 App ID 部分点击复制。
- 从左侧面板的用户部分进入 Providers 并编辑和启用 "允许用户匿名登录"。
使用Stitch在XCode/CocoaPods中设置项目
- 下载并安装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初始化客户端,您可以根据需要指定任意数量的客户端应用程序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")