开始使用

本文档介绍如何开始在 iOS 上使用 Nearby Messages API 进行开发。

第 1 步:获取最新版本的 Xcode

如需使用 iOS 版 Google Nearby Messages API 构建项目,您需要安装 6.3 版或更高版本的 Xcode

第 2 步:获取 CocoaPods

iOS 版 Google Nearby Messages API 以 CocoaPods pod 的形式提供。CocoaPods 是一种用于 Swift 和 Objective-C Cocoa 项目的开源依赖项管理器。

如果您尚未安装 CocoaPods 工具,请在 OS X 上从终端运行以下命令进行安装。如需了解详情,请参阅 CocoaPods 入门指南

$ sudo gem install cocoapods

第 3 步:使用 CocoaPods 安装 API

为 Google Nearby Messages API for iOS 创建 Podfile,并使用它来安装 API 及其依赖项。

  • 如果您还没有 Xcode 项目,请立即创建一个并将其保存到您的本地机器。(如果您刚开始接触 iOS 开发,请创建一个单视图应用,并确保已开启“使用自动引用计数”。)
  • 在您的项目目录中创建一个名为 Podfile 的文件。此文件用于定义项目的依赖项。
  • 修改 Podfile 并添加您的依赖项。以下是一个简单的 Podspec,其中包括 Google Nearby Messages API for iOS 所需的 Pod 名称:

    source 'https://github.com/CocoaPods/Specs.git'
    platform :ios, '7.0'
    pod 'NearbyMessages'

  • 保存 Podfile

  • 打开终端并转到包含 Podfile 的目录:

    $ cd

  • 运行 pod install 命令。此操作会安装 Podspec 中指定的 API 及其可能具有的任何依赖项。

    Pod 安装(美元)

  • 关闭 Xcode,然后打开(双击)您项目的 .xcworkspace 文件以启动 Xcode。从此刻开始,您必须使用 .xcworkspace 文件打开项目。

第 4 步:创建桥接标头(仅限 Swift)

如果您使用 Swift 创建项目,则必须为项目添加桥接标头,以便它可以使用 Pod 文件安装的库。如需添加桥接标头,请按以下步骤操作:

  1. 在项目的 .xcworkspace 文件所在的目录中,添加新的头文件(您可以随意为其命名,并使用“.h”作为文件扩展名)。
  2. 将以下代码粘贴到您创建的文件中:#import <GNSMessages.h>
  3. 保存文件。
  4. 在项目编辑器左侧窗格中,选择主项目。
  5. 点击构建编辑器顶部的 Build Settings
  6. 在“Build Settings”(构建设置)中,前往“Swift Compiler - Code Generation”(Swift 编译器 - 代码生成),在搜索框中输入“Swift Compiler”可快速找到它。
  7. 点击箭头以展开 Objective-C 桥接标头部分。
  8. DebugRelease 下,添加您创建的头文件的路径。
  9. 构建项目以使更改生效。

第 5 步:获取 Google 账号

您需要拥有一个 Google 帐号才能使用 Nearby Messages API。如果您已有账号,那么您已准备就绪。您可能还需要使用一个单独的 Google 帐号进行测试。

第 6 步:获取 API 密钥

请按照以下步骤启用 iOS 版 Google Nearby Messages API 并获取 API 密钥:

  1. 前往 Google Developers Console
  2. 创建或选择要注册应用的项目。
  3. 点击继续以启用 API。
  4. 凭据页面上,创建一个新的 iOS 密钥(并设置 API 凭据)。
    注意:如果您已有 iOS 密钥,则可以使用该密钥。
  5. 在出现的对话框中,输入应用的软件包标识符。例如:
    com.example.nearbyexample
  6. 您的新 iOS API 密钥会显示在项目的 API 密钥列表中。API 密钥是一串字符,如下所示:
    AIzaSyBdVl-cTICSwYKrZ95SuvNw7dbMuDt1KG0
  7. 为防止配额盗用,请遵循这些最佳实践保护您的 API 密钥。

第 7 步:创建消息管理器对象

通过消息管理器对象,您可以发布和订阅消息。消息交换不通过身份验证,因此您必须提供在上一步中创建的 API 密钥。

Objective-C

#import <GNSMessages.h>

GNSMessageManager *messageManager =
    [[GNSMessageManager alloc] initWithAPIKey:@"API_KEY"];

Swift

let messageManager = GNSMessageManager(APIKey: "API_KEY")