点击下载 Demo
一、Core Spotlight 简介
iOS9 推出了 Core Spotlight 框架，这个框架可以为 iOS 的搜索 App 内部的数据，能够使我们在 iPhone 上下拉出现得搜索框中，搜索我们使用的 App 里面的内容。它创建的索引存储在设备上，不与Apple共享，也不能被其他应用或者设备访问。
Apple的指南中特别提到Core Spotlight创建的索引最好在几千的数量级别之下。索引太多很有可能会带来性能问题。
应用内搜索示例
二、添加索引
1、引用 spotlight 头文件
在需要的地方引用以下头文件：
#import <CoreSpotlight/CoreSpotlight.h>
2、创建 CSSearchableItemAttributeSet 对象
应用内搜索，想搜索到多少个界面就要创建多少个set ，每个set都要对应一个 CSSearchableItem 对象。
CSSearchableItemAttributeSet *set =
[[CSSearchableItemAttributeSet alloc] initWithItemContentType:@"ContentType"];
然后就可以根据需求设置不同的搜索样式图，效果如上图所示。下面列取几种常用设置
基本展示：
set.title = @"基本展示";
set.contentDescription = @"我是基本展示详情，包含标题和详情描述。这里没设置图片，默认展示 App icon";
// 搜索关键词务必要设置，不然会搜索不到
set.contactKeywords = @[@"我是", @"基本", @"展示"];
图片与星评：
set.title = @"图片与星评";
set.contentDescription = @"我是图片与星评展示，设置的图片展示的效果系统并不会给你处理，设置什么样的图片就会展示什么样的图片。还可以设置星评";
set.contactKeywords = @[@"我是", @"图片", @"星评"];
set.rating = @(3.5);
set.thumbnailData = UIImagePNGRepresentation([UIImage imageNamed:@"share_qq"]);
导航设置：
set.title = @"导航设置";
set.contentDescription = @"我是导航设置，点击导航会跳转到地图，然后系统自动导航";
set.latitude = @(31.239);
set.longitude = @(121.499);
set.supportsNavigation = @(YES);
set.contactKeywords = @[@"我是", @"导航", @"设置"];
拨打电话：
set.title = @"拨打电话";
set.contentDescription = @"我是拨打电话样式，只在真机上有效，模拟器无效";
set.phoneNumbers = @[@"10086"];
set.supportsPhoneCall = @(YES);
set.contactKeywords = @[@"我是", @"拨打", @"电话"];
3、创建 CSSearchableItem 对象
CSSearchableItem *item =
[[CSSearchableItem alloc] initWithUniqueIdentifier:@"uniqueIdentifier"
domainIdentifier:@"domainIdentifier"
attributeSet:attributeSet];
uniqueIdentifier 每个搜索都有一个唯一标示，当用户点击搜索到得某个内容的时候，系统会调用代理方法，会将这个唯一标示传给你，以便让你确定是点击了哪一，方便做页面跳转。
domainIdentifier 搜索域标识，删除条目的时候调用的delegate会传过来这个值。
attributeSet 就是刚才我们创建的 CSSearchableItemAttributeSet 对象。
4、添加 CSSearchableIndex 中
接下来是调用 Core Spotlight 相应的 API 来对数据进行索引操作，将前两步创建完成的 CSSearchableItem 对象，加入 CSSearchableIndex 中，该方法可以对索引进行添加或更新。
// 把上面的设置item都添加进入
NSArray *items = @[item1, item2, item3, item4];
CSSearchableIndex *searchIndex = [CSSearchableIndex defaultSearchableIndex];
[searchIndex indexSearchableItems:items
completionHandler:^(NSError * _Nullable error) {
if (!error) { // 回调方法在子线程
NSLog(@"添加成功");
} else {
NSLog(@"添加失败%@",error);
}
}];
三、点击索引
在 AppDelegate.m 文件中, 我们需要实现一个代理方法，用来响应搜索结果。 这个代理方法将会在 Spotlight 搜索结果点击后被调用，在这里，我们可以处理被点击的索引。
-(BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler
{
NSString *idetifier = userActivity.userInfo[CSSearchableItemActivityIdentifier];
NSLog(@"idetifier : %@",idetifier);
NSString *activityType = userActivity.activityType;
NSLog(@"activityType : %@",activityType);
UINavigationController *nav = (UINavigationController *)self.window.rootViewController;
UIViewController *vc = [UIViewController new];
vc.view.backgroundColor = [UIColor whiteColor];
// 根据 activityType、idetifier 识别索引
if ([idetifier isEqualToString:@"baseId"]) {
vc.title = @"基本展示";
} else if ([idetifier isEqualToString:@"iconId"]){
vc.title = @"图片与星评";
} else if ([idetifier isEqualToString:@"navigationId"]) {
vc.title = @"导航设置";
} else if ([idetifier isEqualToString:@"phoneId"]) {
vc.title = @"拨打电话";
}
if (vc.title) {
[nav pushViewController:vc animated:YES];
}
return YES;
}
四、删除索引
CSSearchableIndex类提供了三个方法来删除索引，分别删除应用所创建的所有索引，按domain ID删除索引，按ID删除索引。
- deleteAllSearchableItemsWithCompletionHandler:
- deleteSearchableItemsWithDomainIdentifiers:completionHandler:
- deleteSearchableItemsWithIdentifiers:completionHandler:
根据 UniqueIdentifier 删除索引示例：
- (IBAction)deleteSearchItem {
// 根据 UniqueIdentifier 删除索引
NSArray *identifiers = @[@"navigationId", @"phoneId"];
CSSearchableIndex *searchIndex = [CSSearchableIndex defaultSearchableIndex];
[searchIndex deleteSearchableItemsWithIdentifiers:identifiers
completionHandler:^(NSError * _Nullable error) {
if (!error) {
NSLog(@"删除成功");
} else {
NSLog(@"删除失败%@",error);
}
}];
}
五、注意事项
1、搜索结果的位置和顺序是系统自动排布的，大致是点击频率越高就越靠前
2、同一个应用，搜索结果列表默认展示3个，然后展开后最多展示13个
3、批量添加过多（测试：1000条索引，每个索引10个关键词），会阻塞线程，导致卡顿
4、可以不设置 thumbnailData ，这样默认就是当前应用的 LOGO；另外注意 thumbnailURL 并不是用来指定网络图片地址的，所以你要加缩略图的话需要先把网上的下载到本地再设置。设置 thumbnailURL 时，如果显示不出图片，可以拼接前缀 file:// 然后重试
网友评论