StitchCoreLocalMongoDBService 6.4.0

StitchCoreLocalMongoDBService 6.4.0

×

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

 
依赖项
MongoMobile= 0.1.0
StitchCoreSDK= 6.4.0
 

StitchCoreLocalMongoDBService 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访问您的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 的“产品”，然后选择“运行”（或按 ⌘R）来在 Xcode 中运行您的应用。
  2. 一旦应用开始运行，通过转到“视图”，“调试区域”，“显示调试区域”来打开调试区域。
  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")