整合 Wear OS 模組

將應用程式擴展到搭載 Wear OS 的穿戴式裝置，提升健康與健身體驗。

新增 Wear OS 模組

Android Studio 提供實用的精靈，可將 Wear OS 模組新增至應用程式。在「File > New Module」選單中，選取「Wear OS」，如下圖所示：

Android Studio 中的 Wear OS 模組精靈
圖 1：建立 Wear OS 模組

請注意，最低 SDK 必須為 API 30 以上版本，才能使用最新版的健康服務。健康照護服務會自動設定健康感應器，方便你追蹤指標及記錄資料。

完成精靈操作後，請同步專案。系統會顯示下列「Run」設定：

圖片：顯示 Wear OS 應用程式的執行按鈕
圖 2：新 Wear OS 模組的「執行」按鈕

這樣就能在穿戴式裝置上執行 Wear OS 模組。方法有以下兩種：

執行設定會將應用程式部署至 Wear OS 模擬器或裝置，並顯示「Hello World」體驗。這是使用 Compose for Wear OS 的基本 UI 設定，可協助您開始開發應用程式。

新增健康服務和 Hilt

將下列程式庫整合至 Wear OS 模組：

  • 健康服務：可讓您輕鬆存取手錶上的感應器和資料，而且更省電。
  • Hilt：可有效插入及管理依附元件。

建立健康照護服務管理員

為方便使用 Health Services，並公開更小巧流暢的 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 應用程式的 UI 中，會顯示穿戴式裝置感應器測得的目前心率值。

在 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
        }
    }

使用類似下列的可組合項物件，在應用程式的 UI 中顯示即時資料：

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 將事件提供給資料觀察器。

最後一項是宣告手機應用程式中的 Service： AndroidManifest.xml

<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 物件會觀察心率資料，並視需要發出 UI 更新。