StitchLocalMongoDBService 6.4.0

StitchLocalMongoDBService 6.4.0

×

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

 
依赖关系
StitchCore= 6.4.0
StitchCoreLocalMongoDBService= 6.4.0
 

StitchLocalMongoDBService 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进入您的应用。
  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'

参考上面的列表，您可以在Podfile中添加可选的Stitch服务监听器。

  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的客户端，可以设置任意数量的客户端应用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")