序言
什么是 Application Extensions?apple 为什么会提供这个功能,她又为我们解决了什么问题?
早在 iOS8 的时候 apple 就为我们提供了 extension 的能力,只是那个时候开放给我们的权限还不多,我们能做的事情远没有像在 iOS10 里这样颠覆。说了半天到底什么是 app extensions?!
这里引用一篇 blog 的概况:
extension 是 iOS 开放给我们的一种对固定系统区域的扩展
说的再直白一点,extensions 让我们能够对系统应用,如神圣的电话,短信等做进一步的扩展。让用户通过原生系统应用在不打开我们 app 的情况下就可以使用我 app 分享出来的能力。
你可能会问,那又能怎么样呢?确实,这个能力看起来对开发者并没有直接的好处,反而使 apple 将自己系统应用的能力变强大了。但反过来想,这样不也帮助 app 提升了用户导入率,让用户有更多的几率打开我们的 app。
解密 App Extensions
最近项目新需求,希望能识别来电号码。这个需求说实话,在 android 上早已不是什么稀奇的能力,各大手机管家,安全卫士都有号码识别和防骚扰的功能。但由于 iOS 限制,电话的相关接口都是私有的,想截获来电基本是不可能。在调研过程中,发现有部分 iOS app 尽然做到了号码识别。于是抱着人家能做的,我也能做的心态,就开始了各种尝试。
因为之前有了解 iOS10 的新特性,自然就想到了从新特性中下手。app extensions 自然就变成了最先的尝试方案。经过查阅资料,终于粗略的实现了号码识别功能。
这里值得多说一句,强烈推荐仔细阅读一下,参考里的《WWDC2014之App Extensions学习笔记》。他能很好的帮助你了解,containing app、extension、host app 之间的关系。
extensions 不能单独生存,必须依附在 containing app。所以 extensions 都是以 targets 的形式存在于 project。并且伴随着 containing app 的卸载而删除
Call Directory Extension
call directory extension 顾名思义就是对通话的扩展。下面我们来从零构建一个具备号码识别的 app
在已有的工程中,file -> new -> target -> call directory extension。根据提示完成后,会发现 project 中多了一个文件夹。文件夹的名称就是你之前添加的 target name。文件夹里有一个 CallDirectoryHandler.swift 文件,这是创建 extension 时 Xcode 为我们自动生成的。简单说一下该文件的内容:
// CallDirectoryHeandler.swift
/*
用户在”设置->电话->来电阻止和身份认证“中开启应用的时候,会触发该方法。
所以我们要在这个方法中完成来电阻止和身份认证的操作。好在自动生成代码已经帮我们做了这部分逻辑。
*/
override func beginRequest(with context: CXCallDirectoryExtensionContext) {
context.delegate = self
do {
try addBlockingPhoneNumbers(to: context)
} catch {
NSLog("Unable to add blocking phone numbers")
let error = NSError(domain: "CallDirectoryHandler", code: 1, userInfo: nil)
context.cancelRequest(withError: error)
return
}
do {
try addIdentificationPhoneNumbers(to: context)
} catch {
NSLog("Unable to add identification phone numbers")
let error = NSError(domain: "CallDirectoryHandler", code: 2, userInfo: nil)
context.cancelRequest(withError: error)
return
}
// 关键代码,通知系统更新我们为 CXCallDirectoryExtensionContext 添加的资源
context.completeRequest()
}
private func addBlockingPhoneNumbers(to context: CXCallDirectoryExtensionContext) throws {
// 在这里我们将需要阻止的号码添加进数组即可。需要注意的是,这个数组内容必须是升序。号码前要加 +86
let phoneNumbers: [CXCallDirectoryPhoneNumber] = [ +8614085555555, +8618005555555 ]
// 以下逻辑是关键,将阻止号码的数组添加到 CXCallDirectoryExtensionContext
for phoneNumber in phoneNumbers {
context.addBlockingEntry(withNextSequentialPhoneNumber: phoneNumber)
}
}
private func addIdentificationPhoneNumbers(to context: CXCallDirectoryExtensionContext) throws {
// 添加来电提醒的用户识别号码和对应的名称,且号码数组的内容必须是升序。号码前要加 +86
var phoneNumbers: [CXCallDirectoryPhoneNumber] = [ +861234567890 ]
var labels = [ "robert zhang" ]
for (phoneNumber, label) in zip(phoneNumbers, labels) {
context.addIdentificationEntry(withNextSequentialPhoneNumber: phoneNumber, label: label)
}
}
代码并不难理解。但我相信你会有一个疑问,如果需要动态添加资源该怎么办?这个简单,只需要动态读取数据库中相应号码并添加进 phoneNumbers 数组就可以了!如果你这样想,那就祝贺你想错了。因为 extensins 与我们的 containing app 并不在同一个 bundle,所以她们之间的数据是不可直接共享的。那该怎么办呢?好在 App Groups 可以解决应用间共享资源的问题。所以我们需要在 targets -> 选中 extension -> Capabilities -> 开启 App Groups,add a new container。并勾选该 App Groups。
添加成功后如下图:
在主应用中也得开启 App Groups,勾选刚才添加的 group id。App Groups 建立完成后,就可以为她们添加共享数据了。这里需要提示一下。当我们为项目开启 App Groups 的时候需要更新一下 Provisioning Profile ,否则编译是不会通过的。
现在我们动态的为 phoneNumbers 添加数据,代码如下:
// CallDirectoryHeandler.swift
private func addIdentificationPhoneNumbers(to context: CXCallDirectoryExtensionContext) throws {
// 添加来电提醒的用户识别号码和对应的名称,且号码数组的内容必须是升序。号码前要加 +86
var phoneNumbers: [CXCallDirectoryPhoneNumber] = [ +861234567890 ]
var labels = [ "robert zhang" ]
// 动态获取 App Groups 共享资源
if let (phone,label) = readPhoneSrc() {
phoneNumbers.append(contentsOf: phone)
labels.append(contentsOf: label)
}
for (phoneNumber, label) in zip(phoneNumbers, labels) {
context.addIdentificationEntry(withNextSequentialPhoneNumber: phoneNumber, label: label)
}
}
/*
从 Groups 的共享文件区域获取号码资源
*/
private func readPhoneSrc() -> (phoneNumbers:[CXCallDirectoryPhoneNumber],labels:[String])?{
// forSecurityApplicationGroupIdentifier 的参数是 App Groups 的名称
let url = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "group.XXXX")
let containerUrl = url?.appendingPathComponent("Library/Caches/dir.plist")
let exist = FileManager.default.fileExists(atPath: containerUrl!.path)
if exist {
let dict = NSDictionary(contentsOf: containerUrl!) as! [String:String]
let keys = dict.keys.sorted()
var phoneNumber: [CXCallDirectoryPhoneNumber] = []
var label = [String]()
for item in keys {
phoneNumber.append(atoll("+86"+item))
label.append(dict[item]!)
}
return (phoneNumber,label)
}
return nil
}
代码比较简单,就不赘述了。当然这只是 extension 读取 groups 共享资源的代码,你还需要完成主应用写入资源的逻辑。这部分代码是在主应用中的。
class DataHelper {
static func addPhoneSrc() {
// forSecurityApplicationGroupIdentifier 与 App Groups ID 名称一致
let url = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "group.XXXXX")
// 存储共享资源的文件路径
let containerUrl = url?.appendingPathComponent("Library/Caches/dir.plist")
let exist = FileManager.default.fileExists(atPath: containerUrl!.path)
if !exist {
let data = NSData(base64Encoded:"aXVstH8gc29cbXP=",options:.ignoreUnknownCharacters)
let createSuccess = FileManager.default.createFile(atPath: containerUrl!.path,contents:data as Data?,attributes:nil)
print("文件创建结果: \(createSuccess)")
}
// 提示这里可以根据具体业务,完成号码的写入
let dicts = NSDictionary(dictionary: ["1234567890":"robert zhang"])
dicts.write(to: containerUrl!, atomically: true)
}
}
关于 App Groups 资源共享,这里使用的是 plist 文件。当然还有其他的资源共享方式,使用数据库共享也是可以的。在此只举例了身份认证的逻辑,来电阻止的思路基本一致。
这就是全部的内容?当然不是,还有一个问题。如果想要实时的更新来电阻止和身份认证的号码库该怎么办呢?难道每次都去设置中进行号码识别的开关操作?当然不用这么麻烦。
// 在业务需要的地方添加下面代码,注意该逻辑需要在主应用中。
@available(iOS 10.0, *) // call directory 只在 iOS10 以上版本可用
func reloadCallDirectory() {
let manger = CXCallDirectoryManager.sharedInstance
// withIdentifier 为 extension 的 bundle identifier
// 判断是否在设置中打开来电阻止和身份认证的开关
manger.getEnabledStatusForExtension(withIdentifier: "XXXXX", completionHandler: { enabledStatus, error in
NSLog("******** \(enabledStatus.rawValue) *** \(error)")
if error == nil {
if enabledStatus == CXCallDirectoryManager.EnabledStatus.enabled {
// withIdentifier 为 extension 的 bundle identifier
// 其实就是调用 CallDirectoryHandler 的 beginRequest(with context: CXCallDirectoryExtensionContext) 方法
manger.reloadExtension(withIdentifier: "XXXXXX", completionHandler: { error in
NSLog("======\(error == nil ? "OK" : "Error")")
})
}
}
})
}
就此,号码识别的功能基本上就完成了。整体来看,难点并不在 Call Directory Extension 的开发,而是 App Groups 共享数据。