借助移动设备上的 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")
}
时尚 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)
}
读取和处理健身数据
订阅后,使用 readData
方法请求数据。然后,您可以通过创建 LocalDataReadRequest
从生成的 LocalDataSet
获取 LocalDataPoints,如以下代码段所示:
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)
}