ヘルスコネクトでデータ読み取り書き込み！やさしいはじめの一歩

WindowsならスタートメニューからAndroidStudioを選択。Macならアプリケーションフォルダから起動します。

「Start a new Android Studio project」をクリックし、「Empty Activity」を選びます。アプリ名やパッケージ名を入力し、「Finish」を押してプロジェクトを作成します。

プロジェクトのモジュールレベルbuild.gradleを開きます。

repositoriesブロックに以下を追加して、Health ConnectのMavenリポジトリを有効化します。

maven { url "https://androidx.dev/health" }

続いてdependenciesブロックにHealth Connectクライアントを追加します。

implementation "androidx.health:health-connect-client:最新バージョン"

書き加えたらSync Nowをクリックして同期が成功するか確認しましょう。

もし同期エラーが出たらキャッシュクリア後に再度同期するとスムーズです。

ホーム画面またはアプリ一覧から歯車アイコンの設定アプリをタップしてください。

設定画面をスクロールして「プライバシーとセキュリティ」を探し、タップしてください。

リストから「Health Connect」を見つけてスイッチをタップしてください。許可の確認が出たら「許可」を選んで完了です。

まずはHealthConnectClientをアクティビティやフラグメントで取得します。

val healthClient = HealthConnectClient.getOrCreate(applicationContext)

ステップ数データを読むための権限セットを用意します。

val permission = HealthPermission.createReadPermission(Records.StepsRecord::class)

val permissions = setOf(permission)

ユーザーにポップアップで権限を許可してもらいます。

healthClient.permissionController.requestPermissions(this, permissions)

まず、読み取り用のリクエストを作ります。必要なフィールドや時間範囲を指定することで、意図したデータだけを取得できます。

val readRequest = ReadRecordsRequest(
    recordType = StepsRecord::class,
    timeRangeFilter = TimeRangeFilter.between(
        startTime = ZonedDateTime.now().minusDays(1),
        endTime = ZonedDateTime.now()
    )
)

次にHealthConnectクライアントを使ってリクエストを実行し、結果をログに出力します。実行はバックグラウンドで行うとUIが固まりません。

lifecycleScope.launch {
    val response = healthConnectClient.readRecords(readRequest)
    response.records.forEach { record ->
        val steps = record.getLongValue(HealthFields.STEPS.delta)
        Log.d("HealthConnectSample", "取得した歩数：\$steps")
    }
}

まずブラウザでサンプルのGitHubページを開き、緑色の「Code」ボタンをクリックしてURLをコピーします。

つぎにターミナルを立ち上げて、作業したいフォルダに移動します。

このコマンドで最新のサンプル一式がローカルにダウンロードされます。

メニューバーから File → New → Import Module を選んでモジュール追加画面を開きます。

プロジェクト内の health-connect-sdk またはサンプルフォルダを参照してルートディレクトリを選びます。

表示されるモジュール名が想定どおりかチェックし、OKを押して読み込みを開始します。

追加後に画面右上の Sync アイコンをクリックしてプロジェクトを同期します。

Android Studioの上部ツールバーにある▶アイコンを押します。

表示されたダイアログから接続済みの実機やエミュレータを選択します。

バックグラウンドでアプリが端末に送られ、自動で起動します。

アプリ画面で書き込みを実行するボタンを用意します。res/layout/activity_main.xmlでタグを追加し、android:id="@+id/writeButton"を設定しましょう。

MainActivityのonCreate内でボタンを取得し、クリック時に記録登録メソッドを呼びます。ライフサイクルスコープを使って例外をキャッチするとクラッシュを防げます。

val writeButton = findViewById(R.id.writeButton)

writeButton.setOnClickListener { lifecycleScope.launch {

try {

healthConnectClient.insertRecord(stepCountRecord)

Toast.makeText(this,"書き込み完了",Toast.LENGTH_SHORT).show()

} catch(e:Exception) {

Toast.makeText(this,"エラー："+e.message,Toast.LENGTH_SHORT).show()

}

}}

ヘルスコネクトから取得した歩数や心拍数のデータがリスト表示に並んでいるかを見てみましょう。日付やタグで絞り込みを設定すると、特定のデータだけをチェックしやすくなります。

モジュールの build.gradle に依存を足します。これでWorkManager APIが使えるようになります。

dependencies {
    implementation "androidx.work:work-runtime-ktx:2.8.1"
}

同期処理を行う Worker を継承したクラスを作ります。doWork() 内でAPI呼び出しやデータベース更新を行ってください。

public class SyncWorker extends Worker {
    public SyncWorker(@NonNull Context ctx,@NonNull WorkerParameters params){
        super(ctx,params);
    }
    @NonNull
    @Override
    public Result doWork(){
        // データ同期の処理
        return Result.success();
    }
}

PeriodicWorkRequest を作成して WorkManager に登録します。初回起動から15分ごとに繰り返されます。

PeriodicWorkRequest syncRequest=
    new PeriodicWorkRequest.Builder(
        SyncWorker.class,
        15,TimeUnit.MINUTES)
    .build();
WorkManager.getInstance(context).enqueueUniquePeriodicWork(
    "dataSync",
    ExistingPeriodicWorkPolicy.KEEP,
    syncRequest);

アプリ起動時にHealthConnectClientを取得して、歩数データの読み取り権限を求めます。

val healthConnectClient = HealthConnectClient.getOrCreate(context)
val request = PermissionsRequest(
  listOf(readRecordsPermission(StepsRecord::class)),
  emptySet()
)
healthConnectClient.requestPermissions(request)

権限が許可されたら、Health Connectから指定期間の歩数を取得します。

val response = healthConnectClient.readRecords(
  ReadRecordsRequest(
    recordType = StepsRecord::class,
    timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
  )
)
val stepRecords = response.records

取得した歩数レコードをアプリのRoomエンティティに変換し、DAO経由でデータベースに挿入します。

val entities = stepRecords.map { record ->
  StepEntity(
    timestamp = record.startTime.millis,
    count = record.steps
  )
}
stepDao.insertAll(entities)

HealthConnectとやり取りするため、アプリのContextを渡してクライアントを準備します。

val client = HealthConnectClient.create(context)

このclientを使ってデータの読み書きを行います。

アプリ内のデータをHealthConnect用のRecordに変換し、一括で登録します。

val records = localDataList.map { it.toHealthRecord() }

val response = client.insertRecords(
  RecordNamespace.HEALTH_SERVICES,
  records
)

レスポンスのsuccessfulRecordsやfailedRecordsを確認すると、登録結果がわかります。

まずはセッション内容をまとめたSessionRecordを作成します。開始・終了のタイムスタンプやアクティビティタイプを指定してください。

次に作成したセッションをsessionClient.insertSessionで書き込みます。成功・失敗のコールバックでログを残すと後から確認しやすいです。

書き込み完了後にHealth ConnectのreadSessionを呼び出して、指定期間の睡眠セッションを手に入れます。

例：val sessions = healthConnectClient.readSession( … sleepTypeSets … )

取得したセッションから開始時間と終了時間をEpochミリ秒に変換し、リスト構造にします。

例：dataList.add(Entry(startTime.toFloat(), durationHours.toFloat()))

整形したデータをLineDataSetに渡し、LineChartにセットすると曲線グラフが表示されます。

例：chart.data = LineData(LineDataSet(dataList, "睡眠時間"))

AndroidManifest.xmlにForegroundService用のパーミッションとService登録を追加します。

<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>

<application>
  <service
    android:name=".MyForegroundService"
    android:foregroundServiceType="none"/>
</application>

Android 8.0以上は通知チャンネルが必須です。Service起動前にチャンネルを登録してください。

val channel = NotificationChannel(
  "sync_channel",
  "SyncChannel",
  NotificationManager.IMPORTANCE_LOW
)
notificationManager.createNotificationChannel(channel)

val notification = NotificationCompat.Builder(this, "sync_channel")
  .setContentTitle("同期中")
  .setSmallIcon(R.drawable.ic_sync)
  .build()

onStartCommand内でstartForegroundを呼びタスクを開始します。重い処理はCoroutineやスレッドで動かすと画面が固まりません。

override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
  startForeground(1, notification)
  lifecycleScope.launch(Dispatchers.IO) {
    // 長時間処理
    syncData()
    stopForeground(true)
    stopSelf()
  }
  return START_STICKY
}

処理が終わったらstopForegroundとstopSelfを確実に呼びバックグラウンドから解放します。

まずAndroidManifest.xmlに無視許可の記述を加えます。

android:usesPermission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS"を追加してください。

アプリ起動時か必要なタイミングで、無視設定を促すIntentを作成します。

val intent = Intent(Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS).apply { data = Uri.parse("package:$packageName") }

作成したIntentをstartActivity(intent)で呼び出してください。

実際にはユーザーが拒否するケースもあるので、無視設定が適用されたかどうかをPowerManager.isIgnoringBatteryOptimizations(packageName)で必ず確認しましょう。

通知チャンネルは Android8以上で必須なので、初回起動時やチャンネル未作成時にだけ登録すると無駄がありません。

NotificationManager manager = getSystemService(NotificationManager.class);
if (manager.getNotificationChannel("sync_channel") == null) {
    NotificationChannel channel = new NotificationChannel(
        "sync_channel",
        "同期結果通知",
        NotificationManager.IMPORTANCE_DEFAULT
    );
    channel.setDescription("データ同期の成功／失敗をお知らせします");
    manager.createNotificationChannel(channel);
}

同期処理が終わったタイミングで NotificationCompat.Builder を使い、先ほどのチャンネルで通知を発行します。

NotificationCompat.Builder builder = new NotificationCompat.Builder(this, "sync_channel")
    .setSmallIcon(R.drawable.ic_sync)
    .setContentTitle("データ同期完了")
    .setContentText("最新の健康データが読み込まれました")
    .setAutoCancel(true);

NotificationManagerCompat.from(this).notify(1001, builder.build());

まずはHealthConnectClientを用意します。最新のAndroid14を前提に書いています。

val healthConnectClient = HealthConnectClient.getOrCreate(context)

テスト用に入れたStepsRecord（歩数データ）を例に、時間範囲を指定して削除リクエストを組み立てます。

val request = DeleteRecordsRequest(
  recordType = StepsRecord::class,
  timeRangeFilter = TimeRangeFilter.between(
    startTime = LocalDateTime.of(2023,1,1,0,0).toInstant(ZoneOffset.UTC),
    endTime = LocalDateTime.now().toInstant(ZoneOffset.UTC),
  )
)

deleteRecordsを呼び出して、削除結果をログなどで確認しましょう。

val response = healthConnectClient.deleteRecords(request)
// 削除件数をチェック
Log.d("HealthConnect","Deleted ${response.deletedRecordsCount} records")