【iOS开发】UISearchController的使用

在使用app时,搜索一个列表的内容是非常常见的,例如苹果自带的联系人:

联系人.jpeg

我们可以使用UISearchController来实现这个功能。

UISearchController的属性

我们先来看看UISearchController有哪些属性:

// 初始化器:如果要在同一个控制器中显示搜索结果,searchResultsController参数传入nil (建议传入一个新的控制器,原因下面会讲到)
public init(searchResultsController: UIViewController?)

// 负责更新searchResultsController的内容
weak open var searchResultsUpdater: UISearchResultsUpdating?

// 是否激活
open var isActive: Bool

// 代理    
weak open var delegate: UISearchControllerDelegate?

// 显示的时候是否加上阴影效果,默认是true
open var dimsBackgroundDuringPresentation: Bool 

// 模糊背景效果,默认是true
open var obscuresBackgroundDuringPresentation: Bool

// 显示的时候是否隐藏导航栏,默认是true
open var hidesNavigationBarDuringPresentation: Bool

// 访问searchResultsController
open var searchResultsController: UIViewController? { get }

// 可以使用searchBar的代理来跟踪文本变化和按钮的事件
open var searchBar: UISearchBar { get }

初始化并设置相关属性

viewDidLoad初始化:

private func setupSearchController() { 
        //这个是另外创建的一个控制器,用来显示搜索结果
        searchResultController = SearchResultTableViewController(style: .plain) 
        searchController = UISearchController(searchResultsController: searchResultController)
        // 需要实现UISearchResultsUpdating这个协议,才能更新搜索结果
        searchController.searchResultsUpdater = self 
        searchController.delegate = self
        searchController.searchBar.placeholder = "搜索"
        
        tableView.tableHeaderView = searchController.searchBar
}

UISearchResultsUpdating协议

我们通过扩展来实现这个协议:

extension TableViewController: UISearchResultsUpdating {
    
    func updateSearchResults(for searchController: UISearchController) {
        searchResults = [] // 每次更新结果之前,把之前的搜索结果清零
        
        if let searchText = searchController.searchBar.text {
            for str in dataSource {
                if str.contains(searchText) {
                    searchResults.append(str)
                }
            }
        }
        
        searchResultController.dataSource = searchResults // 把搜索结果赋值给显示结果控制器的数据源
    }
}

UISearchControllerDelegate

我们通过扩展来实现这个代理,各个方法在何时调用,方法名很明显能看到,不再赘述:

extension TableViewController: UISearchControllerDelegate {
    
    func presentSearchController(_ searchController: UISearchController) {
        print("presentSearchController")
    }
    
    func willPresentSearchController(_ searchController: UISearchController) {
        print("willPresentSearchController")
    }
    
    func didPresentSearchController(_ searchController: UISearchController) {
        print("didPresentSearchController")
    }
    
    func willDismissSearchController(_ searchController: UISearchController) {
        print("willDismissSearchController")
    }
    
    func didDismissSearchController(_ searchController: UISearchController) {
        print("didDismissSearchController")
    }
}

显示结果的控制器

在数据源中使用didSet属性观察者,在被赋值后,刷新tableView

var dataSource: [String]! {
        didSet {
            tableView.reloadData()
        }
    }

另外,在numberOfRowsInSection方法中,要注意判断数据源是否为nil,因为搜索控制器被激活后,用户还没有输入搜索文字,这时数据源为nil

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        guard dataSource != nil else { return 0 }
        
        return dataSource.count
    }

为什么要在另外一个控制器显示搜索结果

如果直接使用同一个控制器显示结果,我们不能根据搜索文字的变化通过更改dimsBackgroundDuringPresentation属性来选择是否加上阴影效果。这样会影响我们点击显示搜索结果的cell。但是用另外一个控制器就没有问题。

Demo地址 >>

如果文中有错误,请指出!我们共同学习,共同进步。谢谢!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容