StitchRemoteMongoDBService 6.4.0

StitchRemoteMongoDBService 6.4.0

×

由Jason Flax、Eric Daniels、Adam Chelminski 维护。

 
依赖项
StitchCore= 6.4.0
StitchCoreRemoteMongoDBService= 6.4.0
 

StitchRemoteMongoDBService 6.4.0

  • 由
  • Jason Flax、Adam Chelminski 和 Eric Daniels

iOS Swift 4.0 Apache 2.0 License Cocoapods compatible

MongoDB Stitch iOS/Swift SDK

适用于 iOS/Swift 的官方 MongoDB Stitch 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 上设置应用程序

  1. 访问 https://stitch.mongodb.com/ 并登录到 MongoDB Atlas。
  2. 在项目中创建一个新应用，并使用您希望使用的名称。
  3. 通过左侧窗格中点击 'Stitch' 并点击您的应用，在 Stitch 中访问您的应用。
  4. 从左侧窗格顶部复制您的 Stitch 应用 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。在 application(_:didFinishLaunchWithOptions) 方法中，您的 AppDelegate.swift 是一个初始化步骤的适当位置。请确保导入 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 中转到“Product”，然后选择“Run”（或按下 ⌘R）来运行您的应用程序。
  2. 应用程序运行后，通过转到“View”，“Debug Area”，“Show Debug Area”来打开调试区域。
  3. 您应看到类似以下的消息
logging in anonymously                                                    	
logged in anonymously as user 58c5d6ebb9ede022a3d75050
执行一个函数
  1. 登录后，您可以使用StitchClient的callFunction()方法执行一个Stitch函数
    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，您可以使用以下方法，以便为多个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")