StitchCoreAWSS3Service 5.0.0-beta.3

StitchCoreAWSS3Service 5.0.0-beta.3

×

由以下人员维护：Jason Flax，Eric Daniels，Adam Chelminski.

StitchCoreAWSS3Service 5.0.0-beta.3

  • 由
  • 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 4.0+ 版本需要 CocoaPods 1.1.0+。

要使用 CocoaPods 在 Xcode 项目中集成 iOS SDK，请在您的 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', '= 5.0.0-beta.3'

    # optional: for using the AWS service
    pod 'StitchSDK/StitchAWSService', '= 5.0.0-beta.3'
    # optional: for using the Firebase Cloud Messaging service
    pod 'StitchSDK/StitchFCMService', '= 5.0.0-beta.3'
    # optional: for using the HTTP service
    pod 'StitchSDK/StitchHTTPService', '= 5.0.0-beta.3'
    # optional: for using the twilio service
    pod 'StitchSDK/StitchTwilioService', '= 5.0.0-beta.3'
end

然后，运行以下命令

$ pod install

打开由 pod install 创建的 .xcworkspace 文件以访问您的项目以及所有必要的 Stitch 依赖项，这些依赖项将自动链接。

示例用法

使用 SDK 创建新的应用（iOS）

在 Stitch 上设置应用

  1. 访问 https://stitch.mongodb.com/ 并登录到 MongoDB Atlas。
  2. 在您的项目中新创建一个应用，并输入您希望使用的名字。
  3. 通过点击左侧栏中的“Stitch Apps”并选择您的应用，访问您的应用。
  4. 通过点击左侧栏中的“Clients”并复制“App ID”部分来复制您的应用的客户端应用 ID。
  5. 通过在左侧栏中转到“Users”下的“Providers”并编辑启用“允许用户匿名登录”。

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

  1. 下载并安装XCode
  2. 创建一个名为你所需的新应用程序项目。确保已选择Swift作为语言。
  3. 在命令行中导航到项目目录，并运行pod init。
  4. 在生成的Podfile中，在应用程序目标的依赖关系下添加以下行
    pod 'StitchSDK', '= 5.0.0-beta.3'
  1. 运行pod install
  2. 打开生成的.xcworkspace文件
  3. 您的应用程序项目将配置所需的所有依赖项，以便与MongoDB Stitch通信。
  4. 要使用基本Stitch功能，在源文件中导入import StitchCore。
  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"
        )
    } catch {
        print("Failed to initialize MongoDB Stitch iOS SDK: \(error)")
        // 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.
    }
  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中的product，Run（或按⌘R）来运行您的应用程序。
  2. 应用程序启动后，通过转到View，Debug Area，Show Debug Area来打开调试区域。
  3. 您应该看到类似以下的信息
logging in anonymously                                                    	
logged in anonymously as user 58c5d6ebb9ede022a3d75050
执行一个函数
  1. 登录后，通过StitchClient的callFunction()方法执行函数。
    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"的函数，该函数返回其参数，则应看到以下类型的消息
String result: Hello world!
获取StitchAppClient而无需Stitch.defaultAppClient

如果您不想使用单个默认初始化的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")