开始使用

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

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

如需使用 Google Nearby Messages API for iOS 构建项目，您需要使用 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 开发新手，请创建一个 Single View Application，并确保已开启“Use Automatic Reference Counting”[使用自动引用计数]。）
  • 在您的项目目录中创建一个名为 Podfile 的文件。此文件定义了项目的依赖项。

  • 修改 Podfile 并添加您的依赖项。下面是一个简单的 Podspec，其中包含适用于 iOS 的 Google Nearby Messages API 所需的 Pod 的名称： 

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

  • 保存 Podfile。

  • 打开终端，然后前往包含 Podfile 的目录：

    $ cd

  • 运行 pod install 命令。这将安装 Podspec 中指定的 API 以及它们可能具有的所有依赖项。

    $ pod install

  • 关闭 Xcode，然后打开（双击）项目的 .xcworkspace 文件以启动 Xcode。从现在开始，您必须使用 .xcworkspace 文件打开项目。

第 4 步：创建桥接头文件（仅限 Swift）

如果您使用 Swift 创建了项目，则必须向项目中添加桥接头文件，以便项目可以使用 Podfile 安装的库。请按照以下步骤添加桥接头文件：

  1. 在项目的 .xcworkspace 文件所在的同一目录中，添加一个新的头文件（您可以随意命名，但要使用“.h”文件名扩展名）。
  2. 将以下代码粘贴到您创建的文件中：#import <GNSMessages.h>。
  3. 保存文件。
  4. 在项目编辑器左侧窗格中，选择主项目。
  5. 点击构建编辑器顶部的构建设置。
  6. 在“Build Settings”（构建设置）中，找到“Swift Compiler - Code Generation”（Swift 编译器 - 代码生成）（在搜索框中输入“Swift Compiler”可快速找到该设置）。
  7. 点击箭头以展开 Objective-C Bridging Header 部分。
  8. 在 Debug 和 Release 下，添加您创建的头文件的路径。
  9. 构建项目以使更改生效。

第 5 步：获取 Google 账号

如需使用 Nearby Messages API，您需要一个 Google 账号。如果您已经具有账号，则您已准备就绪。您可能还需要一个用来测试的单独 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")