本文為投稿文章,作者:Mars飄殇
最近做項目時,突然接到產品經理的一個需求:在項目中統計用戶每日步數,具體就是獲取手機健康應用裡統計的每日步數,再以圖形方式顯示。
剛聽到這個需求,我就想到了蘋果在 iOS 8 時順帶推出的 HealthKit 框架,只是對它的 API 還非常陌生。上網查了一番,發現很難找到一篇能很好地引導新手使用該框架的資料(也可能是我沒找到好的),經過幾天摸索,也算有點心得體會。在這裡把自己對該框架的使用做個梳理,希望能為即將接觸它的同學提供一點幫助。如有疑問或不對之處,歡迎提出。以下以獲取步數為例,其他數據獲取可類推。
一、項目中關聯 HealthKit 框架

HealthKit 關聯路徑:
首先填寫好項目的 Bundle Identifier 並選好 Team(這兩項最好事先設置好,以免之後重新關聯),然後在項目物理文件結構中點選對應項目,在 TARGETS 中選擇自身項目,再在右側選擇 Capabilities 選項。

從中找到 HealthKit,點擊右側開關開啟,當出現中間紅框所示的內容,表示項目與 HealthKit 框架關聯成功。

你會看到項目中多了 HealthKit.framework 和 .entitlements 這兩個文件,一切順利,接下來就可以寫代碼了。
二、HealthKit 支持的系統和設備
因為 HealthKit 是伴隨 iOS 8 一同推出的,所以目前只支持 iOS 8 及以上系統,支持的設備有 iPhone、iWatch——注意 iPad 是不支持的。如果你的代碼同時支持 iPhone 和 iPad,記得判斷設備和系統版本,以免出現不必要的崩潰。導入 HealthKit.h 後,也可以用以下代碼判斷設備能否使用健康數據:
[HKHealthStore isHealthDataAvailable]
三、應用授權
要想獲取步數,必須經過用戶許可。具體可用以下代碼授權:
HKHealthStore *healthStore = [[HKHealthStore alloc] init];
NSSet *readObjectTypes = [NSSet setWithObjects:
[HKObjectType quantityTypeForIdentifier:HKQuantityTypeIdentifierStepCount], nil];
[healthStore requestAuthorizationToShareTypes:nil
readTypes:readObjectTypes
completion:^(BOOL success, NSError *error) {
if (success == YES) {
// 授權成功
} else {
// 授權失敗
}
}];這裡調用 requestAuthorizationToShareTypes:readTypes:completion: 方法,用於對應用授權需要獲取和分享的健康數據:
第一個參數傳入 NSSet 類型數據,告知用戶「我的 app 可能會在你的健康數據庫中修改這些選項」(目前不需要,傳 nil)。
第二個參數也是 NSSet,告知用戶「我的 app 可能會從你的數據庫中讀取以下數據」。
第三個是授權回調,BOOL 值 success 用於區分用戶是否允許應用向數據庫存取數據。
四、獲取健康步數
授權完成後,就可以調用 API 獲取數據庫數據了:
HKSampleType *sampleType = [HKSampleType quantityTypeForIdentifier:HKQuantityTypeIdentifierStepCount];
NSPredicate *predicate = [HKQuery predicateForSamplesWithStartDate:nil
endDate:nil
options:HKQueryOptionStrictStartDate];
NSSortDescriptor *sortDescriptor = [NSSortDescriptor sortDescriptorWithKey:HKSampleSortIdentifierStartDate ascending:YES];
HKSampleQuery *sampleQuery = [[HKSampleQuery alloc] initWithSampleType:sampleType
predicate:predicate
limit:HKObjectQueryNoLimit
sortDescriptors:@[sortDescriptor]
resultsHandler:^(HKSampleQuery *query, NSArray *results, NSError *error) {
if (!error && results) {
for (HKQuantitySample *samples in results) {
NSLog(@"%@ 至 %@ : %@", samples.startDate, samples.endDate, samples.quantity);
}
} else {
// error
}
}];
[healthStore executeQuery:sampleQuery];這段代碼主要做了以下幾件事:
第一段通過傳入 HKQuantityTypeIdentifierStepCount 創建一個樣品類型實例,告知接下來要獲取的是步數。
第二段創建 NSPredicate 實例,用於獲取某個時間段的數據;這裡 startDate、endDate 傳 nil 表示獲取全部數據。第三個 Option 參數有三個值,我試了不同取值,返回結果都一樣,若有人知道它的用途,歡迎告知。
第三段創建 NSSortDescriptor 實例,用於對查詢結果排序。
第四段通過 HKSampleQuery 的實例方法獲取所需數據。
最後一行執行數據查詢。
通過這段代碼獲取的數據,打印出來會發現它非常詳盡,精確到每一小段時間從開始到結束所獲取的步數。
五、數據采集
有時候需求並不需要這麼詳盡,只希望獲取每小時、每天或每月的步數,這時就要用到另一個類 HKStatisticsCollectionQuery 來做分段采集:
HKQuantityType *quantityType = [HKQuantityType quantityTypeForIdentifier:HKQuantityTypeIdentifierStepCount];
NSDateComponents *dateComponents = [[NSDateComponents alloc] init];
dateComponents.day = 1;
HKStatisticsCollectionQuery *collectionQuery = [[HKStatisticsCollectionQuery alloc]
initWithQuantityType:quantityType
quantitySamplePredicate:nil
options:HKStatisticsOptionCumulativeSum | HKStatisticsOptionSeparateBySource
anchorDate:[NSDate dateWithTimeIntervalSince1970:0]
intervalComponents:dateComponents];
collectionQuery.initialResultsHandler = ^(HKStatisticsCollectionQuery *query, HKStatisticsCollection * __nullable result, NSError * __nullable error) {
for (HKStatistics *statistic in result.statistics) {
NSLog(@"\n%@ 至 %@", statistic.startDate, statistic.endDate);
for (HKSource *source in statistic.sources) {
if ([source.name isEqualToString:[UIDevice currentDevice].name]) {
NSLog(@"%@ -- %f", source, [[statistic sumQuantityForSource:source] doubleValueForUnit:[HKUnit countUnit]]);
}
}
}
};
[healthStore executeQuery:collectionQuery];第一段和之前一樣,定義需要獲取的數據為步數。
第二段創建 NSDateComponents 實例,設置步數的時間間隔,這裡設為按天統計,也可以設為按小時或按月。
第三段創建查詢統計對象 collectionQuery,通過四個參數初始化:
a. 第一個參數同上,設置查詢類型;
b. 第二個參數傳入 NSPredicate 實例,這裡傳 nil;
c. 第三個參數是關鍵,傳入 Option 可選值,告訴對象要獲取什麼。這裡傳 HKStatisticsOptionCumulativeSum | HKStatisticsOptionSeparateBySource,即獲取時間段步數之和,並按不同數據來源分段;
d. 第四個參數傳入一個錨點,類似數組的索引,查詢會從該錨點開始,通過不同錨點可獲取日/周/月/年數據。
第四段給 collectionQuery 的 block 屬性 initialResultsHandler 賦值,它會在查詢成功後回調,從中可獲得想要的數據;最後一行執行該查詢統計。
執行這段代碼,通過打印的日志就能看到當前設備中按日間隔存儲的步行數總和了。
返回數據中,HKSource 對象的 name 可用於區分健康數據來源。一般只獲取設備本身的步數,過濾掉其他第三方來源——目前微信、QQ 的記步就區分了不同數據來源,以防作弊。
最後附上一個仿健康應用步數的 Demo:GitHub 地址。
參考鏈接:
https://vit0.com/blog/2014/10/30/ios-8-healthkit-jie-shao/
https://segmentfault.com/a/1190000003779081