iOS 6 是通訊錄 API 的一個分水嶺:方法被換掉,而且多了一道「必須先取得使用者授權」的關卡。以下把兩種系統版本的處理方式整理在同一段程式碼裡。
需要加入 AddressBook.framework 與 AddressBookUI.framework。
iOS 6 之前,直接建立聯絡簿即可:
ABAddressBookRef addressBook = ABAddressBookCreate();
iOS 6 之後這個方法被廢棄,改用帶 options 的新版本:
AB_EXTERN ABAddressBookRef ABAddressBookCreateWithOptions(CFDictionaryRef options, CFErrorRef* error)
__OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_6_0);
而且每個 App 要存取通訊錄,都必須先取得使用者同意:
// 系統定義的 block
typedef void(^ABAddressBookRequestAccessCompletionHandler)(bool granted, CFErrorRef error);
// 請求授權,第二個參數即為上述 block
AB_EXTERN void ABAddressBookRequestAccessWithCompletion(
ABAddressBookRef addressBook,
ABAddressBookRequestAccessCompletionHandler completion)
__OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_6_0);
-(void)getAddress
{
ABAddressBookRef addressBook = nil;
if ([[UIDevice currentDevice].systemVersion floatValue] >= 6.0) {
// 6.0 以上:必須先請使用者授權
addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
// 使用 GCD 信號量把非同步的授權回呼轉為同步等待。
// 資源數為 0 時 dispatch_semaphore_wait 會立即阻塞。
dispatch_semaphore_t sema = dispatch_semaphore_create(0);
ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error){
// 使用者回應後才會進入這個 block,送出一個信號讓 wait 返回
dispatch_semaphore_signal(sema);
});
// 若 block 尚未執行,這裡會持續等待,直到使用者按下允許
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
dispatch_release(sema);
// 若使用者拒絕,下方取出的內容會是空的
} else {
// 6.0 以前:不需授權,直接存取
addressBook = ABAddressBookCreate();
}
// 取出所有聯絡人
CFArrayRef results = ABAddressBookCopyArrayOfAllPeople(addressBook);
// 用 long 而非 int,為了相容 64 位元
long peopleCount = CFArrayGetCount(results);
for (int i = 0; i < peopleCount; i++) {
ABRecordRef record = CFArrayGetValueAtIndex(results, i);
// 名字
CFTypeRef tmp = NULL;
tmp = ABRecordCopyValue(record, kABPersonFirstNameProperty);
if (tmp) { CFRelease(tmp); tmp = NULL; }
tmp = ABRecordCopyValue(record, kABPersonLastNameProperty);
if (tmp) { CFRelease(tmp); tmp = NULL; }
// 完整姓名
CFStringRef fullName = ABRecordCopyCompositeName(record);
NSLog(@"%@", (NSString*)fullName);
if (fullName) CFRelease(fullName);
// 電話可能有多筆
ABMultiValueRef phones = ABRecordCopyValue(record, kABPersonPhoneProperty);
long phoneCount = ABMultiValueGetCount(phones);
for (int j = 0; j < phoneCount; j++) {
CFStringRef label = ABMultiValueCopyLabelAtIndex(phones, j);
CFStringRef number = ABMultiValueCopyValueAtIndex(phones, j);
CFStringRef local = ABAddressBookCopyLocalizedLabel(label);
NSLog(@"number %@", (NSString *)number);
if (local) CFRelease(local);
if (label) CFRelease(label);
if (number) CFRelease(number);
}
if (phones) CFRelease(phones);
}
if (results) CFRelease(results);
if (addressBook) CFRelease(addressBook);
}
系統只會在「第一次」詢問時跳出提示框,之後使用者一旦做了選擇就不再詢問。因此 App 應該主動查詢狀態,依結果給出不同引導:
typedef CF_ENUM(CFIndex, ABAuthorizationStatus) {
kABAuthorizationStatusNotDetermined = 0, // 尚未決定
kABAuthorizationStatusRestricted, // 受限(例如家長控制)
kABAuthorizationStatusDenied, // 使用者已拒絕
kABAuthorizationStatusAuthorized // 已允許
};
AB_EXTERN ABAuthorizationStatus ABAddressBookGetAuthorizationStatus(void)
__OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_6_0);
ABAuthorizationStatus statu = ABAddressBookGetAuthorizationStatus();
實務上最常見的疏漏是:使用者先前已按「不允許」,此時 ABAddressBookRequestAccessWithCompletion 不會再彈框,回呼會直接帶著 granted = NO 回來。App 應該在這個狀態下引導使用者到「設定 → 隱私 → 聯絡人」手動開啟,而不是什麼都不顯示。
範例中用 dispatch_semaphore 把非同步回呼包成同步流程,寫法直觀,但它會讓目前執行緒停住。若這段程式跑在主執行緒,而系統回呼又需要主執行緒才能派發,就有死鎖風險。較穩妥的做法是維持非同步風格,把後續處理寫進回呼裡;若使用新的 Contacts.framework(iOS 9 起),API 本身就是 Promise 友善的設計,也更容易寫得安全。
另外,凡是用 Copy / Create 取得的 Core Foundation 物件都要 CFRelease,這段程式裡每個都配對了釋放,是撰寫這類程式碼時最容易被忽略、也最容易造成洩漏的地方。