StitchCoreAWSService 6.4.0

StitchCoreAWSService 6.4.0

×

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

StitchCoreAWSService 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'，然后点击您应用来进入 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 服务库。

  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函数}
    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初始化客户端，并且可以指定任意数量的客户端应用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")