StitchSDK 6.4.0

StitchSDK 6.4.0

×

由以下用户维护：Jason Flax，Eric Daniels，Adam Chelminski。

StitchSDK 6.4.0

  • 由
  • Jason Flax，Adam Chelminski 和 Eric Daniels 编写

iOS Swift 4.0 Apache 2.0 License Cocoapods compatible

MongoDB Stitch iOS/Swift SDK

MongoDB Stitch 的官方 iOS/Swift SDK。

索引

文档

讨论

安装

Xcode/iOS

CocoaPods

CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令进行安装

$ gem install cocoapods
  • 注意：构建 Stitch iOS SDK 5.0+ 需要 CocoaPods 1.6.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 上设置应用

  1. 转到 https://stitch.mongodb.com/ 并登录 MongoDB Atlas。
  2. 在项目中创建一个新应用，并输入您希望使用的名称。
  3. 通过点击左侧面板中的“Stitch”以及您的应用来通过 Atlas 进入您的应用。
  4. 复制左侧面板顶部的您的 Stitch App ID。
  5. 通过转到左侧面板中的“用户”页面，选择“提供者”选项卡，并启用“允许用户匿名登录”选项来启用匿名认证。

使用Stitch在Xcode/CocoaPods中设置项目

  1. 下载并安装Xcode.

  2. 创建一个新应用项目，输入您希望的项目名称。确保选择Swift作为编程语言。

  • 注意：iOS 11.0是最小iOS部署目标。
  1. 在命令行中导航到项目所在的目录，并运行pod init。
  2. 在生成的Podfile中，在应用目标的依赖项下添加以下行
    pod 'StitchSDK', '= 6.4.0'

见上，根据您可能添加到Podfile的Stitch服务Pod的选择列表。

  1. 运行pod install。
  2. 打开生成的.xcworkspace文件。您的应用项目将配置所有必要的依赖项以与MongoDB Stitch通信。
  3. 要使用基本Stitch功能，在一个源文件中导入import StitchCore。
  4. 要创建类似ObjectId的BSON文档和BSON值，在一个源文件中导入import MongoSwift。
  5. 要通过Stitch访问远程MongoDB实例，在一个源文件中导入import StitchRemoteMongoDBService

使用SDK

初始化SDK

  1. 当您的应用初始化时，请运行以下代码来初始化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)")
    }
  1. 要获取一个客户端用于登录和与Stitch通信，使用Stitch.defaultAppClient。
    // in a view controller's properties, for example
    private lazy var stitchClient = Stitch.defaultAppClient!
登录
  1. 我们启用了匿名登录，所以让我们使用它来登录！在任何地方添加以下代码
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)")
      }
  }
  1. 现在通过Xcode运行您的应用，转到产品，运行（或按⌘R）。
  2. 一旦应用正在运行，打开调试区域，转到视图，调试区域，显示调试区域。
  3. 您应该看到以下日志消息
logging in anonymously                                                    	
logged in anonymously as user 58c5d6ebb9ede022a3d75050
执行函数
  1. 登录后，您可以使用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))")
        }
    }
  1. 如果您已配置Stitch应用程序有一个名为"echoArg"的函数，它返回其参数，例如：
// Stitch Function called 'echoArg'
exports = function(arg) {
  return arg;
};

那么您应该在Xcode调试区域看到如下消息

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")