Checking API Availability With Swift

title: "使用 Swift 检查 API 可用性"
date: 2015-8-24
tags: [Swift]
categories: [Swift]
permalink: checking-api-availability-with-swift
@SwiftGG

使用 Swift 检查 API 可用性

原文链接

Swift 2 做了一些改进,能够更简单、更安全地检查 API 可否用于特定的 iOS 版本。

Objective-C 方法概述

在看 Swift 之前,我们先来简单地概述一下在 Objective-C 中,我们是如何来查看 SDK 的可用性的。

检查类/框架的可用性

就像所有重大发布一样,iOS 9 的发布推出了许多新的框架。如果要部署在 iOS9 以下的系统上,你需要以弱连接的方式使用那些新框架,并且将在运行时检查类的可用性。比如,我们想使用 iOS9 上的新的 Contacts 框架,但是也要在其不可用的时候能退回到 iOS8 上较老的 address book 框架:

if ([CNContactStore class]) {
  CNContactStore *store = [CNContactStore new];
  //...
} else {
  // Fallback to old framework
}

检查方法的可用性

使用respondsToSelector来检查框架中是否添加有该方法。比如,iOS9 在 Core Location 中引入了 allowsBackgroundLocationUpdates 属性:

CLLocationManager *manager = [CLLocationManager new];
if ([manager respondsToSelector:@selector(setAllowsBackgroundLocationUpdates:)]) {
  // 在 iOS 8 中不可用
  manager.allowsBackgroundLocationUpdates = YES;
}

陷阱

这种检查可用性的方式很难维护,也不像它们看起来那样安全。思考一下,如果我们要检测一个符号(symbol)的可用性,这个符号(symbol)在以前 Apple 版本中是私有的,但现在是公有的了,会发生什么呢。比如,在iOS9中有UIFontTextStyleCallout在内的几个新的文本样式。想要使用 iOS9 中的这种样式,你可以试着用上面的方式检查一下,本来预计在iOS8中应该是空值:

if (UIFontTextStyleCallout) {
  textLabel.font = [UIFont preferredFontForTextStyle:UIFontTextStyleCallout];
}

不幸的是,这种方式并不像期待中那样有效。结果会显示这种符号在 iOS8 中存在,只是并不是公共声明的。使用私有的方法或值会导致无法预测的结果,这并不是我们想要的。

Swift 2 方法##

Swift 中这些可用性检查是内置的,而且是在编译时检查。这意味着,当我们使用的 API 在部署目标系统不可用时,Xcode 能及时告诉我们。比如,如果我试着在 iOS8 中使用CNContactStore,Xcode 会提示做出如下修改:

if #available(iOS 9.0, *) {
  let store = CNContactStore()
} else {
  // 回滚到旧的版本
}

你可以使用同样的方法代替之前我们使用的respondsToSelector来进行检查:

let manager = CLLocationManager()
if #available(iOS 9.0, *) {
  manager.allowsBackgroundLocationUpdates = true
}

可用性条件

#available条件中包含了一些平台(ios,OSX,watchOS)和版本。比如,一些代码只能运行在 iOS9 或者 OS X 10.10 中:

if #available(iOS 9, OSX 10.10, *) {
  // 在 iOS 9, OS X 10.10 中执行的代码
}

你总是需要最后的那个 * 通配符来包含其他未指定的平台,尽管你的 App 并不针对它们。

你可以通过以下方式来提高代码的可读性。如果你的代码中有判断语句,你可以通过在guard语句中使用#available,从而能在函数中快速返回:

private func somethingNew() {
  guard #available(iOS 9, *) else { return }

  // do something on iOS 9
  let store = CNContactStore()
  let predicate = CNContact.predicateForContactsMatchingName("Zakroff")
  let keys = [CNContactGivenNameKey, CNContactFamilyNameKey]
  ...
}

如果你需要一个函数或类只在某些条件下可用, 使用@available关键字:

@available(iOS 9.0, *)
private func checkContact() {
  let store = CNContactStore()
  // ...
}

编译时安全##

最后,我们再来看这个问题。有些属性在 iOS 9 中是公有的,但是在 iOS 8 中是私有的。如果我们在 iOS 8 中设置 iOS 9 特有的字体,会导致一个编译时错误:

label.font = UIFont.preferredFontForTextStyle(UIFontTextStyleCallout)
> 'UIFontTextStyleCallout' is only available on iOS 9.0 or newer

Swift 可以依据平台版本轻松进行检测并退回到一个合理的默认值:

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

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,551评论 4 58
  • 写给我记忆里的逗比同桌 作者:艾叶子 最近一段...
    艾叶子阅读 321评论 1 1
  • 王阳明的心学是中国哲学发展之大成,以儒家为主体但又融汇释、老,吾心即天理、知行合一、格物致知、致良知,将思想...
    善行者大正阅读 119评论 0 2
  • 刚开始是没有兴趣,因为觉得无利可图,累人还烦心。后来,做着做着就上瘾了,虽然依然是无利可图,可它带给了我其它的乐趣...
    残剑阅读 404评论 0 1
  • 为什么我还找不到男朋友,我们究竟是怎么错过的,或许我就是这样子迷失了你。 【你我本是陌路人】 去年5月底,初到西藏...
    哲儿疯king阅读 686评论 3 2