在 Wear 上处理数据层事件

当您调用数据层 API 时，可以在调用完成时收到调用状态。您还可以监听由您的应用在 Wear OS by Google 网络上进行的任何数据更改所产生的数据事件。

有关有效使用数据层 API 的示例，请查看 Android DataLayer 示例应用。

等待数据层调用的状态

对数据层 API 的调用（例如使用 DataClient 类的 putDataItem 方法的调用）有时会返回一个 Task<ResultType> 对象。一旦创建 Task 对象，操作就会在后台排队。如果您在此之后不进行其他操作，该操作最终会静默完成。

然而，您通常希望在操作完成后对结果进行一些处理，因此 Task 对象允许您异步或同步地等待结果状态。

异步调用

如果您的代码在主 UI 线程上运行，请不要对数据层 API 进行阻塞调用。通过向 Task 对象添加回调方法来异步运行调用，该方法在操作完成时触发

Kotlin

// Using Kotlin function references
task.addOnSuccessListener(::handleDataItem)
task.addOnFailureListener(::handleDataItemError)
task.addOnCompleteListener(::handleTaskComplete)
...
fun handleDataItem(dataItem: DataItem) { ... }
fun handleDataItemError(exception: Exception) { ... }
fun handleTaskComplete(task: Task<DataItem>) { ... }

Java

// Using Java 8 Lambdas.
task.addOnSuccessListener(dataItem -> handleDataItem(dataItem));
task.addOnFailureListener(exception -> handleDataItemError(exception));
task.addOnCompleteListener(task -> handleTaskComplete(task));

有关其他可能性，包括链接不同任务的执行，请参阅 Task API。

同步调用

如果您的代码在后台服务中的单独处理程序线程上运行，例如在 WearableListenerService 中，则允许调用阻塞。在这种情况下，您可以在 Task 对象上调用 Tasks.await()，这将阻塞直到请求完成并返回一个 Result 对象。示例如下。

注意：请确保不要在主线程上调用此方法。

Kotlin

try {
    Tasks.await(dataItemTask).apply {
        Log.d(TAG, "Data item set: $uri")
    }
}
catch (e: ExecutionException) { ... }
catch (e: InterruptedException) { ... }

Java

try {
    DataItem item = Tasks.await(dataItemTask);
    Log.d(TAG, "Data item set: " + item.getUri());
} catch (ExecutionException | InterruptedException e) {
  ...
}

监听数据层事件

由于数据层在手持设备和可穿戴设备之间同步和发送数据，因此您通常需要监听重要事件，例如数据项的创建和消息的接收。

要监听数据层事件，您有两种选择

创建扩展 WearableListenerService 的服务。
创建实现 DataClient.OnDataChangedListener 接口的 activity 或类。

通过这两种选项，您可以重写您感兴趣的数据事件的回调方法。

注意：选择监听器实现时，请考虑应用的电池使用情况。WearableListenerService 在应用的清单中注册，如果应用尚未运行，它可以启动应用。如果您只需要在应用已运行时监听事件（交互式应用通常如此），则不要使用 WearableListenerService。而是注册一个实时监听器。例如，使用 DataClient 类的 addListener 方法。这可以减少系统负载并降低电池使用量。

使用 WearableListenerService

您通常在可穿戴应用和手持应用中都创建 WearableListenerService 的实例。但是，如果您对其中一个应用中的数据事件不感兴趣，则无需在该应用中实现该服务。

例如，您可以有一个手持应用，用于设置和获取数据项对象，以及一个可穿戴应用，用于监听这些更新以更新其 UI。可穿戴应用从不更新任何数据项，因此手持应用不监听来自可穿戴应用的任何数据事件。

您可以使用 WearableListenerService 监听的一些事件如下：

onDataChanged()：每当数据项对象被创建、删除或更改时，系统都会在所有连接的节点上触发此回调。
onMessageReceived()：从一个节点发送的消息会在目标节点上触发此回调。
onCapabilityChanged()：当您的应用实例通告的能力在网络上可用时，该事件会触发此回调。如果您正在寻找附近的节点，可以查询回调中提供的节点的 isNearby() 方法。

您还可以监听来自 ChannelClient.ChannelCallback 的事件，例如 onChannelOpened()。

所有上述事件都在后台线程中执行，而不是在主线程中执行。

要创建 WearableListenerService，请按照以下步骤操作：

创建一个扩展 WearableListenerService 的类。
监听您感兴趣的事件，例如 onDataChanged()。
在您的 Android 清单中声明一个意图过滤器，以通知系统您的 WearableListenerService。此声明允许系统根据需要绑定您的服务。

以下示例展示了如何实现一个简单的 WearableListenerService

Kotlin

private const val TAG = "DataLayerSample"
private const val START_ACTIVITY_PATH = "/start-activity"
private const val DATA_ITEM_RECEIVED_PATH = "/data-item-received"

class DataLayerListenerService : WearableListenerService() {

    override fun onDataChanged(dataEvents: DataEventBuffer) {
        if (Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(TAG, "onDataChanged: $dataEvents")
        }

        // Loop through the events and send a message
        // to the node that created the data item.
        dataEvents.map { it.dataItem.uri }
                .forEach { uri ->
                    // Get the node ID from the host value of the URI.
                    val nodeId: String = uri.host
                    // Set the data of the message to be the bytes of the URI.
                    val payload: ByteArray = uri.toString().toByteArray()

                    // Send the RPC.
                    Wearable.getMessageClient(this)
                            .sendMessage(nodeId, DATA_ITEM_RECEIVED_PATH, payload)
                }
    }
}

Java

public class DataLayerListenerService extends WearableListenerService {
    private static final String TAG = "DataLayerSample";
    private static final String START_ACTIVITY_PATH = "/start-activity";
    private static final String DATA_ITEM_RECEIVED_PATH = "/data-item-received";

    @Override
    public void onDataChanged(DataEventBuffer dataEvents) {
        if (Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(TAG, "onDataChanged: " + dataEvents);
        }

        // Loop through the events and send a message
        // to the node that created the data item.
        for (DataEvent event : dataEvents) {
            Uri uri = event.getDataItem().getUri();

            // Get the node ID from the host value of the URI.
            String nodeId = uri.getHost();
            // Set the data of the message to be the bytes of the URI.
            byte[] payload = uri.toString().getBytes();

            // Send the RPC.
            Wearable.getMessageClient(this).sendMessage(
                  nodeId,  DATA_ITEM_RECEIVED_PATH, payload);
        }
    }
}

以下部分解释了如何将意图过滤器与此监听器一起使用。

将过滤器与 WearableListenerService 一起使用

上一节中显示的 WearableListenerService 示例的意图过滤器可能如下所示

<service android:name=".DataLayerListenerService" android:exported="true" tools:ignore="ExportedService" >
  <intent-filter>
      <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
      <data android:scheme="wear" android:host="*"
               android:path="/start-activity" />
  </intent-filter>
</service>

在此过滤器中，DATA_CHANGED 操作取代了之前推荐的 BIND_LISTENER 操作，以便只有特定事件才能唤醒或启动您的应用。此更改提高了系统效率并减少了电池消耗以及与您的应用相关的其他开销。在此示例中，手表监听 /start-activity 数据项，手机监听 /data-item-received 消息响应。

标准 Android 过滤器匹配规则适用。您可以为每个清单指定多个服务，为每个服务指定多个意图过滤器，为每个过滤器指定多个操作，以及为每个过滤器指定多个数据节。过滤器可以匹配通配符主机或特定主机。要匹配通配符主机，请使用 host="*"。要匹配特定主机，请指定 host=<node_id>。

您还可以匹配字面路径或路径前缀。为此，您必须指定通配符或特定主机。否则，系统将忽略您指定的路径。

有关 Wear OS 支持的过滤器类型的更多信息，请参阅 WearableListenerService 的 API 参考文档。

有关数据过滤器和匹配规则的更多信息，请参阅 <data> 清单元素的 API 参考文档。

匹配意图过滤器时，请记住两条重要规则

如果未为意图过滤器指定方案，系统将忽略所有其他 URI 属性。
如果未为过滤器指定主机，系统将忽略所有路径属性。

使用实时监听器

如果您的应用只关心用户与应用交互时的数据层事件，它可能不需要长时间运行的服务来处理每个数据更改。在这种情况下，您可以通过实现以下一个或多个接口来在 activity 中监听事件：

要创建监听数据事件的 activity，请执行以下操作：

实现所需的接口。
在 onCreate() 或 onResume() 方法中，调用 Wearable.getDataClient(this).addListener()、MessageClient.addListener()、CapabilityClient.addListener() 或 ChannelClient.registerChannelCallback() 以通知 Google Play 服务您的 activity 对监听数据层事件感兴趣。
在 onStop() 或 onPause() 中，使用 DataClient.removeListener()、MessageClient.removeListener()、CapabilityClient.removeListener() 或 ChannelClient.unregisterChannelCallback() 注销任何监听器。
如果 activity 只对具有特定路径前缀的事件感兴趣，您可以添加一个带有合适前缀过滤器的监听器，以仅接收与当前应用程序状态相关的数据。
根据您实现的接口，实现 onDataChanged()、onMessageReceived()、onCapabilityChanged() 或 ChannelClient.ChannelCallback 中的方法。这些方法在主线程上调用，或者您可以使用 WearableOptions 指定自定义 Looper。

以下是实现 DataClient.OnDataChangedListener 的示例

Kotlin

class MainActivity : Activity(), DataClient.OnDataChangedListener {

    public override fun onResume() {
        Wearable.getDataClient(this).addListener(this)
    }

    override fun onPause() {
        Wearable.getDataClient(this).removeListener(this)
    }

    override fun onDataChanged(dataEvents: DataEventBuffer) {
        dataEvents.forEach { event ->
            if (event.type == DataEvent.TYPE_DELETED) {
                Log.d(TAG, "DataItem deleted: " + event.dataItem.uri)
            } else if (event.type == DataEvent.TYPE_CHANGED) {
                Log.d(TAG, "DataItem changed: " + event.dataItem.uri)
            }
        }
    }
}

Java

public class MainActivity extends Activity implements DataClient.OnDataChangedListener {

    @Override
    public void onResume() {
        Wearable.getDataClient(this).addListener(this);
    }

    @Override
    protected void onPause() {
        Wearable.getDataClient(this).removeListener(this);
    }

    @Override
    public void onDataChanged(DataEventBuffer dataEvents) {
        for (DataEvent event : dataEvents) {
            if (event.getType() == DataEvent.TYPE_DELETED) {
                Log.d(TAG, "DataItem deleted: " + event.getDataItem().getUri());
            } else if (event.getType() == DataEvent.TYPE_CHANGED) {
                Log.d(TAG, "DataItem changed: " + event.getDataItem().getUri());
            }
        }
    }
}

将过滤器与实时监听器一起使用

如前所述，就像您可以为基于清单的 WearableListenerService 对象指定意图过滤器一样，您也可以通过 Wearable API 注册实时监听器时使用意图过滤器。相同的规则适用于基于 API 的实时监听器和基于清单的监听器。

一种常见的模式是在 activity 的 onResume() 方法中注册带有特定路径或路径前缀的监听器，然后在 activity 的 onPause() 方法中移除该监听器。以这种方式实现监听器可以让您的应用更具选择性地接收事件，从而改善其设计和效率。

在 Wear 上处理数据层事件 使用收藏夹保持井然有序 根据您的偏好保存并分类内容。

等待数据层调用的状态

异步调用

Kotlin

Java

同步调用

Kotlin

Java

监听数据层事件

使用 WearableListenerService

Kotlin

Java

将过滤器与 WearableListenerService 一起使用

使用实时监听器

Kotlin

Java

将过滤器与实时监听器一起使用

在 Wear 上处理数据层事件