[ 翻译 ] 使用 Swift 和 HealthKit 进行睡眠分析

作者:ANUSHK MITTAL,原文链接,原文日期:2016-01-18
译者:Wiilen

如今,对睡眠监测的创新已经成为一种潮流。用户比以前更加好奇,他们不仅想知道自己的睡眠时间,更想对一段时间内收集的数据进行分析,来了解自己的睡眠趋势。科技的发展也带动了硬件的发展,其中特别是手机的发展,使得睡眠分析这一进步缓慢的领域有了全面的发展。

苹果公司提供了一种酷炫的方式,可以安全地与用户的个人健康信息进行交互,并将这些信息安全地存入内置的 Health App。你不仅可以使用 HealthKit 框架来开发一个健康类 App,也可以通过它来访问睡眠分析数据。

在这个教程中,我将为你快速介绍 HealthKit 框架,并演示如何开发一个用于睡眠分析的简单 App。

介绍

HealthKit 框架提供了一种结构,用于将数据存入名为 HealthKit store 的加密的数据库。你可以使用HKHealthStore类来访这个数据库。iPhone 与 Apple Watch 都有自己的 HealthKit store。健康数据能够在 Apple Watch 与 iPhone 中进行同步,而旧数据会周期性地从 Apple Watch 中清除以节约空间。HealthKit 与 Health App 在 iPad 上无法使用。

HealthKit 是一个强大的工具,可以帮助你开发基于健康数据的 iOS 或 watchOS App。它专门用于管理各种来源的数据,根据用户偏好,它能自动合并不同来源的数据。Apps 也可以访问不同来源的原始数据,自己合并这些数据。这些数据不仅可用于身体测量、健康数据或营养摄入监测,也可以用于睡眠分析。

在这篇文章之后的部分,我将演示在 iOS 上如何使用 HealthKit 框架存储和访问睡眠分析数据。这些方法也可用在 watchOS App 上。请注意这篇教程中使用的是 Swift 2.0 与 Xcode 7。为了完成这篇教程,你需要确保你使用的是 Xcode 7 或以上版本。

在开始之前,下载初始工程并解压它。我已经为你创建了具有基本功能的 UI。运行这个工程,你可以看到一个计时器 UI,在你点击开始按钮之后,它会开始计时。

使用 HealthKit 框架

这个 Apps 的目的是保存睡眠分析数据,并使用startStop按钮来获取这些数据。要使用 HealthKit,你首先需要允许在 app bundle 中使用 HealthKit。在你的项目中,导航到 target -> capabilities 并开启 HealthKit。

下一步,你需要使用以下代码在ViewController中创建一个HKHealthStore的实例:

let HealthStore = HKHealthStore()

之后我们会使用HKHealthStore实例来访问 HealthKit store。

前面提到过,HealthKit 允许用户控制他们的健康数据。所以你首先需要获得用户授权,才能访问(读/写)用户睡眠分析数据。要做到这一点,先 import 内置的HealthKit框架,并更新ViewDidLoad方法:

override func viewDidLoad() {
    super.viewDidLoad()
    
    let typestoRead = Set([
        HKObjectType.categoryTypeForIdentifier(HKCategoryTypeIdentifierSleepAnalysis)!
        ])
    
    let typestoShare = Set([
        HKObjectType.categoryTypeForIdentifier(HKCategoryTypeIdentifierSleepAnalysis)!
        ])
    
    self.healthStore.requestAuthorizationToShareTypes(typestoShare, readTypes: typestoRead) { (success, error) -> Void in
        if success == false {
            NSLog(" Display not allowed")
        }
    }
}

这部分代码会提示用户允许或拒绝授权。在 completion block 中,你可以处理成功或错误信息,并获取最终结果。用户不需要给予你的 App 所请求的全部权限,你需要在 App 中优雅地处理错误。

但为了方便测试,你需要选择“允许”来授权你的 App 访问设备上的健康数据。

写入睡眠分析数据

首先,我们如何获取睡眠分析数据?根据苹果公司的文档,每个睡眠分析样本数据只含有一个值。HealthKit 使用两个或以上在时间上重叠的样本数据,来表示用户躺在床上并处于睡眠中。通过对比这些样本数据的开始及结束时间,App 可以计算出一些二级统计数据:

  • 用户入睡所需要的时间
  • 用户躺在床上的时间里,实际睡着的时间所占的百分比
  • 用户仍躺在床上时,醒过来的次数
  • 用户在床上度过的时间和睡眠时间的总和

简单来说,你需要使用以下方法将睡眠分析数据存入 HealthKit Store:

  1. 我们需要定义两个NSDate对象,对应到开始时间与结束时间。
  2. 之后使用HKCategoryTypeIdentifierSleepAnalysis来创建一个HKObjectType实例。
  3. 我们需要创建一个类型为HKCategorySample的新对象。你通常使用类别样本(Category Sample)来记录睡眠数据。独立样本(Individual Sample)用来表示在某些时间段中,用户躺在床上或处于睡眠中。所以我们需要创建一个记录用户躺在床上时间(In bed)的样本与一个记录用户处于睡眠中(Asleep)的样本,这两个样本可能会有部分时间重叠。
  4. 最后,我们使用HKHealthStore类中的saveObject方法来保存对象。

编辑提示:关于样本的类型,你可以在HealthKit Constants Reference中找到更多详细信息。

如果你想要将上述文字翻译成 Swift 代码,下面是部分代码,用于保存睡眠分析数据,包括在床上度过的时间数据和睡眠时间的数据。请将下列方法插入到ViewController中:

func saveSleepAnalysis() {
    
    // alarmTime 和 endTime 都是 NSDate 对象
    if let sleepType = HKObjectType.categoryTypeForIdentifier(HKCategoryTypeIdentifierSleepAnalysis) {
        
        // 我们创建一个新的对象,并将它导入到 Health app 中
        let object = HKCategorySample(type:sleepType, value: HKCategoryValueSleepAnalysis.InBed.rawValue, startDate: self.alarmTime, endDate: self.endTime)
        
        // 最后,我们保存这个对象
        healthStore.saveObject(object, withCompletion: { (success, error) -> Void in
            
            if error != nil {
                // 错误处理
                return
            }
            
            if success {
                print("My new data was saved in HealthKit")
                
            } else {
                // 另一个错误处理
            }
            
        })
        
        
        let object2 = HKCategorySample(type:sleepType, value: HKCategoryValueSleepAnalysis.Asleep.rawValue, startDate: self.alarmTime, endDate: self.endTime)
        
        healthStore.saveObject(object2, withCompletion: { (success, error) -> Void in
            if error != nil {
                // 错误处理
                return
            }
            
            if success {
                print("My new data (2) was saved in HealthKit")
            } else {
                // 另一个错误处理
            }
            
        })
        
    }
    
}

我们想要将睡眠分析数据存入 HealthKit 时,可以调用这个函数。

读取睡眠分析数据

为了读取睡眠分析数据,我们将创建一个请求。你需要从使用HKCategoryTypeIdentifierSleepAnalysis来创建一个HKObjectType类的实例开始。你可能想使用 predicate,通过startDateendDate这些词来过滤获取的数据,这是一些对应到某些时间段的NSDate对象。你也需要创建一个sortDescriptor来对获取数据的请求进行排序,以选出你需要的结果。

用于获取睡眠分析数据的代码如下:

func retrieveSleepAnalysis() {
    
    // 首先,我们定义需要的对象类型
    if let sleepType = HKObjectType.categoryTypeForIdentifier(HKCategoryTypeIdentifierSleepAnalysis) {
        
        // 使用 sortDescriptor 来获取时间由近到远的数据
        let sortDescriptor = NSSortDescriptor(key: HKSampleSortIdentifierEndDate, ascending: false)
        
        // 创建查询请求,以及一个 completion block
        let query = HKSampleQuery(sampleType: sleepType, predicate: nil, limit: 30, sortDescriptors: [sortDescriptor]) { (query, tmpResult, error) -> Void in
            
            if error != nil {
                
                // 错误处理
                return
                
            }
            
            if let result = tmpResult {
                
                // 处理取得的数据
                for item in result {
                    if let sample = item as? HKCategorySample {
                        let value = (sample.value == HKCategoryValueSleepAnalysis.InBed.rawValue) ? "InBed" : "Asleep"
                        print("Healthkit sleep: \(sample.startDate) \(sample.endDate) - value: \(value)")
                    }
                }
            }
        }
        
        // 最后,执行查询请求
        healthStore.executeQuery(query)
    }
}

上面的代码向 HealthKit 发出查询请求,来获得所有的睡眠分析数据,再对这些数据以时间降序进行排序。之后每条请求打印出了开始时间与结束时间,并标明是在床上度过的类型数据,或是在睡眠状态的类型数据。我将请求的时间设为30,来获取过去30秒内记录的样本。你也可以使用 predicate 方法来自定义开始与结束时间。

App 测试

在这个 demo 中,我使用一个NSTimer对象,在你点击了开始按钮之后进行计时。在开始的时候与结束的时候,我们各创建了一个NSDate对象,将睡眠分析数据保存为经过的时间。在调用stop方法时,你可以调用saveSleepAnalysis()retrieveSleepAnalysis()来保存并获取睡眠数据。

@IBAction func stop(sender: AnyObject) {
    endTime = NSDate()
    saveSleepAnalysis()
    retrieveSleepAnalysis()
    timer.invalidate()
}

在你的 App 中,你可能想要改变NSDate对象,为躺在床上和处于睡眠中这两种状态选择(可能不同的)开始与结束时间。

在你做出这些改变之后,你可以运行这个 demo 并启动计时器。让它运行一段时间,然后点击停止按钮。做完这些之后,打开 Health App,你会发现 App 中出现了睡眠数据。

一些关于 HealthKit App 的建议

HealthKit 提供了一个通用的平台,通过这个平台,App 开发者们可以方便地分享和访问用户数据,避免获得重复或不连续的数据。苹果公司的审核指南中明确指出,对于那些使用了 HealthKit 并请求读写权限的 App,如果没有明确演示它们的用途,可能会在审核时被拒绝。

那些保存了虚假或错误数据到 Health App 中的 App,可能也会被拒。这意味着你不能使用自己的算法来计算不同的健康数据,比如这个教程中的睡眠分析数据。你应该尝试读取内建的传感器数据,并调整任意参数以避免计算出错误的数据。

你可以点击这里获取完整的 Xcode 项目。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容