集成 Wear OS 模块

通过将应用扩展到搭载 Wear OS 的穿戴式设备,提升应用的健康与健身体验。

添加 Wear OS 模块

Android Studio 提供了一个便捷的向导,用于将 Wear OS 模块添加到您的应用。在 File > New Module 菜单中,选择 Wear OS,如下图所示:

Android Studio 中的 Wear OS 模块向导
图 1:创建 Wear OS 模块

请务必注意,Minimum SDK 必须为 API 30 或更高版本,以便您使用最新版本的健康服务。通过自动配置健康传感器,健康服务可以更轻松地跟踪指标和记录数据。

完成向导后,同步您的项目。系统会显示以下 Run 配置:

显示 Wear OS 应用运行按钮的图片
图 2:新 Wear OS 模块的“Run”按钮

这样,您就可以在穿戴式设备上运行 Wear OS 模块。您有以下两种选择:

运行配置会将应用部署到 Wear OS 模拟器或设备,并显示“hello world”体验。这是使用 Compose for Wear OS 开始使用应用的基本界面设置。

添加健康服务和 Hilt

将以下库集成到您的 Wear OS 模块中:

  • 健康服务:让您可以非常方便且更节能地访问手表上的传感器和数据。
  • Hilt:可实现有效的依赖项注入和管理。

创建健康服务管理器

为了更方便地使用健康服务,并公开更小、更顺畅的 API,您可以创建如下所示的封装容器:

private const val TAG = "WATCHMAIN"

class HealthServicesManager(context: Context) {
    private val measureClient = HealthServices.getClient(context).measureClient

    suspend fun hasHeartRateCapability() = runCatching {
        val capabilities = measureClient.getCapabilities()
        (DataType.HEART_RATE_BPM in capabilities.supportedDataTypesMeasure)
    }.getOrDefault(false)

    /**
     * Returns a cold flow. When activated, the flow will register a callback for heart rate data
     * and start to emit messages. When the consuming coroutine is canceled, the measure callback
     * is unregistered.
     *
     * [callbackFlow] creates a  bridge between a callback-based API and Kotlin flows.
     */
    @ExperimentalCoroutinesApi
    fun heartRateMeasureFlow(): Flow<MeasureMessage> = callbackFlow {
        val callback = object : MeasureCallback {
            override fun onAvailabilityChanged(dataType: DeltaDataType<*, *>, availability: Availability) {
                // Only send back DataTypeAvailability (not LocationAvailability)
                if (availability is DataTypeAvailability) {
                    trySendBlocking(MeasureMessage.MeasureAvailability(availability))
                }
            }

            override fun onDataReceived(data: DataPointContainer) {
                val heartRateBpm = data.getData(DataType.HEART_RATE_BPM)
                Log.d(TAG, "💓 Received heart rate: ${heartRateBpm.first().value}")
                trySendBlocking(MeasureMessage.MeasureData(heartRateBpm))
            }
        }

        Log.d(TAG, "⌛ Registering for data...")
        measureClient.registerMeasureCallback(DataType.HEART_RATE_BPM, callback)

        awaitClose {
            Log.d(TAG, "👋 Unregistering for data")
            runBlocking {
                measureClient.unregisterMeasureCallback(DataType.HEART_RATE_BPM, callback)
            }
        }
    }
}

sealed class MeasureMessage {
    class MeasureAvailability(val availability: DataTypeAvailability) : MeasureMessage()
    class MeasureData(val data: List<SampleDataPoint<Double>>) : MeasureMessage()
}

创建 Hilt 模块以对其进行管理后,使用以下代码段:

@Module
@InstallIn(SingletonComponent::class)
internal object DataModule {
    @Provides
    @Singleton
    fun provideHealthServices(@ApplicationContext context: Context): HealthServicesManager = HealthServicesManager(context)
}

您可以像注入任何其他 Hilt 依赖项一样注入 HealthServicesManager

新的 HealthServicesManager 提供了一个 heartRateMeasureFlow() 方法,用于为心脏监测器注册监听器并发出收到的数据。

在穿戴式设备上启用数据更新

健身相关数据更新需要 BODY_SENSORS 权限。如果您尚未在应用的清单文件中声明 BODY_SENSORS 权限,请执行此操作。然后,请求该权限,如以下代码段所示:

val permissionState = rememberPermissionState(
    permission = Manifest.permission.BODY_SENSORS,
    onPermissionResult = { granted -> /* do something */ }
)

[...]

if (permissionState.status.isGranted) {
    // do something
} else {
    permissionState.launchPermissionRequest()
}

如果您在实体设备上测试应用,数据应该会开始更新。

从 Wear OS 4 开始,模拟器还会自动显示测试数据。在以前的版本中,您可以模拟来自传感器的数据流。在终端窗口中,运行以下 ADB 命令:

adb shell am broadcast \
-a "whs.USE_SYNTHETIC_PROVIDERS" \
com.google.android.wearable.healthservices

如需查看不同的心率值,请尝试模拟不同的锻炼。 此命令会模拟步行:

adb shell am broadcast \
-a "whs.synthetic.user.START_WALKING" \
com.google.android.wearable.healthservices

此命令会模拟运行:

adb shell am broadcast \
-a "whs.synthetic.user.START_RUNNING" \
com.google.android.wearable.healthservices

如需停止模拟数据,请运行以下命令:

adb shell am broadcast -a \
"whs.USE_SENSOR_PROVIDERS" \
com.google.android.wearable.healthservices

读取心率数据

获得 BODY_SENSORS 权限后,您可以在 HealthServicesManager 中读取用户的心率 (heartRateMeasureFlow())。Wear OS 应用的界面中会显示当前心率值,该值由穿戴式设备上的传感器进行测量。

ViewModel 中,开始使用心率流对象收集数据,如以下代码段所示:

val hr: MutableState<Double> = mutableStateOf(0.0)

[...]

healthServicesManager
    .heartRateMeasureFlow()
    .takeWhile { enabled.value }
    .collect { measureMessage ->
        when (measureMessage) {
            is MeasureData -> {
                val latestHeartRateValue = measureMessage.data.last().value
                hr.value = latestHeartRateValue
            }

            is MeasureAvailability -> availability.value =
                    measureMessage.availability
        }
    }

使用类似于以下内容的可组合对象,在应用界面中显示实时数据:

val heartRate by viewModel.hr

Text(
  text = "Heart Rate: $heartRate",
  style = MaterialTheme.typography.display1
)

将数据发送到手持设备

如需将健康与健身数据发送到手持设备,请使用健康服务中的 DataClient 类。以下代码段展示了如何发送应用之前收集的心率数据:

class HealthServicesManager(context: Context) {
    private val dataClient by lazy { Wearable.getDataClient(context) }

[...]

    suspend fun sendToHandheldDevice(heartRate: Int) {
        try {
            val result = dataClient
                .putDataItem(PutDataMapRequest
                    .create("/heartrate")
                    .apply { dataMap.putInt("heartrate", heartRate) }
                    .asPutDataRequest()
                    .setUrgent())
                .await()

            Log.d(TAG, "DataItem saved: $result")
        } catch (cancellationException: CancellationException) {
            throw cancellationException
        } catch (exception: Exception) {
            Log.d(TAG, "Saving DataItem failed: $exception")
        }
    }
}

在手机上接收数据

如需在手机上接收数据,请创建一个 WearableListenerService

@AndroidEntryPoint
class DataLayerListenerService : WearableListenerService() {

    @Inject
    lateinit var heartRateMonitor: HeartRateMonitor

    override fun onDataChanged(dataEvents: DataEventBuffer) {

        dataEvents.forEach { event ->
            when (event.type) {
                DataEvent.TYPE_CHANGED -> {
                    event.dataItem.run {
                        if (uri.path?.compareTo("/heartrate") == 0) {
                            val heartRate = DataMapItem.fromDataItem(this)
                                    .dataMap.getInt(HR_KEY)
                            Log.d("DataLayerListenerService",
                                    "New heart rate value received: $heartRate")
                            heartRateMonitor.send(heartRate)
                        }
                    }
                }

                DataEvent.TYPE_DELETED -> {
                    // DataItem deleted
                }
            }
        }
    }
}

完成此步骤后,请注意一些有趣的细节:

  • 借助 @AndroidEntryPoint 注解,我们在此类中使用 Hilt
  • @Inject lateinit var heartRateMonitor: HeartRateMonitor 实际上会在此类中注入一个依赖项
  • 该类会实现 onDataChanged() 并接收一系列事件,您可以将这些事件解析和使用

通过以下 HeartRateMonitor 逻辑,您可以将收到的心率值发送到应用代码库的其他部分:

class HeartRateMonitor {
    private val datapoints = MutableSharedFlow<Int>(extraBufferCapacity = 10)

    fun receive(): SharedFlow<Int> = datapoints.asSharedFlow()

    fun send(hr: Int) {
        datapoints.tryEmit(hr)
    }
}

数据总线从 onDataChanged() 方法接收事件,并使用 SharedFlow 将这些事件提供给数据观察者。

最后一位是手机应用 AndroidManifest.xml 中的 Service 声明:

<service
    android:name=".DataLayerListenerService"
    android:exported="true">
    <intent-filter>
        <!-- listeners receive events that match the action and data filters -->
        <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
        <data
            android:host="*"
            android:pathPrefix="/heartrate"
            android:scheme="wear" />
    </intent-filter>
</service>

在手持设备上显示实时数据

在手持设备上运行的应用部分中,将 HeartRateMonitor 注入视图模型的构造函数。此 HeartRateMonitor 对象会观察心率数据,并根据需要发出界面更新。