iOS应用外搜索之 Core Spotlight 适配

前言

前段时间为APP做了应用外搜索的适配,也就是iOS Core spotlight服务的支持,可以让用户在iPhone系统中的下拉或者左滑搜索中搜索到APP中的内容,点击搜索结果可以直接跳转到APP中的相应结果页。

现在iPhone的存储配置从7开始已经以32G作为基础配置了,也就意味着iPhone用户能安装的APP数量肯定会上升,安装APP的数量多了,难以一下子找到想要使用的APP时,那么使用搜索功能的用户也一定会随之增多,spotlight不仅支持搜索APP,适配以后更支持搜索应用内内容,用户使用更便捷。

至于为什么要做spotlight搜索适配呢,那当然不言而喻了,这使APP增加了一个用户的入口,提升了APP的曝光度。

iOS应用外搜索之 Core Spotlight 适配_第1张图片
IMG_3367.PNG

基本知识

按照苹果一贯的风格——高度封装,面向开发者,它一般都会提供比较简洁的API,这次也不例外。

想要实现在APP外的系统搜索中搜索到应用内的内容,你只需要告诉系统,你哪些内容是可被搜索的,每条内容搜索的关键字是什么,显示的标题和内容是什么,以及为内容提供唯一标示就可以了。

以上单条内容都用一个CSSearchableItem对象来存放。

关键属性 关键子属性 描述
CSSearchableItem uniqueIdentifier 该条内容的唯一标识,类似于数据库字段中的id,在用户在应用外搜索到结果以后跳转到应用时,我们可以通过它来决定后续动作(如:在IM类应用搜索到某个联系人,跳转到对应的聊天会话;在购物类应用,跳转到某商品详情页)
domainIdentifier 该条内容的域标识,相当于类型ID(比如,如果应用内不仅可以搜索联系人,还可以搜索商品,可以用此属性来区分)
attributeSet title 显示的标题
contentDescription 显示的内容
thumbnailData 显示的缩略图(比如:联系人头像、商品缩略图等)
contactKeywords 搜索的关键字(比如:联系人住址、备注等其他信息)

以上是一条需要添加到搜索内容所需要的信息,你需要把所有需要支持搜索的信息转换为CSSearchableItem对象,来交给系统。

spotlight搜索实现步骤(代码)

1. 包装CSSearchableItem对象,交给spotlight搜索系统

class SpotlightManager: NSObject {
    @available(iOS 9.0, *)
    class dynamic func configSearch(myAppContentsArray: [MRContacts]?) -> Void {
        let searchableItems = self.searchableItems(myAppContentsArray)
        CSSearchableIndex.defaultSearchableIndex().indexSearchableItems(searchableItems) { (error: NSError?) in
            if let error = error {
                print("configSearch failed -> \(error)")
            }
        }

    }

    @available(iOS 9.0, *)
    class private dynamic func searchableItems(myAppContentsArray: [MRContacts]?) -> [CSSearchableItem] {
        var searchableItems = [CSSearchableItem]()
        guard let myAppContentsArray = myAppContentsArray else { return searchableItems }
        for contact in myAppContentsArray {
            let searchableItemSet = CSSearchableItemAttributeSet.init(itemContentType: "contact")
            searchableItemSet.title = contact.name
            searchableItemSet.contentDescription = contact.address
            let searchKeys = self.searchKeys(contact)
            if searchKeys.count > 0 {
                searchableItemSet.contactKeywords = self.searchKeys(contact)
                let searchableItem = CSSearchableItem.init(uniqueIdentifier: contact.id, domainIdentifier: "com.xingshulin.contact", attributeSet: searchableItemSet)
                searchableItems.append(searchableItem)
            }
        }
        return searchableItems
    }

    @available(iOS 9.0, *)
    class private dynamic func searchKeys(contact: MRContacts) -> [String] {
        var searchKeys = [String]()
        if let name = contact.name {
            searchKeys.append(name)
        }
        if let address = contact.address {
            searchKeys.append(address)
        }
        return searchKeys
    }
}

2. 处理搜索结果回调

func application(application: UIApplication, continueUserActivity userActivity: NSUserActivity, restorationHandler: ([AnyObject]?) -> Void) -> Bool {
    if let uniqueIdentifier = userActivity.userInfo?[CSSearchableItemActivityIdentifier] as? String {
        // 跳转到相应页面
    }    
    return true       
}

3.维护(追加或删除)需要支持搜索的内容

// 删除所有
CSSearchableIndex.defaultSearchableIndex().deleteAllSearchableItemsWithCompletionHandler { (error) in
    if let _ = error {
        return
    }
}

// 根据uniqueIdentifier删除
public func deleteSearchableItemsWithIdentifiers(identifiers: [String], completionHandler: ((NSError?) -> Void)?)

// 根据domainIdentifier删除
public func deleteSearchableItemsWithDomainIdentifiers(domainIdentifiers: [String], completionHandler: ((NSError?) -> Void)?)

// 追加(同1)
public func indexSearchableItems(items: [CSSearchableItem], completionHandler: ((NSError?) -> Void)?)

你可能感兴趣的:(iOS应用外搜索之 Core Spotlight 适配)