发布和订阅

Nearby Messages API 是一种发布-订阅 API，可让附近的设备交换少量载荷。设备发布消息后，附近的设备就可以收到该消息。消息大小应保持在相当小的水平以保持良好的性能。此服务不适用于交换较大的对象，例如照片和视频。

附近的设备集由通过蓝牙和近超声波（听不见）音频交换小令牌来确定。当设备从附近设备检测到令牌时，它会将该令牌发送到“附近消息”服务器进行验证，并检查对于应用的当前订阅集是否有任何消息要传送。

应用可以控制用于设备发现的媒介集，以及这些媒介是否用于广播令牌和/或扫描令牌。默认情况下，系统会在所有媒介上执行广播和扫描操作。如需在子集上执行发现操作，并控制是广播还是扫描，您必须在创建发布内容和订阅时传递其他参数。

此库可在 iOS 7 及更高版本上运行，并使用 iOS 8 SDK 进行构建。

创建消息管理器

这段代码会创建一个消息管理器对象，让您可以发布和订阅消息。消息交换无需身份验证，因此您必须为 iOS 提供公共 API 密钥。您可以使用项目的 Google Developers Console 条目创建一个。

Objective-C

#import <GNSMessages.h>

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

Swift

let messageManager = GNSMessageManager(APIKey: "API_KEY")

发布消息

以下代码段演示了如何发布包含名称的消息。只要发布内容对象存在，发布内容就会一直有效。如需停止发布，请释放发布内容对象。

Objective-C

id<GNSPublication> publication =
    [messageManager publicationWithMessage:[GNSMessage messageWithContent:[name dataUsingEncoding:NSUTF8StringEncoding]]];

Swift

let publication =
    messageManager.publication(with: GNSMessage(content: name.data(using: .utf8)))

订阅邮件

此代码段演示了如何订阅上一个发布内容代码段共用的所有名称。只要订阅对象存在，订阅就会处于活跃状态。如需停止订阅，请释放订阅对象。

当发现附近正在发布消息的设备时，系统会调用“已找到消息”处理程序。当不再观察到消息（设备超出范围或不再发布消息）时，系统会调用消息丢失处理程序。

Objective-C

id<GNSSubscription> subscription =
    [messageManager subscriptionWithMessageFoundHandler:^(GNSMessage *message) {
      // Add the name to a list for display
    }
    messageLostHandler:^(GNSMessage *message) {
      // Remove the name from the list
    }];

Swift

let subscription =
    messageManager.subscription(messageFoundHandler: { (message: GNSMessage?) in
      // Add the name to a list for display
    },
    messageLostHandler: { (message: GNSMessage?) in
      // Remove the name from the list
    })

发现媒体

默认情况下，这两种媒介（音频和蓝牙）都将用于发现附近的设备，并且这两种媒介都会广播和扫描。在某些情况下，您需要将以下条目添加到应用的 Info.plist：

  • 如果您的应用使用音频进行扫描，请添加 NSMicrophoneUsageDescription，它是一个字符串，用于说明您使用麦克风的原因。例如，“麦克风监听来自附近设备的匿名令牌。”

  • 如果您的应用使用 BLE 进行广播，请添加 NSBluetoothPeripheralUsageDescription，这是一个字符串，用于说明您为何要在 BLE 上广播。例如，“通过蓝牙通告匿名令牌，以发现附近的设备。”

在某些情况下，您的应用可能只需要使用其中一种媒介，可能不需要在该媒介上同时进行广播和扫描。

例如，如果应用旨在连接到通过音频广播的机顶盒，则只需扫描音频即可发现它。以下代码段展示了如何仅使用音频扫描将消息发布到该机顶盒以发现消息：

Objective-C

id<GNSPublication> publication = [messageManager publicationWithMessage:message
    paramsBlock:^(GNSPublicationParams *params) {
      params.strategy = [GNSStrategy strategyWithParamsBlock:^(GNSStrategyParams *params) {
        params.discoveryMediums = kGNSDiscoveryMediumsAudio;
        params.discoveryMode = kGNSDiscoveryModeScan;
      }];
    }];

Swift

let publication = messageManager.publication(with: message,
    paramsBlock: { (params: GNSPublicationParams?) in
      guard let params = params else { return }
      params.strategy = GNSStrategy(paramsBlock: { (params: GNSStrategyParams?) in
        guard let params = params else { return }
        params.discoveryMediums = .audio
        params.discoveryMode = .scan
      })
    })

启用调试日志记录

调试日志记录会将重要的内部事件输出到控制台，有助于您跟踪在将“附近消息”功能集成到您的应用中时可能遇到的问题。如果您与我们联系以获得技术支持，我们会要求您提供这些日志。

您应先启用它，然后再创建消息管理器。以下代码段展示了如何启用调试日志记录：

Objective-C

[GNSMessageManager setDebugLoggingEnabled:YES];

Swift

GNSMessageManager.setDebugLoggingEnabled(true)

跟踪“附近分享”权限状态

需要征得用户同意才能启用设备发现功能。这是由 Nearby 权限状态指明的。首次调用创建发布内容或订阅时，系统会向用户显示意见征求对话框。如果用户不同意，设备发现功能将不起作用。在这种情况下，您的应用应显示一条消息，提醒用户设备发现功能已停用。权限状态存储在 NSUserDefaults 中。

以下代码段演示了如何订阅权限状态。每当状态发生变化时，系统都会调用权限状态已更改的处理程序，并且在用户授予或拒绝权限之前不会首次调用该处理程序。释放权限对象以停止订阅。

Objective-C

GNSPermission *nearbyPermission = [[GNSPermission alloc] initWithChangedHandler:^(BOOL granted) {
  // Update the UI here
}];

Swift

let nearbyPermission = GNSPermission(changedHandler: { (granted: Bool) in
  // Update the UI here
})

应用可以为用户提供更改权限状态的方法，例如使用设置页面上的切换开关。

以下示例展示了如何获取和设置权限状态。

Objective-C

BOOL permissionState = [GNSPermission isGranted];
[GNSPermission setGranted:!permissionState];  // toggle the state

Swift

let permissionState = GNSPermission.isGranted()
GNSPermission.setGranted(!permissionState)  // toggle the state

跟踪会影响“附近”功能的用户设置

如果用户拒绝授予麦克风权限、拒绝蓝牙权限或已关闭蓝牙，“附近”功能将无法正常运行，或根本无法运行。在这种情况下，您的应用应显示一条消息，提醒用户“附近”功能的操作受阻。以下代码段展示了如何在创建消息管理器时通过传递处理程序来跟踪这些用户设置的状态：

Objective-C

GNSMessageManager *messageManager = [[GNSMessageManager alloc]
    initWithAPIKey:API_KEY
       paramsBlock:^(GNSMessageManagerParams *params) {
         params.microphonePermissionErrorHandler = ^(BOOL hasError) {
           // Update the UI for microphone permission
         };
         params.bluetoothPowerErrorHandler = ^(BOOL hasError) {
           // Update the UI for Bluetooth power
         };
         params.bluetoothPermissionErrorHandler = ^(BOOL hasError) {
           // Update the UI for Bluetooth permission
         };
}];

Swift

let messageManager = GNSMessageManager(
         APIKey: API_KEY,
    paramsBlock: { (params: GNSMessageManagerParams?) in
      guard let params = params else { return }
      params.microphonePermissionErrorHandler = { (hasError: Bool) in
        // Update the UI for microphone permission
      }
      params.bluetoothPowerErrorHandler = { (hasError: Bool) in
        // Update the UI for Bluetooth power
      }
      params.bluetoothPermissionErrorHandler = { (hasError: Bool) in
        // Update the UI for Bluetooth permission
      }
    })

替换“附近分享”权限对话框

根据您传递到发布内容和订阅的参数，iOS 可能会先请求各种权限，然后才能允许“附近”功能运行。例如，默认策略会监听通过近超声波音频传输的数据，因此 iOS 会请求获得使用麦克风的权限。在这种情况下，“附近”功能将显示“预检”对话框，说明请求用户授予权限的原因。

如果您要提供自定义“预检”对话框，请在发布或订阅参数中将 permissionRequestHandler 参数设置为自定义分块。您的自定义代码块必须在用户响应后调用 permissionHandler 代码块。以下代码段展示了如何对发布内容执行此操作：

Objective-C

id<GNSPublication> publication =
    [messageManager publicationWithMessage:[GNSMessage messageWithContent:[name dataUsingEncoding:NSUTF8StringEncoding]]
                               paramsBlock:^(GNSPublicationParams *params) {
                                 params.permissionRequestHandler = ^(GNSPermissionHandler permissionHandler) {
                                   // Show your custom dialog here.
                                   // Don't forget to call permissionHandler() with YES or NO when the user dismisses it.
                                 };
                               }];

Swift

let publication =
    messageManager.publication(with: GNSMessage(content: name.data(using: .utf8)),
        paramsBlock: { (params: GNSPublicationParams?) in
          guard let params = params else { return }
          params.permissionRequestHandler = { (permissionHandler: GNSPermissionHandler?) in
            // Show your custom dialog here.
            // Don't forget to call permissionHandler() with true or false when the user dismisses it.
          }
        })

后台操作

使用 BLE 进行设备发现的发布内容和订阅可以在后台运行。在决定使用后台模式时，请注意以下事项：

  • 后台操作只能使用 BLE 媒介；不支持音频。
  • 使用后台 BLE 会增加额外的电池成本。费用很低，但您应该先进行衡量，然后再决定是否使用后台模式。
  • iOS 会请求用户授予在后台通过 BLE 进行广播的权限。

如需为发布内容或订阅添加后台模式，请按照以下额外步骤操作：

  • 通过传入正确配置的 GNSStrategy 对象，在您的发布内容或订阅中启用后台模式和仅限 BLE。以下代码段展示了如何为订阅执行此操作：

    Objective-C

    id<GNSSubscription> subscription =
    [messageManager subscriptionWithMessageFoundHandler:^(GNSMessage *message) {
      // Add the name to a list for display
    }
    messageLostHandler:^(GNSMessage *message) {
      // Remove the name from the list
    }
    paramsBlock:^(GNSSubscriptionParams *params) {
      params.strategy = [GNSStrategy strategyWithParamsBlock:^(GNSStrategyParams *params) {
        params.allowInBackground = YES;
        params.discoveryMediums = kGNSDiscoveryMediumsBLE;
      }];
    }];

    Swift

    let subscription =
    messageManager.subscription(messageFoundHandler: { (message: GNSMessage?) in
      // Add the name to a list for display
    },
    messageLostHandler: { (message: GNSMessage?) in
      // Remove the name from the list
    },
    paramsBlock:{ (params: GNSSubscriptionParams?) in
      guard let params = params else { return }
      params.strategy = GNSStrategy(paramsBlock: { (params: GNSStrategyParams?) in
        guard let params = params else { return }
        params.allowInBackground = true
        params.discoveryMediums = .BLE
      })
    })

  • 将以下条目添加到应用的 Info.plist：

    • UIBackgroundModes 个条目：

      • bluetooth-central，用于在后台进行 BLE 扫描。仅当发现模式包含扫描时才需要；默认情况下有扫描。
      • bluetooth-peripheral，适用于后台 BLE 通告。仅当发现模式包含广播时才需要；默认情况下需要广播。

    • NSBluetoothPeripheralUsageDescription 字符串，用于说明您为何要在 BLE 上提供广告。例如，“通过蓝牙通告匿名令牌，以发现附近的设备。”如需了解详情，请参阅 Apple 文档。

  • 您的应用可能在后台被系统随时终止。如果后台模式是一项可由用户启用或停用的设置，您的应用应执行以下操作：

    • 每当用户更改后台模式值时，都会将其保存到 NSUserDefaults。
    • 启动时，从 NSUserDefaults 中读取相应信息，并恢复“附近”功能发布和/或订阅（如果启用了后台模式）。

后台通知

如果您希望应用在后台订阅收到消息时通知用户，您可以使用本地通知。

请按照以下步骤将其添加到您的应用中：

  • 在启动时注册本地通知：

    Objective-C

    if ([UIApplication instancesRespondToSelector:@selector(registerUserNotificationSettings:)]) {
  [[UIApplication sharedApplication] registerUserNotificationSettings:
      [UIUserNotificationSettings settingsForTypes:
          UIUserNotificationTypeAlert | UIUserNotificationTypeBadge | UIUserNotificationTypeSound
                                        categories:nil]];
}

    Swift

    UIApplication.shared.registerUserNotificationSettings(
    UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil))

  • 在订阅的消息找到处理程序中发送本地通知：

    Objective-C

    GNSMessageHandler myMessageFoundHandler = ^(GNSMessage *message) {
    // Send a local notification if not in the foreground.
    if ([UIApplication sharedApplication].applicationState != UIApplicationStateActive) {
      UILocalNotification *localNotification = [[UILocalNotification alloc] init];
      localNotification.alertBody = @"Message received";
      [[UIApplication sharedApplication] presentLocalNotificationNow:localNotification];
    }
    // Process the new message...
  };

    Swift

    let myMessageFoundHandler: GNSMessageHandler = { (message: GNSMessage?) in
  // Send a local notification if not in the foreground.
  if UIApplication.shared.applicationState != .active {
    let localNotification = UILocalNotification()
    localNotification.alertBody = "Message received"
    UIApplication.shared.presentLocalNotificationNow(localNotification)
  }
  // Process the new message...
}