蘋果提供了系統自帶的通訊錄,但出於業務需求,我們往往需要自定義通訊錄。這就需要結合業務需求來動手實現。
動手之前,先了解蘋果提供的 Foundation、UIKit 等框架及其特性。打開手機看看系統原生通訊錄,可以觀察到這些組成部分:搜索框、右側索引條、聯繫人分組、添加聯繫人、獲取聯繫人頭像及聯繫方式。
根據需求,可以把自定義通訊錄這一大功能拆解成若干小功能,再逐一實現,把複雜問題化為若干小問題來解決:
1. 自定義搜索框
2. 獲取首字母
3. 權限判斷
4. 排序
5. 自定義搜索
6. 自定義聯繫人界面(考慮多值情況,獲取通訊錄頭像)
簡單介紹下排序:iOS 項目中常需要把聯繫人按姓名排序,但 NSArray 並不直接支持漢字排序,因此需要把漢字轉換成拼音来完成 A~Z 的排序。原理是:Objective-C 中字符串以 Unicode 編碼,漢字編碼範圍為 4E00 到 9FA5(即從第 19968 開始的 20902 個字符是中文簡體字符)。我們把這些字符的拼音首字母按順序存到一個 char 數組中,查某個漢字的拼音首字母時,只需把它的 Unicode 碼減去 19968,再用這個數字作為索引去數組中查找即可。
下面給出項目源碼,註釋清楚。
RYAddressBook.h
#import <Foundation/Foundation.h> #import "RYPersonInfo.h" typedef void (^AddressBookBlock) (NSArray *personInfos); @interface RYAddressBook : NSObject /** 將數字轉化為字母 0~26,1~25=a~z,26=# */ NSString* SpellFromIndex(int index); /** 獲取索引 */ int Index(NSString *firstSpell); /** 獲取用戶所有通訊錄信息 */ + (void)getPersonInfo:(AddressBookBlock)addressBookBlock; /** 根據關鍵字匹配所有用戶信息 */ + (void)searchPersonInfo:(NSString *)keyWord addressBookBlock:(AddressBookBlock)addressBookBlock; /** 根據姓名進行數組的重排序 */ + (NSArray *)sortPersonInfos:(NSArray *)personInfos; @end
RYAddressBook.m
#import "RYAddressBook.h"
@interface RYAddressBook ()
@property (nonatomic, copy) AddressBookBlock addressBookBlock;
@end
@implementation RYAddressBook
NSString* SpellFromIndex(int index) {
if (index == 26) return @"#";
else return [NSString stringWithFormat:@"%c", [@"A" characterAtIndex:0] + index];
}
int Index(NSString *firstSpell) {
int i = [firstSpell characterAtIndex:0] - [@"a" characterAtIndex:0];
if ([firstSpell isEqualToString:@"#"] || i < 0 || i > 26) {
return 26;
}
return [firstSpell characterAtIndex:0] - [@"a" characterAtIndex:0];
}
/** 獲取用戶所有通訊錄信息 */
+ (void)getPersonInfo:(AddressBookBlock)addressBookBlock {
[[self alloc] getPersonInfo:addressBookBlock];
}
/** 根據關鍵字匹配所有用戶信息 */
+ (void)searchPersonInfo:(NSString *)keyWord addressBookBlock:(AddressBookBlock)addressBookBlock {
[[self alloc] searchPersonInfo:keyWord addressBookBlock:addressBookBlock];
}
/** 根據姓名進行數組的重排序 */
+ (NSArray *)sortPersonInfos:(NSArray *)personInfos {
return [[self alloc] sortPersonInfos:personInfos];
}
- (void)getPersonInfo:(AddressBookBlock)addressBookBlock {
self.addressBookBlock = addressBookBlock;
[self searchPersonInfo:@""];
}
- (void)searchPersonInfo:(NSString *)keyWord addressBookBlock:(AddressBookBlock)addressBookBlock {
self.addressBookBlock = addressBookBlock;
[self searchPersonInfo:keyWord];
}
- (NSArray *)sortPersonInfos:(NSArray *)personInfos {
if (![personInfos isKindOfClass:[NSArray class]]) {
return nil;
}
NSMutableArray *arr = [NSMutableArray array];
for (int i = 0; i < 27; i++) {
[arr addObject:[NSMutableArray array]];
}
for (NSObject *obj in personInfos) {
if (![obj isKindOfClass:[RYPersonInfo class]]) {
continue;
}
RYPersonInfo *personInfo = (RYPersonInfo *)obj;
NSMutableArray *subArr = [arr objectAtIndex:Index(personInfo.firstSpell)];
[subArr addObject:personInfo];
}
return arr;
}
/** 根據關鍵字查詢通訊錄信息 */
- (void)searchPersonInfo:(NSString *)keyWord {
CFErrorRef error = NULL;
ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, &error);
ABAddressBookRequestAccessWithCompletion(addressBook, ^(bool granted, CFErrorRef error) {
if (granted) {
[self filterContentForSearchText:keyWord];
}
});
}
/** 開始匹配通訊錄信息 */
- (void)filterContentForSearchText:(NSString*)searchText {
// 如果沒有授權則退出
if (ABAddressBookGetAuthorizationStatus() != kABAuthorizationStatusAuthorized) {
return;
}
NSArray *blockArray = [NSArray array];
CFErrorRef error = NULL;
ABAddressBookRef addressBook = ABAddressBookCreateWithOptions(NULL, &error);
if ([searchText length] == 0) {
// 查詢所有
blockArray = (__bridge NSArray *)ABAddressBookCopyArrayOfAllPeople(addressBook);
} else {
// 條件查詢
CFStringRef cfSearchText = (CFStringRef)CFBridgingRetain(searchText);
blockArray = CFBridgingRelease(ABAddressBookCopyPeopleWithName(addressBook, cfSearchText));
CFRelease(cfSearchText);
}
// 類型轉換
blockArray = transformElements(blockArray);
// 返回
self.addressBookBlock(blockArray);
}
/** 將所有元素轉化為 RYPersonInfo 類型數組 */
NSArray* transformElements(NSArray* arr) {
NSMutableArray *rtnArray = [NSMutableArray array];
for (int i = 0; i < arr.count; i++) {
ABRecordRef recordRef = CFBridgingRetain([arr objectAtIndex:i]);
RYPersonInfo *personInfo = [RYPersonInfo personInfoWithABRecordRef:recordRef];
[rtnArray addObject:personInfo];
}
return rtnArray;
}
@end
RYPersonInfo.h
#import <Foundation/Foundation.h> @interface RYPersonInfo : NSObject /** 單值信息 */ #define PROPERTY_STR_READONLY(name) @property (nonatomic, copy) NSString *name; PROPERTY_STR_READONLY(firstName) // 姓 PROPERTY_STR_READONLY(lastName) // 名 PROPERTY_STR_READONLY(middlename) // 中間名 PROPERTY_STR_READONLY(fullName) // 全名 PROPERTY_STR_READONLY(firstSpell) // 搜索索引 PROPERTY_STR_READONLY(prefix) // 前綴 PROPERTY_STR_READONLY(suffix) // 後綴 PROPERTY_STR_READONLY(nickname) // 昵稱 PROPERTY_STR_READONLY(firstnamePhonetic)// 姓_音標 PROPERTY_STR_READONLY(lastnamePhonetic) // 名_音標 PROPERTY_STR_READONLY(middlenamePhonetic)// 中間名_音標 PROPERTY_STR_READONLY(organization) // 公司 PROPERTY_STR_READONLY(jobtitle) // 工作 PROPERTY_STR_READONLY(department) // 部門 PROPERTY_STR_READONLY(birthday) // 生日 PROPERTY_STR_READONLY(note) // 備忘錄 PROPERTY_STR_READONLY(firstknow) // 第一次創建用戶信息的時間 PROPERTY_STR_READONLY(lastknow) // 最後一次更改用戶信息的時間 PROPERTY_STR_READONLY(kind) // 名片類型(company/person) /** 多值信息 */ #define PROPERTY_ARR_READONLY(name) @property (nonatomic, strong) NSArray *name; PROPERTY_ARR_READONLY(email) // 郵箱 PROPERTY_ARR_READONLY(address) // 地址 PROPERTY_ARR_READONLY(dates) // 日期 PROPERTY_ARR_READONLY(iMessage) // iMessage PROPERTY_ARR_READONLY(phone) // 電話號碼 PROPERTY_ARR_READONLY(url) // URL 鏈接 /** 初始化方法 */ - (id)initWithABRecordRef:(ABRecordRef)ref; + (id)personInfoWithABRecordRef:(ABRecordRef)ref; @end
RYPersonInfo.m
#import "RYPersonInfo.h"
#define nullStrToEmpty(str) \
[str rangeOfString:@"null"].location == 0 ? @"" : str
/** 單值信息 */
#define GET_PROPERTY_METHOD(property, property_key) \
- (NSString *)property { \
return (NSString *)CFBridgingRelease(ABRecordCopyValue(_recordRef, property_key)); \
}
/** 多值信息 */
#define DICT_ADD_STR_FOR_KEY(dict, str, key) \
if (str) { \
[dict setObject:str forKey:key]; \
}
#define GET_PROPERTY_SIGLE_VALUE_METHOD(property, property_key) \
- (NSArray *)property { \
NSMutableArray *rtnArray = [NSMutableArray array]; \
ABMultiValueRef ref = ABRecordCopyValue(_recordRef, property_key); \
long count = ABMultiValueGetCount(ref); \
for (int i = 0; i < count; i++) { \
NSString* label = (__bridge NSString*)ABAddressBookCopyLocalizedLabel(ABMultiValueCopyLabelAtIndex(ref, i)); \
NSString* content = (__bridge NSString*)ABMultiValueCopyValueAtIndex(ref, i); \
NSMutableDictionary *dict = [NSMutableDictionary dictionary]; \
DICT_ADD_STR_FOR_KEY(dict, content, label); \
[rtnArray addObject:dict]; \
} \
return rtnArray; \
}
@interface RYPersonInfo ()
@property (nonatomic, assign) ABRecordRef recordRef;
@end
@implementation RYPersonInfo
- (id)initWithABRecordRef:(ABRecordRef)ref {
if (self = [super init]) {
_recordRef = ref;
}
return self;
}
+ (id)personInfoWithABRecordRef:(ABRecordRef)ref {
return [[[self class] alloc] initWithABRecordRef:ref];
}
GET_PROPERTY_METHOD(firstName, kABPersonFirstNameProperty);
GET_PROPERTY_METHOD(lastName, kABPersonLastNameProperty);
GET_PROPERTY_METHOD(middlename, kABPersonMiddleNameProperty);
GET_PROPERTY_METHOD(prefix, kABPersonPrefixProperty);
GET_PROPERTY_METHOD(suffix, kABPersonSuffixProperty);
GET_PROPERTY_METHOD(nickname, kABPersonNicknameProperty);
GET_PROPERTY_METHOD(organization, kABPersonOrganizationProperty);
GET_PROPERTY_METHOD(jobtitle, kABPersonJobTitleProperty);
GET_PROPERTY_METHOD(department, kABPersonDepartmentProperty);
GET_PROPERTY_METHOD(birthday, kABPersonBirthdayProperty);
GET_PROPERTY_METHOD(note, kABPersonNoteProperty);
GET_PROPERTY_METHOD(firstknow, kABPersonCreationDateProperty);
GET_PROPERTY_METHOD(lastknow, kABPersonModificationDateProperty);
GET_PROPERTY_METHOD(firstnamePhonetic, kABPersonFirstNamePhoneticProperty);
GET_PROPERTY_METHOD(lastnamePhonetic, kABPersonLastNamePhoneticProperty);
GET_PROPERTY_METHOD(middlenamePhonetic, kABPersonMiddleNamePhoneticProperty);
GET_PROPERTY_SIGLE_VALUE_METHOD(email, kABPersonEmailProperty)
GET_PROPERTY_SIGLE_VALUE_METHOD(dates, kABPersonDateProperty)
GET_PROPERTY_SIGLE_VALUE_METHOD(url, kABPersonURLProperty)
GET_PROPERTY_SIGLE_VALUE_METHOD(phone, kABPersonPhoneProperty)
- (NSString *)kind {
NSString *rtnStr = nil;
CFNumberRef recordType = ABRecordCopyValue(_recordRef, kABPersonKindProperty);
if (recordType == kABPersonKindOrganization) {
rtnStr = @"company";
} else {
rtnStr = @"person";
}
return rtnStr;
}
- (NSArray *)iMessage {
NSMutableArray *rtnArray = [NSMutableArray array];
ABMultiValueRef instantMessage = ABRecordCopyValue(_recordRef, kABPersonInstantMessageProperty);
for (int i = 1; i < ABMultiValueGetCount(instantMessage); i++) {
NSString* label = (__bridge NSString*)ABMultiValueCopyLabelAtIndex(instantMessage, i);
NSDictionary* content = (__bridge NSDictionary*)ABMultiValueCopyValueAtIndex(instantMessage, i);
NSMutableDictionary *imessageInfoDict = [NSMutableDictionary dictionary];
NSString* username = [content valueForKey:(NSString *)kABPersonInstantMessageUsernameKey];
NSString* service = [content valueForKey:(NSString *)kABPersonInstantMessageServiceKey];
DICT_ADD_STR_FOR_KEY(imessageInfoDict, username, @"username");
DICT_ADD_STR_FOR_KEY(imessageInfoDict, service, @"service");
NSDictionary *imessageDict = @{label: imessageInfoDict};
[rtnArray addObject:imessageDict];
}
return rtnArray;
}
-(NSArray *)address {
NSMutableArray *rtnArray = [NSMutableArray array];
ABMultiValueRef address = ABRecordCopyValue(_recordRef, kABPersonAddressProperty);
long count = ABMultiValueGetCount(address);
for (int i = 0; i < count; i++) {
NSString* addressLabel = (__bridge NSString*)ABMultiValueCopyLabelAtIndex(address, i);
NSDictionary* personaddress = (__bridge NSDictionary*)ABMultiValueCopyValueAtIndex(address, i);
NSMutableDictionary *addressInfoDict = [NSMutableDictionary dictionary];
NSString* country = [personaddress valueForKey:(NSString *)kABPersonAddressCountryKey];
NSString* city = [personaddress valueForKey:(NSString *)kABPersonAddressCityKey];
NSString* state = [personaddress valueForKey:(NSString *)kABPersonAddressStateKey];
NSString* street = [personaddress valueForKey:(NSString *)kABPersonAddressStreetKey];
NSString* zip = [personaddress valueForKey:(NSString *)kABPersonAddressZIPKey];
NSString* coutntrycode = [personaddress valueForKey:(NSString *)kABPersonAddressCountryCodeKey];
DICT_ADD_STR_FOR_KEY(addressInfoDict, country, @"country");
DICT_ADD_STR_FOR_KEY(addressInfoDict, city, @"city");
DICT_ADD_STR_FOR_KEY(addressInfoDict, state, @"state");
DICT_ADD_STR_FOR_KEY(addressInfoDict, street, @"street");
DICT_ADD_STR_FOR_KEY(addressInfoDict, zip, @"zip");
DICT_ADD_STR_FOR_KEY(addressInfoDict, coutntrycode, @"coutntrycode");
NSDictionary *addressDict = @{addressLabel: addressInfoDict};
[rtnArray addObject:addressDict];
}
return rtnArray;
}
#pragma mark CustomProperty
/** 全名 */
- (NSString *)fullName {
return [NSString stringWithFormat:@"%@%@%@", nullStrToEmpty(self.lastName), nullStrToEmpty(self.middlename), nullStrToEmpty(self.firstName)];
}
/** 首字母 */
- (NSString *)firstSpell {
return getFirstSpell(self.fullName);
}
/** 輸出模型所有信息 */
- (NSString *)description {
return [NSString stringWithFormat:@"%@ -- InfoPacket", self.fullName];
}
/** 獲取首字母 */
NSString* getFirstSpell(NSString *fullName) {
NSMutableString *ms = [[NSMutableString alloc] initWithString:fullName];
CFStringTransform((__bridge CFMutableStringRef)ms, 0, kCFStringTransformMandarinLatin, NO);
CFStringTransform((__bridge CFMutableStringRef)ms, 0, kCFStringTransformStripDiacritics, NO);
if (fullName.length > 0) return [[ms substringWithRange:NSMakeRange(0, 1)] lowercaseString];
else return @"#";
}
@end