MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

Objective-C中的AddressBook框架使用指南

2024-05-085.7k 阅读

一、AddressBook框架概述

在Objective-C开发中，AddressBook框架为开发者提供了访问设备通讯录数据的能力。通过这个框架，我们能够读取联系人信息，如姓名、电话号码、电子邮件地址等，甚至还可以对通讯录进行写入操作，例如添加新联系人、修改现有联系人信息等。这在许多需要与用户通讯信息交互的应用程序中，如社交应用、客户管理应用等，是非常实用的功能。

AddressBook框架是基于Core Foundation框架构建的，因此它的很多接口都遵循Core Foundation的设计模式，这意味着在使用时，我们需要注意内存管理，遵循Core Foundation的内存管理规则（例如使用CFRetain和CFRelease来管理对象的引用计数）。

二、AddressBook框架的导入与初始化

要使用AddressBook框架，首先需要在项目中导入该框架。在Xcode项目中，通过以下步骤导入：

  1. 打开项目导航栏。
  2. 选择项目文件，然后在“TARGETS”下选择你的目标应用。
  3. 点击“Build Phases”标签。
  4. 在“Link Binary With Libraries”部分，点击“+”号，然后在弹出的列表中找到“AddressBook.framework”并添加。

导入框架后，在需要使用通讯录功能的文件中，引入头文件：

#import <AddressBook/AddressBook.h>

初始化AddressBook框架通常涉及获取通讯录数据库的引用。我们可以使用ABAddressBookCreate函数（在较新的iOS版本中，推荐使用基于块的异步创建方式ABAddressBookCreateWithOptions）来获取通讯录数据库的引用。以下是使用ABAddressBookCreate的示例代码：

ABAddressBookRef addressBook = ABAddressBookCreate();
if (addressBook) {
    // 在此处可以对通讯录进行操作
    CFRelease(addressBook);
}

上述代码中，首先通过ABAddressBookCreate获取通讯录数据库的引用，如果获取成功，就可以在if块内对通讯录进行各种操作，操作完成后，使用CFRelease释放引用，以避免内存泄漏。

三、权限请求

在iOS中，访问用户通讯录需要获取用户的授权。从iOS 6.0开始，应用程序必须在使用通讯录数据之前请求用户授权。

可以使用ABAddressBookRequestAccessWithCompletion函数来请求授权，该函数是异步的，会弹出系统授权提示框。以下是示例代码：

ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            // 授权成功，在此处进行通讯录操作
        } else {
            // 授权失败处理
        }
        CFRelease(addressBook);
    });
}

在上述代码中，首先使用ABAddressBookCreateWithOptions创建通讯录引用，然后通过ABAddressBookRequestAccessWithCompletion请求授权。在完成块中，根据granted的值判断授权是否成功。如果成功，可以在块内进行通讯录操作；如果失败，则进行相应的处理。注意在完成块内释放通讯录引用。

四、读取联系人信息

  1. 获取所有联系人 获取通讯录中的所有联系人，可以使用ABAddressBookCopyArrayOfAllPeople函数，该函数返回一个包含所有联系人记录的数组。示例代码如下：
ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            CFArrayRef allPeople = ABAddressBookCopyArrayOfAllPeople(addressBook);
            CFIndex numberOfPeople = CFArrayGetCount(allPeople);
            for (CFIndex i = 0; i < numberOfPeople; i++) {
                ABRecordRef person = CFArrayGetValueAtIndex(allPeople, i);
                // 在此处处理每个联系人记录
            }
            CFRelease(allPeople);
        }
        CFRelease(addressBook);
    });
}

上述代码中，在获取授权成功后，通过ABAddressBookCopyArrayOfAllPeople获取所有联系人的数组，然后通过CFArrayGetCount获取联系人数量，并通过循环遍历数组获取每个联系人记录ABRecordRef。

  1. 获取联系人的基本信息 对于每个ABRecordRef类型的联系人记录，可以获取其各种信息，如姓名、电话号码、电子邮件等。
    • 获取姓名：可以使用ABRecordCopyValue函数获取联系人的名字和姓氏。示例代码如下：
ABRecordRef person = CFArrayGetValueAtIndex(allPeople, i);
CFStringRef firstName = ABRecordCopyValue(person, kABPersonFirstNameProperty);
CFStringRef lastName = ABRecordCopyValue(person, kABPersonLastNameProperty);
if (firstName) {
    NSString *firstNameStr = (__bridge NSString *)firstName;
    NSLog(@"First Name: %@", firstNameStr);
    CFRelease(firstName);
}
if (lastName) {
    NSString *lastNameStr = (__bridge NSString *)lastName;
    NSLog(@"Last Name: %@", lastNameStr);
    CFRelease(lastName);
}

在上述代码中，通过ABRecordCopyValue分别获取联系人的名字和姓氏属性值，将其转换为NSString类型后进行日志输出，最后使用CFRelease释放Core Foundation对象。 - 获取电话号码：联系人可能有多个电话号码，电话号码信息存储在多值属性中。可以使用ABMultiValueRef来处理多值属性。示例代码如下：

ABMultiValueRef phoneNumbers = ABRecordCopyValue(person, kABPersonPhoneProperty);
CFIndex numberOfPhones = ABMultiValueGetCount(phoneNumbers);
for (CFIndex j = 0; j < numberOfPhones; j++) {
    CFStringRef phoneLabel = ABMultiValueCopyLabelAtIndex(phoneNumbers, j);
    NSString *phoneLabelStr = (__bridge NSString *)phoneLabel;
    CFStringRef phoneNumber = ABMultiValueCopyValueAtIndex(phoneNumbers, j);
    NSString *phoneNumberStr = (__bridge NSString *)phoneNumber;
    NSLog(@"Phone Label: %@, Phone Number: %@", phoneLabelStr, phoneNumberStr);
    CFRelease(phoneLabel);
    CFRelease(phoneNumber);
}
CFRelease(phoneNumbers);

上述代码中，首先通过ABRecordCopyValue获取联系人的电话号码多值属性ABMultiValueRef，然后通过ABMultiValueGetCount获取电话号码数量，再通过循环遍历获取每个电话号码的标签和号码值，并进行日志输出，最后释放相关的Core Foundation对象。 - 获取电子邮件地址：与获取电话号码类似，电子邮件地址也是多值属性。示例代码如下：

ABMultiValueRef emailAddresses = ABRecordCopyValue(person, kABPersonEmailProperty);
CFIndex numberOfEmails = ABMultiValueGetCount(emailAddresses);
for (CFIndex k = 0; k < numberOfEmails; k++) {
    CFStringRef emailLabel = ABMultiValueCopyLabelAtIndex(emailAddresses, k);
    NSString *emailLabelStr = (__bridge NSString *)emailLabel;
    CFStringRef emailAddress = ABMultiValueCopyValueAtIndex(emailAddresses, k);
    NSString *emailAddressStr = (__bridge NSString *)emailAddress;
    NSLog(@"Email Label: %@, Email Address: %@", emailLabelStr, emailAddressStr);
    CFRelease(emailLabel);
    CFRelease(emailAddress);
}
CFRelease(emailAddresses);

此代码与获取电话号码的代码结构相似，用于获取并输出联系人的电子邮件地址及其标签。

五、添加新联系人

添加新联系人需要创建一个新的ABRecordRef对象，并设置其属性值，然后将其添加到通讯录数据库中并保存。示例代码如下：

ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            ABRecordRef newPerson = ABPersonCreate();
            CFErrorRef error = NULL;
            // 设置名字
            CFStringRef firstName = CFSTR("New");
            if (!ABRecordSetValue(newPerson, kABPersonFirstNameProperty, firstName, &error)) {
                NSLog(@"Failed to set first name: %@", (__bridge NSError *)error);
            }
            // 设置姓氏
            CFStringRef lastName = CFSTR("User");
            if (!ABRecordSetValue(newPerson, kABPersonLastNameProperty, lastName, &error)) {
                NSLog(@"Failed to set last name: %@", (__bridge NSError *)error);
            }
            // 添加电话号码
            ABMultiValueRef phoneMultiValue = ABMultiValueCreateMutable(kABMultiStringPropertyType);
            CFStringRef phoneNumber = CFSTR("1234567890");
            ABMultiValueAddValueAndLabel(phoneMultiValue, phoneNumber, kABPersonPhoneMobileLabel, NULL);
            if (!ABRecordSetValue(newPerson, kABPersonPhoneProperty, phoneMultiValue, &error)) {
                NSLog(@"Failed to set phone number: %@", (__bridge NSError *)error);
            }
            CFRelease(phoneMultiValue);
            // 添加到通讯录
            if (!ABAddressBookAddRecord(addressBook, newPerson, &error)) {
                NSLog(@"Failed to add person: %@", (__bridge NSError *)error);
            }
            // 保存通讯录更改
            if (!ABAddressBookSave(addressBook, &error)) {
                NSLog(@"Failed to save address book: %@", (__bridge NSError *)error);
            }
            CFRelease(newPerson);
        }
        CFRelease(addressBook);
    });
}

上述代码中，首先获取授权，然后创建一个新的联系人记录ABRecordRef。接着通过ABRecordSetValue设置联系人的名字、姓氏和电话号码属性。电话号码使用ABMultiValueCreateMutable创建一个可变的多值属性对象，并通过ABMultiValueAddValueAndLabel添加电话号码及其标签。之后将新联系人记录添加到通讯录数据库，并通过ABAddressBookSave保存更改。注意在操作完成后释放所有相关的Core Foundation对象。

六、修改联系人信息

修改联系人信息与添加新联系人类似，首先获取要修改的联系人记录，然后修改其属性值并保存。示例代码如下：

ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            CFArrayRef allPeople = ABAddressBookCopyArrayOfAllPeople(addressBook);
            CFIndex numberOfPeople = CFArrayGetCount(allPeople);
            for (CFIndex i = 0; i < numberOfPeople; i++) {
                ABRecordRef person = CFArrayGetValueAtIndex(allPeople, i);
                CFStringRef lastName = ABRecordCopyValue(person, kABPersonLastNameProperty);
                if (lastName && CFStringCompare(lastName, CFSTR("OldLastName"), 0) == kCFCompareEqualTo) {
                    // 找到要修改的联系人
                    CFErrorRef error = NULL;
                    // 修改名字
                    CFStringRef newFirstName = CFSTR("NewFirstName");
                    if (!ABRecordSetValue(person, kABPersonFirstNameProperty, newFirstName, &error)) {
                        NSLog(@"Failed to set new first name: %@", (__bridge NSError *)error);
                    }
                    // 保存通讯录更改
                    if (!ABAddressBookSave(addressBook, &error)) {
                        NSLog(@"Failed to save address book: %@", (__bridge NSError *)error);
                    }
                    break;
                }
                CFRelease(lastName);
            }
            CFRelease(allPeople);
        }
        CFRelease(addressBook);
    });
}

在上述代码中，首先获取所有联系人，然后通过比较姓氏找到要修改的联系人。找到后，通过ABRecordSetValue修改其名字属性，并通过ABAddressBookSave保存更改。同样，要注意释放相关的Core Foundation对象。

七、删除联系人

删除联系人相对简单，先获取要删除的联系人记录，然后从通讯录数据库中移除并保存。示例代码如下：

ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            CFArrayRef allPeople = ABAddressBookCopyArrayOfAllPeople(addressBook);
            CFIndex numberOfPeople = CFArrayGetCount(allPeople);
            for (CFIndex i = 0; i < numberOfPeople; i++) {
                ABRecordRef person = CFArrayGetValueAtIndex(allPeople, i);
                CFStringRef lastName = ABRecordCopyValue(person, kABPersonLastNameProperty);
                if (lastName && CFStringCompare(lastName, CFSTR("DeleteLastName"), 0) == kCFCompareEqualTo) {
                    // 找到要删除的联系人
                    CFErrorRef error = NULL;
                    if (!ABAddressBookRemoveRecord(addressBook, person, &error)) {
                        NSLog(@"Failed to remove person: %@", (__bridge NSError *)error);
                    }
                    // 保存通讯录更改
                    if (!ABAddressBookSave(addressBook, &error)) {
                        NSLog(@"Failed to save address book: %@", (__bridge NSError *)error);
                    }
                    break;
                }
                CFRelease(lastName);
            }
            CFRelease(allPeople);
        }
        CFRelease(addressBook);
    });
}

上述代码通过比较姓氏找到要删除的联系人，然后使用ABAddressBookRemoveRecord从通讯录数据库中移除该联系人，并通过ABAddressBookSave保存更改。操作完成后释放相关的Core Foundation对象。

八、高级功能：使用谓词过滤联系人

在实际应用中，有时我们可能只需要获取满足特定条件的联系人，这时可以使用谓词（Predicate）来过滤联系人。可以使用ABAddressBookCopyPeopleWithName函数结合谓词来实现。示例代码如下：

ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
__block BOOL accessGranted = NO;
if (addressBook) {
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        accessGranted = granted;
        if (granted) {
            CFStringRef nameToSearch = CFSTR("John");
            CFArrayRef filteredPeople = ABAddressBookCopyPeopleWithName(addressBook, nameToSearch);
            CFIndex numberOfFilteredPeople = CFArrayGetCount(filteredPeople);
            for (CFIndex i = 0; i < numberOfFilteredPeople; i++) {
                ABRecordRef person = CFArrayGetValueAtIndex(filteredPeople, i);
                // 处理过滤后的联系人
            }
            CFRelease(filteredPeople);
        }
        CFRelease(addressBook);
    });
}

在上述代码中，通过ABAddressBookCopyPeopleWithName获取名字为“John”的联系人数组，然后可以对过滤后的联系人进行进一步处理。

九、内存管理注意事项

由于AddressBook框架基于Core Foundation，在使用过程中必须严格遵循Core Foundation的内存管理规则。

  1. 创建与释放：使用以“Create”或“Copy”开头的函数创建的对象（如ABAddressBookCreate、ABRecordCopyValue等），需要使用CFRelease进行释放，以避免内存泄漏。
  2. 对象所有权转移：在将Core Foundation对象桥接到Objective - C对象时（例如使用__bridge、__bridge_transfer、__bridge_retained等关键字），要清楚对象所有权的转移情况，确保内存管理的正确性。例如，__bridge_transfer会将Core Foundation对象的所有权转移给Objective - C对象，此时不需要再对Core Foundation对象调用CFRelease。

十、跨版本兼容性

随着iOS版本的不断更新，AddressBook框架也有一些变化。例如，在较新的iOS版本中，推荐使用基于块的异步操作方式（如ABAddressBookCreateWithOptions和ABAddressBookRequestAccessWithCompletion），而在早期版本中可能使用的是同步操作方式。在开发应用时，要注意检查目标iOS版本，以确保代码的兼容性。可以使用NSFoundationVersionNumber宏来检查当前运行的iOS版本，并根据版本选择合适的API进行调用。示例代码如下：

if (NSFoundationVersionNumber > NSFoundationVersionNumber_iOS_6_1) {
    // 使用iOS 7及更高版本的API
    ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, NULL);
    ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
        // 处理授权结果
    });
} else {
    // 使用iOS 6及更低版本的API
    ABAddressBookRef addressBook = ABAddressBookCreate();
    // 进行同步授权请求
}

通过这种方式，可以根据不同的iOS版本使用相应的AddressBook框架API，提高应用的兼容性。

通过以上对AddressBook框架在Objective - C中的使用介绍，相信开发者可以在自己的应用中灵活地实现通讯录相关功能，为用户提供更好的体验。无论是读取联系人信息、添加新联系人，还是进行复杂的过滤操作，都可以通过合理运用AddressBook框架的接口来完成。同时，要始终注意内存管理和跨版本兼容性问题，以确保应用的稳定性和可靠性。