iOS实现封装一个获取通讯录的工具类详解

前言

本文给大家介绍了关于iOS如何封装一个获取通讯录工具类的相关内容，iOS获取通讯录一共有4个framework: AddressBook, AddressBookUI, Contacts, ContactsUI; 其中 AddressBook 和 AddressBookUI 已经被iOS9时 deprecated 了, 而推出了Contacts 和 ContactsUI 取代之. 其中 AddressBookUI 和 ContactsUI 是picker出一个界面提供选择一条联系人信息并且是不需要手动授权, AddressBook 和 Contacts 是获取全部通讯录数据并且需要手动授权.下面来一起看看详细的介绍吧。

注意：在iOS10获取通讯录权限需主动在info.plist里添加上提示信息. 不然会崩溃. 在info.plist里添加一对key和value

• key: Privacy - Contacts Usage Description
• value: 自由发挥, 这里随便写一句: 是否允许此App访问你的通讯录?

ContactsModel

新建两个数据模型文件来保存获取的通讯录数据

ContactsModel.h

#import <Foundation/Foundation.h>

@interface ContactsModel : NSObject
@property (nonatomic, copy) NSString *num;
@property (nonatomic, copy) NSString *name;

- (instancetype)initWithName:(NSString *)name num:(NSString *)num;
@end

ContactsModel.m

#import "ContactsModel.h"

@implementation ContactsModel

- (instancetype)initWithName:(NSString *)name num:(NSString *)num {
 if (self = [super init]) {
  self.name = name;
  self.num = num;
 }
 return self;
}

@end

ContactsHelp

这是获取通讯录的工具类.

ContactsHelp.h

#import <UIKit/UIKit.h>
#import "ContactsModel.h"

typedef void(^ContactBlock)(ContactsModel *contactsModel);

@interface ContactsHelp : NSObject

+ (NSMutableArray *)getAllPhoneInfo;

- (void)getOnePhoneInfoWithUI:(UIViewController *)target callBack:(ContactBlock)block;

@end

ContactsHelp.m

#import "ContactsHelp.h"
#import <AddressBook/AddressBook.h>
#import <AddressBookUI/AddressBookUI.h>
#import <Contacts/Contacts.h>
#import <ContactsUI/ContactsUI.h>

#define iOS9 ([[[UIDevice currentDevice] systemVersion] floatValue] >= 9.0)

@interface ContactsHelp () <CNContactPickerDelegate, ABPeoplePickerNavigationControllerDelegate>
@property(nonatomic, strong) ContactsModel *contactModel;
@property(nonatomic, strong) ContactBlock myBlock;
@end

@implementation ContactsHelp

+ (NSMutableArray *)getAllPhoneInfo {
 return iOS9 ? [self getContactsFromContacts] : [self getContactsFromAddressBook];
}

- (void)getOnePhoneInfoWithUI:(UIViewController *)target callBack:(void (^)(ContactsModel *))block {
 if (iOS9) {
  [self getContactsFromContactUI:target];
 } else {
  [self getContactsFromAddressBookUI:target];
 }
 self.myBlock = block;
}

#pragma mark - AddressBookUI
- (void)getContactsFromAddressBookUI:(UIViewController *)target {
 ABPeoplePickerNavigationController *pickerVC = [[ABPeoplePickerNavigationController alloc] init];
 pickerVC.peoplePickerDelegate = self;
 [target presentViewController:pickerVC animated:YES completion:nil];
}

- (void)peoplePickerNavigationController:(ABPeoplePickerNavigationController *)peoplePicker didSelectPerson:(ABRecordRef)person {
 ABMultiValueRef phonesRef = ABRecordCopyValue(person, kABPersonPhoneProperty);
 if (!phonesRef) { return; }
 NSString *phoneValue = (__bridge_transfer NSString *)ABMultiValueCopyValueAtIndex(phonesRef, 0);

 CFStringRef lastNameRef = ABRecordCopyValue(person, kABPersonLastNameProperty);
 CFStringRef firstNameRef = ABRecordCopyValue(person, kABPersonFirstNameProperty);
 NSString *lastname = (__bridge_transfer NSString *)(lastNameRef);
 NSString *firstname = (__bridge_transfer NSString *)(firstNameRef);
 NSString *name = [NSString stringWithFormat:@"%@%@", lastname == NULL ? @"" : lastname, firstname == NULL ? @"" : firstname];
 NSLog(@"姓名: %@", name);

 ContactsModel *model = [[ContactsModel alloc] initWithName:name num:phoneValue];
 NSLog(@"电话号码: %@", phoneValue);

 CFRelease(phonesRef);
 if (self.myBlock) self.myBlock(model);
}

#pragma mark - ContactsUI
- (void)getContactsFromContactUI:(UIViewController *)target {
 CNContactPickerViewController *pickerVC = [[CNContactPickerViewController alloc] init];
 pickerVC.delegate = self;
 [target presentViewController:pickerVC animated:YES completion:nil];
}

- (void)contactPicker:(CNContactPickerViewController *)picker didSelectContact:(CNContact *)contact {
 NSString *name = [NSString stringWithFormat:@"%@%@", contact.familyName == NULL ? @"" : contact.familyName, contact.givenName == NULL ? @"" : contact.givenName];
 NSLog(@"姓名: %@", name);

 CNPhoneNumber *phoneNumber = [contact.phoneNumbers[0] value];
 ContactsModel *model = [[ContactsModel alloc] initWithName:name num:[NSString stringWithFormat:@"%@", phoneNumber.stringValue]];
 NSLog(@"电话号码: %@", phoneNumber.stringValue);

 if (self.myBlock) self.myBlock(model);
}

#pragma mark - AddressBook
+ (NSMutableArray *)getContactsFromAddressBook {
 ABAuthorizationStatus status = ABAddressBookGetAuthorizationStatus();
 CFErrorRef myError = NULL;
 ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, &myError);
 if (myError) {
  [self showErrorAlert];
  if (addressBook) CFRelease(addressBook);
  return nil;
 }

 __block NSMutableArray *contactModels = [NSMutableArray array];
 if (status == kABAuthorizationStatusNotDetermined) { // 用户还没有决定是否授权你的程序进行访问
  ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
   if (granted) {
    contactModels = [self getAddressBookInfo:addressBook];
   } else {
    [self showErrorAlert];
    if (addressBook) CFRelease(addressBook);
   }
  });
  // 用户已拒绝 或 iOS设备上的家长控制或其它一些许可配置阻止程序与通讯录数据库进行交互
 } else if (status == kABAuthorizationStatusDenied || status == kABAuthorizationStatusRestricted) {
  [self showErrorAlert];
  if (addressBook) CFRelease(addressBook);
 } else if (status == kABAuthorizationStatusAuthorized) { // 用户已授权
  contactModels = [self getAddressBookInfo:addressBook];
 }
 return contactModels;
}

+ (NSMutableArray *)getAddressBookInfo:(ABAddressBookRef)addressBook {
 CFArrayRef peopleArray = ABAddressBookCopyArrayOfAllPeople(addressBook);
 NSInteger peopleCount = CFArrayGetCount(peopleArray);
 NSMutableArray *contactModels = [NSMutableArray array];

 for (int i = 0; i < peopleCount; i++) {
  ABRecordRef person = CFArrayGetValueAtIndex(peopleArray, i);
  ABMultiValueRef phones = ABRecordCopyValue(person, kABPersonPhoneProperty);
  if (phones) {
   NSString *lastName = (__bridge_transfer NSString *)ABRecordCopyValue(person, kABPersonLastNameProperty);
   NSString *firstName = (__bridge_transfer NSString *)ABRecordCopyValue(person, kABPersonFirstNameProperty);
   NSString *name = [NSString stringWithFormat:@"%@%@", lastName == NULL ? @"" : lastName, firstName == NULL ? @"" : firstName];
   NSLog(@"姓名: %@", name);

   CFIndex phoneCount = ABMultiValueGetCount(phones);
   for (int j = 0; j < phoneCount; j++) {
    NSString *phoneValue = (__bridge_transfer NSString *)ABMultiValueCopyValueAtIndex(phones, j);
    NSLog(@"电话号码: %@", phoneValue);
    ContactsModel *model = [[ContactsModel alloc] initWithName:name num:phoneValue];
    [contactModels addObject:model];
   }
  }
  CFRelease(phones);
 }

 if (addressBook) CFRelease(addressBook);
 if (peopleArray) CFRelease(peopleArray);

 return contactModels;
}

#pragma mark - Contacts
+ (NSMutableArray *)getContactsFromContacts {
 CNAuthorizationStatus status = [CNContactStore authorizationStatusForEntityType:CNEntityTypeContacts];
 CNContactStore *store = [[CNContactStore alloc] init];
 __block NSMutableArray *contactModels = [NSMutableArray array];

 if (status == CNAuthorizationStatusNotDetermined) { // 用户还没有决定是否授权你的程序进行访问
  [store requestAccessForEntityType:CNEntityTypeContacts completionHandler:^(BOOL granted, NSError * _Nullable error) {
   if (granted) {
    contactModels = [self getContactsInfo:store];
   } else {
    [self showErrorAlert];
   }
  }];
  // 用户已拒绝 或 iOS设备上的家长控制或其它一些许可配置阻止程序与通讯录数据库进行交互
 } else if (status == CNAuthorizationStatusDenied || status == CNAuthorizationStatusRestricted) {
  [self showErrorAlert];
 } else if (status == CNAuthorizationStatusAuthorized) { // 用户已授权
  contactModels = [self getContactsInfo:store];
 }

 return contactModels;
}

+ (NSMutableArray *)getContactsInfo:(CNContactStore *)store {
 NSArray *keys = @[CNContactGivenNameKey, CNContactFamilyNameKey, CNContactPhoneNumbersKey];
 CNContactFetchRequest *request = [[CNContactFetchRequest alloc] initWithKeysToFetch:keys];
 NSMutableArray *contactModels = [NSMutableArray array];

 [store enumerateContactsWithFetchRequest:request error:nil usingBlock:^(CNContact * _Nonnull contact, BOOL * _Nonnull stop) {
  NSString *name = [NSString stringWithFormat:@"%@%@", contact.familyName == NULL ? @"" : contact.familyName, contact.givenName == NULL ? @"" : contact.givenName];
  NSLog(@"姓名: %@", name);

  for (CNLabeledValue *labeledValue in contact.phoneNumbers) {
   CNPhoneNumber *phoneNumber = labeledValue.value;
   NSLog(@"电话号码: %@", phoneNumber.stringValue);
   ContactsModel *model = [[ContactsModel alloc] initWithName:name num:phoneNumber.stringValue];
   [contactModels addObject:model];
  }
 }];

 return contactModels;
}

#pragma mark - Error
+ (void)showErrorAlert {
 NSLog(@"授权失败, 请允许app访问您的通讯录, 在手机的”设置-隐私-通讯录“选项中设置允许");
}

@end

使用

#import "ContactsHelp.h"
#import "ContactsModel.h"

...

@property(nonatomic, strong) ContactsHelp *contactsHelp;

...

- (IBAction)btn_getOne {
 self.contactsHelp = [[ContactsHelp alloc] init];
 [self.contactsHelp getOnePhoneInfoWithUI:self callBack:^(ContactsModel *contactModel) {
  NSLog(@"-----------");
  NSLog(@"%@", contactModel.name);
  NSLog(@"%@", contactModel.num);
 }];
}

- (IBAction)btn_getAll {
 NSMutableArray *contactModels = [ContactsHelp getAllPhoneInfo];
 [contactModels enumerateObjectsUsingBlock:^(id _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
  ContactsModel *model = obj;
  NSLog(@"-----------");
  NSLog(@"%@", model.name);
  NSLog(@"%@", model.num);
 }];
}

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对我们的支持。