StitchCoreSDK 6.4.0

StitchCoreSDK 6.4.0

×

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

StitchCoreSDK 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 依赖的 project。

示例用途

使用 SDK 创建新应用（iOS）

在 Stitch 上设置应用

  1. 前往 https://stitch.mongodb.com/ 并登录到 MongoDB Atlas。
  2. 在项目中创建一个您的名字的新应用。
  3. 通过点击左侧面板中的“Stitch”并点击您应用来通过 Atlas 访问您的应用。
  4. 从左侧面板顶部复制您的 Stitch App ID。
  5. 通过前往左侧面板中的“用户”页面、选择“提供者”标签并启用“允许用户匿名登录”选项来启用匿名身份验证。

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

  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. 要创建BSON文档和ObjectId之类的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函数
    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")