借助移动版 Recording API,您的应用可以以省电的方式从移动设备记录步数,类似于步数计从移动设备检索步数数据。此 API 无需账号,这意味着无需 Google 账号即可使用该服务,并且数据会存储在设备端。
本指南介绍了如何在移动设备上的健康与健身体验中使用 Recording API。
值得注意的详细信息
移动版 Recording API 具有一些独特的显著功能:
- 录制订阅开始或续订后,您可以访问最新订阅以来的数据(最多 10 天)。
- 只有在订阅有效时,系统才会提供数据。如果通过调用
unsubscribe
移除订阅,则无法访问收集的步数数据。
数据类型
移动版 Recording API 可以记录以下数据类型:
开始使用
首先,在 build.gradle
文件中添加以下依赖项:
Kotlin DSL
plugin {
id("com.android.application")
}
...
dependencies {
implementation("com.google.android.gms:play-services-fitness:21.2.0")
}
Groovy DSL
apply plugin: 'com.android.application'
...
dependencies {
implementation 'com.google.android.gms:play-services-fitness:21.2.0'
}
请求权限
如需在移动设备上使用 Recording API 录制数据,您的应用需要请求以下权限:
android.permission.ACTIVITY_RECOGNITION
执行 Play 服务版本检查
如需在移动设备上使用 Recording API,用户必须将 Google Play 服务更新到 LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE
。您可以使用 isGooglePlayServicesAvailable
方法进行检查:
val hasMinPlayServices = isGooglePlayServicesAvailable(context, LocalRecordingClient.LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE)
if(hasMinPlayServices != ConnectionResult.SUCCESS) {
// Prompt user to update their device's Google Play services app and return
}
// Continue with Recording API functions
否则,如果用户的 Google Play 服务版本过低,系统会抛出 ConnectionResult.SERVICE_VERSION_UPDATE_REQUIRED
异常。
订阅健身数据
如需请求后台收集步数数据,请使用 subscribe
方法,如以下代码段所示:
val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Subscribe to steps data
localRecordingClient.subscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
.addOnSuccessListener {
Log.i(TAG, "Successfully subscribed!")
}
.addOnFailureListener { e ->
Log.w(TAG, "There was a problem subscribing.", e)
}
Read and Process Fitness Data
订阅后,使用 readData
方法请求数据。然后,您可以通过发出 LocalDataReadRequest
从生成的 LocalDataSet
中获取 LocalDataPoint,如以下代码段所示:
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
val readRequest =
LocalDataReadRequest.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(LocalDataType.TYPE_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: LocalDataSet) {
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.getStartTime(TimeUnit.HOURS)}")
Log.i(TAG,"\tEnd: ${dp.getEndTime(TimeUnit.HOURS)}")
for (field in dp.dataType.fields) {
Log.i(TAG,"\tLocalField: ${field.name.toString()} LocalValue: ${dp.getValue(field)}")
}
}
}
LocalRecordingClient
会持续更新其收集的数据。您可以随时使用 readData
提取最新号码。
请注意,LocalRecordingClient
最多可存储 10 天的数据。为降低丢失数据的风险,您可以使用 WorkManager 在后台定期收集数据。
退订健身数据
为了释放资源,您应确保在应用不再需要收集传感器数据时取消订阅。如需取消订阅,请使用 unsubscribe
方法:
val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Unsubscribe from steps data
localRecordingClient.unsubscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
.addOnSuccessListener {
Log.i(TAG, "Successfully unsubscribed!")
}
.addOnFailureListener { e ->
Log.w(TAG, "There was a problem unsubscribing.", e)
}