此页面由 Cloud Translation API 翻译。

跟踪步骤

健康数据共享提供步数数据类型，用于使用 StepsRecord 记录步数。步数是健康和健身追踪的基本测量指标。

读取移动步数

在 Android 14（API 级别 34）和 SDK 扩展版本 20 或更高版本中，健康数据共享提供设备端步数统计功能。如果任何应用已获得 READ_STEPS 权限，健康数据共享会开始从 Android 设备捕获步数，用户会自动在健康数据共享的步数条目中看到步数数据。

如需检查设备上是否提供步数统计功能，您需要验证设备是否搭载 Android 14（API 级别 34）且至少具有 SDK 扩展版本 20。您可以使用以下代码：

val isStepTrackingAvailable =
    Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE &&
        SdkExtensions.getExtensionVersion(Build.VERSION_CODES.UPSIDE_DOWN_CAKE) >= 20

由健康数据共享捕获的移动步数的 DataOrigin 设置为软件包名称 android。如果您的应用仅使用 aggregate 读取汇总的步数，而不按 DataOrigin 进行过滤，则设备上的步数会自动计入总数。

如果您的应用需要读取设备上的步数，或者需要显示按来源应用或设备细分的步数数据，您可以查询 DataOrigin 为 android 的记录。如果您的应用显示步数数据的提供方信息，则应将来自 android 软件包的数据归因于当前设备。您可以使用“您的手机”等标签，通过 Settings.Global.getString(resolver, Settings.Global.DEVICE_NAME) 检索设备名称，或检查记录元数据中的 Device 字段来完成此操作。

以下示例展示了如何通过过滤 android 数据来源来读取汇总的移动设备步数数据：

suspend fun readStepsByTimeRange(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant
) {
    try {
        val response = healthConnectClient.aggregate(
            AggregateRequest(
                metrics = setOf(StepsRecord.COUNT_TOTAL),
                timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
                dataOriginFilter = setOf(DataOrigin("android"))
            )
        )
        // The result may be null if no data is available in the time range
        val stepCount = response[StepsRecord.COUNT_TOTAL]
    } catch (e: Exception) {
        // Run error handling here
    }
}

设备端步数统计

深入了解设备端步数统计功能：

传感器使用情况：Health Connect 使用 SensorManager 中的 TYPE_STEP_COUNTER 传感器。此传感器经过优化，可实现低功耗，非常适合用于持续的后台步数跟踪。
数据粒度：为了节省电池电量，步数数据通常会批量写入健康数据共享数据库，写入频率不会超过每分钟一次。
归因：如前所述，此设备端功能记录的所有步数都归因于 DataOrigin 中的 android 软件包名称。
激活：只有当设备上至少有一个应用在“健康数据共享”中被授予 READ_STEPS 权限时，设备端步数统计机制才会处于有效状态。

查看“健康数据共享”的适用范围

在尝试使用健康数据共享之前，您的应用应验证健康数据共享是否可在用户的设备上使用。并非所有设备都预安装了“健康数据共享”，或者“健康数据共享”可能处于停用状态。您可以使用 HealthConnectClient.getSdkStatus() 方法检查是否可用。

如何查看“健康数据共享”的适用范围

fun checkHealthConnectAvailability(context: Context) {
    val providerPackageName = "com.google.android.apps.healthdata" // Or get from HealthConnectClient.DEFAULT_PROVIDER_PACKAGE_NAME
    val availabilityStatus = HealthConnectClient.getSdkStatus(context, providerPackageName)

    if (availabilityStatus == HealthConnectClient.SDK_UNAVAILABLE) {
      // Health Connect is not available. Guide the user to install/enable it.
      // For example, show a dialog.
      return // early return as there is no viable integration
    }
    if (availabilityStatus == HealthConnectClient.SDK_UNAVAILABLE_PROVIDER_UPDATE_REQUIRED) {
      // Health Connect is available but requires an update.
      // Optionally redirect to package installer to find a provider, for example:
      val uriString = "market://details?id=$providerPackageName&url=healthconnect%3A%2F%2Fonboarding"
      context.startActivity(
        Intent(Intent.ACTION_VIEW).apply {
          setPackage("com.android.vending")
          data = Uri.parse(uriString)
          putExtra("overlay", true)
          putExtra("callerId", context.packageName)
        }
      )
      return
    }
    // Health Connect is available, obtain a HealthConnectClient instance
    val healthConnectClient = HealthConnectClient.getOrCreate(context)
    // Issue operations with healthConnectClient
}

根据 getSdkStatus() 返回的状态，您可以引导用户从 Google Play 商店安装或更新健康数据共享（如果需要）。

所需权限

对步数的访问受以下权限保护：

android.permission.health.READ_STEPS
android.permission.health.WRITE_STEPS

如要向应用添加步数功能，请先请求 Steps 数据类型的写入权限。

您需要声明以下权限才能写入步数：

<application>
  <uses-permission
android:name="android.permission.health.WRITE_STEPS" />
...
</application>

如需读取步数，您需要请求以下权限：

<application>
  <uses-permission
android:name="android.permission.health.READ_STEPS" />
...
</application>

向用户请求权限

创建客户端实例后，应用需要向用户请求权限。必须允许用户随时授予或拒绝权限。

为此，请为所需的数据类型创建一组权限。先确保此集中的权限已在 Android 清单中声明。

// Create a set of permissions for required data types
val PERMISSIONS =
    setOf(
  HealthPermission.getReadPermission(StepsRecord::class),
  HealthPermission.getWritePermission(StepsRecord::class)
)

使用 getGrantedPermissions 查看您的应用是否已获得所需的权限。如不具备，请使用 createRequestPermissionResultContract 请求这些权限。系统随即会显示“健康数据共享”权限界面。

// Create the permissions launcher
val requestPermissionActivityContract = PermissionController.createRequestPermissionResultContract()

val requestPermissions = registerForActivityResult(requestPermissionActivityContract) { granted ->
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions successfully granted
  } else {
    // Lack of required permissions
  }
}

suspend fun checkPermissionsAndRun(healthConnectClient: HealthConnectClient) {
  val granted = healthConnectClient.permissionController.getGrantedPermissions()
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions already granted; proceed with inserting or reading data
  } else {
    requestPermissions.launch(PERMISSIONS)
  }
}

由于用户可以随时授予或撤消权限，因此您的应用需要定期检查已授予的权限，并应对权限丢失的情况。

“步数”记录中包含的信息

每个 StepsRecord 都包含以下信息：

count：相应时间间隔内的行走步数，以 Long 形式表示。
startTime：衡量时间间隔的开始时间。
endTime：测量间隔的结束时间。
startZoneOffset：开始时间的时区偏移量。
endZoneOffset：结束时间的时区偏移量。

支持的聚合

以下是适用于 StepsRecord 的汇总值：

COUNT_TOTAL

以下是适用于 StepsCadenceRecord 的汇总值：

用法示例

以下部分介绍了如何读取和写入 StepsRecord 数据。

写入步数数据

您的应用可以通过插入 StepsRecord 实例来写入步数数据。以下示例展示了如何记录用户行走的 1,000 步：

suspend fun writeStepsData(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
    startZoneOffset: ZoneOffset,
    endZoneOffset: ZoneOffset
) {
    try {
        val stepsRecord = StepsRecord(
            startTime = startTime,
            startZoneOffset = startZoneOffset,
            endTime = endTime,
            endZoneOffset = endZoneOffset,
            count = 1000
        )
        healthConnectClient.insertRecords(listOf(stepsRecord))
    } catch (e: Exception) {
        // Run error handling
    }
}

读取汇总数据

读取步数数据的最常见方式是汇总某个时间段内的总步数。以下示例展示了如何读取特定时间范围内用户的总步数：

suspend fun readStepsAggregate(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant
) {
    try {
        val response = healthConnectClient.aggregate(
            AggregateRequest(
                metrics = setOf(StepsRecord.COUNT_TOTAL),
                timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
            )
        )
        // The result may be null if no data is available in the time range
        val stepCount = response[StepsRecord.COUNT_TOTAL]
    } catch (e: Exception) {
        // Run error handling here
    }
}

读取原始数据

以下示例展示了如何读取开始时间和结束时间之间的原始 StepsRecord 数据：

suspend fun readStepsRaw(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant
) {
    try {
        val response = healthConnectClient.readRecords(
            ReadRecordsRequest(
                recordType = StepsRecord::class,
                timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
            )
        )
        for (record in response.records) {
            // Process each record
        }
    } catch (e: Exception) {
        // Run error handling here
    }
}