发布和订阅

Nearby Messages API 是一种发布-订阅 API，可让附近的设备交换小型数据载荷。设备发布消息后，附近的设备便可接收该消息。消息大小应保持相当小，以便保持良好的性能。此服务不适用于交换照片和视频等较大对象。

附近设备组由通过蓝牙和近超声波（人耳听不到）音频交换的小令牌决定。当设备检测到附近设备发送的令牌时，它会将令牌发送到 Nearby Messages 服务器进行验证，并检查是否有任何消息要传送给应用的当前订阅集。

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

此库可在 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)

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

必须征得用户同意才能启用设备发现功能。这由“附近分享”权限状态指示。在首次调用以创建发布或订阅时，系统会向用户显示意见征求对话框。如果用户不同意，设备发现功能将无法正常运行。在这种情况下，您的应用应显示一条消息，提醒用户设备发现功能已停用。权限状态存储在 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...
}