本文示範如何用 AddressBook 框架讀取使用者通訊錄中的聯絡人姓名與電話號碼。第一步是先把 AddressBook.framework 加入專案。
- (IBAction)add:(id)sender {
ABAddressBookRequestAccessWithCompletion(ABAddressBookRef addressBookRef, ^(bool granted, CFErrorRef error) {
if (granted) {
// 資料庫操作回到主執行緒處理 UI 相關事宜
dispatch_async(dispatch_get_main_queue(), ^{
NSArray *array = [self getContactsFromAddressBook];
});
} else {
// TODO: 提示使用者權限被拒絕
}
});
}-(NSMutableArray *)getContactsFromAddressBook {
CFErrorRef error = NULL;
NSMutableArray *contacts = [[NSMutableArray alloc] init];
ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, &error);
if (addressBook) {
NSArray *allContacts = (__bridge_transfer NSArray *)ABAddressBookCopyArrayOfAllPeople(addressBook);
NSMutableArray *mutableContacts = [NSMutableArray arrayWithCapacity:allContacts.count];
NSUInteger i = 0;
for (i = 0; i < [allContacts count]; i++) {
// THContact 為自訂 model,含 name 與 phoneNum 等屬性
THContact *contact = [[THContact alloc] init];
ABRecordRef contactPerson = (__bridge ABRecordRef)allContacts[i];
contact.recordId = ABRecordGetRecordID(contactPerson);
// 取得名字
NSString *firstName = (__bridge_transfer NSString *)ABRecordCopyValue(contactPerson, kABPersonFirstNameProperty);
NSString *lastName = (__bridge_transfer NSString *)ABRecordCopyValue(contactPerson, kABPersonLastNameProperty);
NSString *midName = (__bridge_transfer NSString *)ABRecordCopyValue(contactPerson, kABPersonMiddleNameProperty);
contact.firstName = firstName;
contact.lastName = lastName;
contact.middleName = midName;
// 取得電話號碼(一筆聯絡人可能有多組號碼)
ABMultiValueRef phonesRef = ABRecordCopyValue(contactPerson, kABPersonPhoneProperty);
contact.phone = [self getMobilePhoneProperty:phonesRef];
if (phonesRef) {
CFRelease(phonesRef);
}
// 只保留有電話的聯絡人
if (contact.phone.count > 0) {
[mutableContacts addObject:contact];
}
}
if (addressBook) {
CFRelease(addressBook);
}
contacts = [NSMutableArray arrayWithArray:mutableContacts];
return contacts;
} else {
NSLog(@"Error");
}
return nil;
}
- (NSMutableArray *)getMobilePhoneProperty:(ABMultiValueRef)phonesRef {
NSMutableArray *array = [NSMutableArray array];
for (int k = 0; k < (int)ABMultiValueGetCount(phonesRef); k++) {
// 若需要電話標籤(手機、住家、工作),可改抓 localized label:
// NSString *personPhoneLabel = (__bridge NSString *)ABAddressBookCopyLocalizedLabel(
// ABMultiValueCopyLabelAtIndex(phonesRef, k));
NSString *personPhone = (__bridge NSString *)ABMultiValueCopyValueAtIndex(phonesRef, k);
if (personPhone) {
[array addObject:personPhone];
}
}
return array;
}ARC 下的 CF 物件管理。AddressBook 是 C API,回傳的是 Core Foundation 物件,必須自己用 CFRelease 釋放。範例中的 __bridge_transfer 表示「所有權從 CF 轉移到 ARC」,ARC 會接手後續釋放,所以這些不需要再手動 CFRelease;而 ABRecordCopyValue 得到的 phonesRef 沒有轉交所有權,就必須自己放。搞混這兩者就會出現記憶體洩漏或重複釋放。
權限流程。iOS 6 之後,存取通訊錄必須先取得使用者授權,ABAddressBookRequestAccessWithCompletion 的 completion 可能在非主執行緒被呼叫,若要在其中更新 UI,記得切回主執行緒。
API 已被取代。AddressBook 從 iOS 9 起已被標記為廢棄,取而代之的是 Contacts.framework(CNContactStore、CNContact)。新專案請直接使用新框架,它提供了更清晰的物件導向介面,也不必再處理 CF 記憶體管理;同時 Info.plist 中需要加入 NSContactsUsageDescription 說明用途,否則 App 會直接崩潰。