移动设备上的 Recording API

借助移动设备上的 Recording API，您的应用可以在移动设备上以省电的方式记录步数。该 API 无需帐号，这意味着它不需要 Google 帐号即可使用服务，并且数据存储在设备上。

本指南介绍了如何在移动设备上使用 Recording API 来打造健康与健身体验。

重要细节

Recording API 在移动设备上具有一些独有的重要功能：

• 录音订阅开始后，设备上最多存储 10 天的数据。
• 仅当存在有效订阅时，系统才会提供相关数据。如果通过调用 unsubscribe 移除订阅，则将无法访问收集到的步骤数据。

数据类型

移动设备上的 Recording API 可以记录以下类型的数据：

• TYPE_STEP_COUNT_DELTA

开始使用

首先，在 build.gradle 文件中添加以下依赖项：

plugin {
  id("com.android.application")
}

...

dependencies {
  implementation("com.google.android.gms:play-services-fitness:21.2.0")
}

apply plugin: 'com.android.application'

...

dependencies {
  implementation 'com.google.android.gms:play-services-fitness:21.2.0'
}

请求权限

如需在移动设备上使用 Recording API 录制数据，您的应用需要请求以下权限：

• android.permission.ACTIVITY_RECOGNITION

订阅健身数据

如需请求在后台收集步数、距离或卡路里数据，请使用 subscribe 方法，如以下代码段所示：

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Subscribe to steps data
localRecordingClient.subscribe(DataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully subscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem subscribing.", e)
  }

读取和处理健身数据

订阅后，使用 readData 方法请求数据。然后，您可以通过创建 DataReadRequest 从生成的 DataSet 中获取 DataPoint，如以下代码段所示：

val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
val readRequest =
  DataReadRequest.Builder()
    // The data request can specify multiple data types to return,
    // effectively combining multiple data queries into one call.
    // This example demonstrates aggregating only one data type.
    .aggregate(DataType.AGGREGATE_STEP_COUNT_DELTA)
    // Analogous to a "Group By" in SQL, defines how data should be
    // aggregated. bucketByTime allows bucketing by time span.
    .bucketByTime(1, TimeUnit.DAYS)
    .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .build()

  localRecordingClient.readData(readRequest).addOnSuccessListener { response ->
    // The aggregate query puts datasets into buckets, so flatten into a
    // single list of datasets.
    for (dataSet in response.buckets.flatMap { it.dataSets }) {
      dumpDataSet(dataSet)
    }
  }
  .addOnFailureListener { e ->
    Log.w(TAG,"There was an error reading data", e)
  }

fun dumpDataSet(dataSet: DataSet) {
  Log.i(TAG, "Data returned for Data type: ${dataSet.dataType.name}")
  for (dp in dataSet.dataPoints) {
    Log.i(TAG,"Data point:")
    Log.i(TAG,"\tType: ${dp.dataType.name}")
    Log.i(TAG,"\tStart: ${dp.getStartTimeString()}")
    Log.i(TAG,"\tEnd: ${dp.getEndTimeString()}")
    for (field in dp.dataType.fields) {
      Log.i(TAG,"\tField: ${field.name.toString()} Value: ${dp.getValue(field)}")
    }
  }
}

LocalRecordingClient 会持续更新其数据收集。您可以随时使用 readData 拉取最新的数字。

请注意，LocalRecordingClient 最多可存储 10 天的数据。为了降低数据丢失的风险，您可以使用 WorkManager 在后台定期收集数据。

退订健身数据

为了释放资源，当您的应用不再需要传感器数据时，您应确保退订传感器数据收集。如需退订，请使用 unsubscribe 方法：

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Unsubscribe from steps data
localRecordingClient.unsubscribe(DataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully unsubscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem unsubscribing.", e)
  }