使用传感器管理器从移动设备测量步数

如本指南所述，使用传感器管理器在移动应用程序中填充步数数据。有关如何设计和管理运动应用程序 UI 的更多信息，请参阅 构建基本健身应用程序。

入门

要开始从移动设备测量基本步数计数器的步数，您需要将依赖项添加到应用程序模块 build.gradle 文件中。确保使用最新版本的依赖项。此外，当您将应用程序的支持扩展到其他外形尺寸（如 Wear OS）时，请添加这些外形尺寸所需的依赖项。

以下是某些 UI 依赖项的几个示例。有关完整列表，请参阅此 UI 元素 指南。

implementation(platform("androidx.compose:compose-bom:2023.10.01"))
implementation("androidx.activity:activity-compose")
implementation("androidx.compose.foundation:foundation")
implementation("androidx.compose.material:material")

获取步数计数器传感器

在用户授予必要的 活动识别权限 后，您可以访问步数计数器传感器

1. 从 getSystemService() 获取 SensorManager 对象。
2. 从 SensorManager 获取步数计数器传感器

private val sensorManager by lazy {
        getSystemService(Context.SENSOR_SERVICE) as SensorManager }
private val sensor: Sensor? by lazy {
        sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER) }

某些设备没有步数计数器传感器。您应该检查传感器，如果设备没有传感器，则显示错误消息

if (sensor == null) {
    Text(text = "Step counter sensor is not present on this device")
}

创建您的前台服务

在基本的健身应用程序中，您可能有一个 按钮 来接收用户跟踪步数的开始和停止事件。

牢记传感器 最佳实践。特别是，步数计数器传感器应该只在传感器侦听器注册时才计数步数。通过将传感器注册与前台服务相关联，传感器会在需要时一直注册，并且当应用程序不在前台时，传感器可以保持注册。

使用以下代码片段在您的前台服务的 onPause() 方法中注销传感器

override fun onPause() {
    super.onPause()
    sensorManager.unregisterListener(this)
}

分析事件数据

要访问传感器数据，请实现 SensorEventListener 接口。请注意，您应该将传感器注册与前台服务的生命周期相关联，并在服务暂停或结束时注销传感器。以下代码片段显示了如何为 Sensor.TYPE_STEP_COUNTER 实现 SensorEventListener 接口

private const val TAG = "STEP_COUNT_LISTENER"

context(Context)
class StepCounter {
    private val sensorManager = getSystemService(Context.SENSOR_SERVICE) as SensorManager
    private val sensor: Sensor? = sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER)

    suspend fun steps() = suspendCancellableCoroutine { continuation ->
        Log.d(TAG, "Registering sensor listener... ")

        val listener: SensorEventListener by lazy {
            object : SensorEventListener {
                override fun onSensorChanged(event: SensorEvent?) {
                    if (event == null) return

                    val stepsSinceLastReboot = event.values[0].toLong()
                    Log.d(TAG, "Steps since last reboot: $stepsSinceLastReboot")

                    if (continuation.isActive) {
                        continuation.resume(stepsSinceLastReboot)
                    }
                }

                override fun onAccuracyChanged(sensor: Sensor?, accuracy: Int) {
                      Log.d(TAG, "Accuracy changed to: $accuracy")
                }
            }
       }

        val supportedAndEnabled = sensorManager.registerListener(listener,
                sensor, SensorManager.SENSOR_DELAY_UI)
        Log.d(TAG, "Sensor listener registered: $supportedAndEnabled")
    }
}

为传感器事件创建数据库

您的应用程序可能会显示一个屏幕，用户可以在其中查看他们随时间的步数。要为您的应用程序提供此功能，请使用 Room 持久化库。

以下代码片段创建了一个表，该表包含一组步数测量值，以及您的应用程序访问每个测量值的时间

@Entity(tableName = "steps")
data class StepCount(
  @ColumnInfo(name = "steps") val steps: Long,
  @ColumnInfo(name = "created_at") val createdAt: String,
)

创建一个 数据访问对象 (DAO) 来读写数据

@Dao
interface StepsDao {
    @Query("SELECT * FROM steps")
    suspend fun getAll(): List<StepCount>

    @Query("SELECT * FROM steps WHERE created_at >= date(:startDateTime) " +
            "AND created_at < date(:startDateTime, '+1 day')")
    suspend fun loadAllStepsFromToday(startDateTime: String): Array<StepCount>

    @Insert
    suspend fun insertAll(vararg steps: StepCount)

    @Delete
    suspend fun delete(steps: StepCount)
}

要实例化 DAO，请创建一个 RoomDatabase 对象

@Database(entities = [StepCount::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun stepsDao(): StepsDao
}

将传感器数据存储到数据库中

ViewModel 使用新的 StepCounter 类，因此您可以在读取步骤后立即存储它们。

viewModelScope.launch {
    val stepsFromLastBoot = stepCounter.steps()
    repository.storeSteps(stepsFromLastBoot)
}

The repository 类将如下所示

class Repository(
    private val stepsDao: StepsDao,
) {

    suspend fun storeSteps(stepsSinceLastReboot: Long) = withContext(Dispatchers.IO) {
        val stepCount = StepCount(
            steps = stepsSinceLastReboot,
            createdAt = Instant.now().toString()
        )
        Log.d(TAG, "Storing steps: $stepCount")
        stepsDao.insertAll(stepCount)
    }

    suspend fun loadTodaySteps(): Long = withContext(Dispatchers.IO) {
        printTheWholeStepsTable() // DEBUG

        val todayAtMidnight = (LocalDateTime.of(LocalDate.now(), LocalTime.MIDNIGHT).toString())
        val todayDataPoints = stepsDao.loadAllStepsFromToday(startDateTime = todayAtMidnight)
        when {
            todayDataPoints.isEmpty() -> 0
            else -> {
                val firstDataPointOfTheDay = todayDataPoints.first()
                val latestDataPointSoFar = todayDataPoints.last()

                val todaySteps = latestDataPointSoFar.steps - firstDataPointOfTheDay.steps
                Log.d(TAG, "Today Steps: $todaySteps")
                todaySteps
            }
        }
    }
}

定期检索传感器数据

如果您使用前台服务，则无需配置 WorkManager，因为在您的应用积极跟踪用户步骤的时间内，更新的总步数应显示在您的应用中。

但是，如果您想批量处理步数记录，可以使用 WorkManager 以特定间隔（例如每 15 分钟一次）测量步数。 WorkManager 是执行后台工作以保证执行的组件。 在 WorkManager codelab 中了解更多信息。

要配置 Worker 对象以检索数据，请覆盖 doWork() 方法，如以下代码片段所示

private const val TAG = " StepCounterWorker"

@HiltWorker
class StepCounterWorker @AssistedInject constructor(
    @Assisted appContext: Context,
    @Assisted workerParams: WorkerParameters,
    val repository: Repository,
    val stepCounter: StepCounter
) : CoroutineWorker(appContext, workerParams) {

    override suspend fun doWork(): Result {
        Log.d(TAG, "Starting worker...")

        val stepsSinceLastReboot = stepCounter.steps().first()
        if (stepsSinceLastReboot == 0L) return Result.success()

        Log.d(TAG, "Received steps from step sensor: $stepsSinceLastReboot")
        repository.storeSteps(stepsSinceLastReboot)

        Log.d(TAG, "Stopping worker...")
        return Result.success()
    }
}

要设置 WorkManager 以每 15 分钟存储一次当前步数，请执行以下操作

1. 扩展 Application 类以实现 Configuration.Provider 接口。
2. 在 onCreate() 方法中，将 PeriodicWorkRequestBuilder 排队。

此过程显示在以下代码片段中

@HiltAndroidApp
@RequiresApi(Build.VERSION_CODES.S)
internal class PulseApplication : Application(), Configuration.Provider {

    @Inject
    lateinit var workerFactory: HiltWorkerFactory

    override fun onCreate() {
        super.onCreate()

        val myWork = PeriodicWorkRequestBuilder<StepCounterWorker>(
                15, TimeUnit.MINUTES).build()

        WorkManager.getInstance(this)
            .enqueueUniquePeriodicWork("MyUniqueWorkName",
                    ExistingPeriodicWorkPolicy.UPDATE, myWork)
    }

    override val workManagerConfiguration: Configuration
        get() = Configuration.Builder()
            .setWorkerFactory(workerFactory)
            .setMinimumLoggingLevel(android.util.Log.DEBUG)
            .build()
}

要在应用启动时立即初始化控制对应用步数计数器数据库访问的內容提供者，请将以下元素添加到应用的清单文件中

<provider
    android:name="androidx.startup.InitializationProvider"
    android:authorities="${applicationId}.androidx-startup"
    tools:node="remove" />