StitchCoreHTTPService 6.4.0

StitchCoreHTTPService 6.4.0

×

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

StitchCoreHTTPService 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 SDK，用于 iOS/Swift。

索引

文档

讨论

安装

主任码/iOS

CocoPods

CocoPods 是一个用于 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' 并选择您的应用来访问您在 Stitch 中的应用。
  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'

请参阅上面列出的Stitch服务Pod，您可以将它们添加到Podfile中。

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