读取原始数据

以下示例演示了如何在常见工作流程中读取原始数据。

读取数据

Health Connect 允许应用在应用处于前台和后台时从数据存储中读取数据

  • 前台读取:当您的应用处于前台时,您可以正常地从 Health Connect 读取数据。在这种情况下,您可以考虑使用前台服务来运行此操作,以防用户或系统在读取操作期间将您的应用置于后台。

  • 后台读取:通过向用户请求额外的权限,您可以在用户或系统将您的应用置于后台后读取数据。请参阅完整的 后台读取示例

Health Connect 中的步数数据类型捕获用户在两次读取之间行走的步数。步数代表健康、健身和健康平台的通用测量值。Health Connect 简化了步数数据的读取和写入。

要读取记录,请创建一个 ReadRecordsRequest,并在调用 readRecords 时提供它。

以下示例演示了如何在特定时间内读取用户的步数数据。有关包含 SensorManager 的扩展示例,请参阅 步数 数据指南。

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

背景读取示例

要在后台读取数据,请在您的清单文件中声明以下权限

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

以下示例展示了如何使用WorkManager在后台读取特定时间段内用户的步数数据。

class ScheduleWorker(private val appContext: Context, workerParams: WorkerParameters):
    CoroutineWorker(appContext, workerParams) {

    override suspend fun doWork(): Result {
        // Read data and process it.
        ...

        // Return success indicating successful data retrieval
        return Result.success()
    }
}

if (healthConnectClient
    .features
    .getFeatureStatus(
    HealthConnectFeatures.FEATURE_READ_HEALTH_DATA_IN_BACKGROUND
    ) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE) {

    // Check if necessary permission is granted
    val grantedPermissions = healthConnectClient.permissionController.getGrantedPermissions()

    if (PERMISSION_READ_HEALTH_DATA_IN_BACKGROUND !in grantedPermissions) {
        // Perform read in foreground
        ...
    } else {
        // Schedule the periodic work request in background
        val periodicWorkRequest = PeriodicWorkRequestBuilder<ScheduleWorker>(1, TimeUnit.HOURS)
            .build()

        WorkManager.getInstance(context).enqueueUniquePeriodicWork(
            "read_health_connect",
            ExistingPeriodicWorkPolicy.KEEP,
            periodicWorkRequest
        )
    }
} else {
  // Background reading is not available, perform read in foreground
  ...
}

读取先前写入的数据

如果应用之前已将记录写入 Health Connect,则该应用可以读取这些记录而无需对这些特定记录具有读取权限。这适用于用户重新安装应用后,应用需要与 Health Connect 同步的场景。

要在这种情况下读取数据,您需要在ReadRecordsRequestdataOriginFilter参数中将包名称指定为DataOrigin对象。

以下示例展示了在读取步数记录时如何指定包名称

try {
    val response =  healthConnectClient.readRecords(
        ReadRecordsRequest(
            recordType = StepsRecord::class,
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
            dataOriginFilter = setOf(DataOrigin("com.my.package.name"))
        )
    )
    for (record in response.records) {
        // Process each record
    }
} catch (e: Exception) {
    // Run error handling here
}

读取限制

默认情况下,您的应用可以使用任何授予的权限读取最多 30 天的数据。使用PERMISSION_READ_HEALTH_DATA_HISTORY权限,您的应用可以读取 30 天之前的数据。

30 天限制

Health Connect 可以读取最早授予任何权限之前的 30 天内的数据。

但是,如果用户删除了您的应用,则权限历史记录将丢失。如果用户重新安装您的应用并再次授予权限,则您的应用可以读取 Health Connect 中最早到新日期之前的 30 天内的数据。

30 天示例

如果用户于 2023 年 3 月 30 日首次向您的应用授予读取权限,则您的应用可以读取的最早数据将从**2023 年 2 月 28 日**开始。

然后,用户于 2023 年 5 月 10 日删除了您的应用。用户决定于 2023 年 5 月 15 日重新安装该应用并授予读取权限。现在,您的应用可以读取的最早数据日期为**2023 年 4 月 15 日**。

读取 30 天之前的数据

如果要读取 30 天之前的数据,必须使用PERMISSION_READ_HEALTH_DATA_HISTORY权限。没有此权限,尝试读取 30 天之前的一条记录将导致错误。您也不能使用其中一个时间范围请求读取 30 天之前的数据。