MongoDB Stitch iOS/Swift SDK
MongoDB Stitch 官方 iOS/Swift SDK。
索引
文档
讨论
安装
Xcode/iOS
CocoaPods
CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令进行安装
$ gem install cocoapods- 注意：需要 CocoaPods 1.6.0+ 才能构建 Stitch iOS SDK 5.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', '= 6.4.0'
# optional: for using the AWS service
pod 'StitchSDK/StitchAWSService', '= 6.4.0'
# optional: for using the Firebase Cloud Messaging service
pod 'StitchSDK/StitchFCMService', '= 6.4.0'
# optional: for using the HTTP service
pod 'StitchSDK/StitchHTTPService', '= 6.4.0'
# optional: for using the twilio service
pod 'StitchSDK/StitchTwilioService', '= 6.4.0'
end然后，运行以下命令
$ pod install打开由 pod install 生成的 .xcworkspace 文件，以便使用所有必要的 Stitch 依赖自动链接的您的项目
使用示例
使用 SDK 创建新应用程序（iOS）
在 Stitch 上设置应用程序
- 访问 https://stitch.mongodb.com/ 并登录到 MongoDB Atlas。
- 在项目中创建一个名为您所愿的新应用程序。
- 通过在左侧面板中点击“Stitch”并选择您的应用，通过Atlas访问您的应用。
- 从左侧面板的顶部复制您的Stitch App ID。
- 前往左侧面板中的用户页面，选择提供商标签，并启用“允许用户匿名登录”选项，以启用匿名身份验证。
使用Stitch在Xcode/CocoaPods中设置项目
-
下载并安装Xcode。
-
创建一个新应用项目，指定所需名称。确保选择Swift作为选定的语言。
- 注意：iOS 11.0是最低的iOS部署目标。
- 在命令行中导航到项目目录，并运行
pod init。 - 在生成的
Podfile中，在您应用的依赖项之下添加以下行
pod 'StitchSDK', '= 6.4.0'参见上方关于您可以在Podfile中添加的Stitch服务Pod的可选列表。
- 运行
pod install。 - 打开生成的
.xcworkspace文件。您的应用项目将配置所有必要的依赖项以与MongoDB Stitch进行通信。 - 要使用基本Stitch功能，在源文件中导入
import StitchCore。 - 要创建像ObjectId这样的BSON文档和BSON值，在源文件中导入
import MongoSwift。 - 要使用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"
)
print("Successfully initialized default Stitch app client!");
} catch {
// 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.
print("Failed to initialize MongoDB Stitch iOS SDK: \(error)")
}- 要获取用于登录和与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()方法执行一个Stitch Function
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))")
}
}- 如果您已经配置了名为“echoArg”的函数，该函数返回其参数，即
// Stitch Function called 'echoArg'
exports = function(arg) {
return arg;
};您应该在Xcode调试区域看到如下消息
String result: Hello world!
获取不带Stitch.defaultAppClient的StitchAppClient
如果不想使用单个默认初始化的StitchAppClient，可以使用以下方式以任何所需数量初始化多个App 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")