UISearchController的用法

作者: 张宇航_Ken | 来源:发表于2017-10-03 12:30 被阅读492次

简介

UISearchController是iOS 8新增的一个类，用于实现搜索栏的默认行为，这也是官方推荐的搜索栏的实现方法。

行为

在UITableViewController上长这个样子

初始状态下搜索栏是隐藏的
往下拉时，搜索栏显示并占据导航栏的位置
点击搜索栏进入搜索状态
输入时进行实时搜索

用法1：使用当前View Controller显示搜索结果

(1) 建立工程，Storyboard如下：

(2) 在MainViewController中设置搜索栏

class MainViewController: UITableViewController {

    private let items = [
        "Jon Snow",
        "Bran",
        "Theon",
        "Tarly",
        "Tyrion",
        "Tywin",
        "Jaime",
        "Cersei",
        "Ned",
        "Robb",
    ]

    private var searchResults = [String]()

    override func viewDidLoad() {
        super.viewDidLoad()

        let searchController = UISearchController(searchResultsController: nil)
        searchController.obscuresBackgroundDuringPresentation = false
        searchController.searchBar.placeholder = "Search name..."
        searchController.searchBar.autocapitalizationType = .none
        searchController.searchResultsUpdater = self
        navigationItem.searchController = searchController
    }
}

用items和searchResults来分别保存全部数据和搜索结果。默认状态下显示全部数据，搜索状态下显示搜索结果。
创建一个UISearchController实例。参数searchResultsController为nil即表示没有单独的显示搜索结果的界面，也就是使用当前界面来显示。
obscuresBackgroundDuringPresentation表示搜索栏进入搜索状态时，要不要在当前界面上显示一层半透明的遮罩（效果可以在手机的设置界面上感受一下，或者参考上面的第3张图）。该属性的默认值为true，但是如果没有要把当前界面作为搜索结果显示界面，最好设成false。否则，点击搜索结果时就会点在遮罩上，造成搜索栏退出搜索状态，重新显示全部数据。
对searchBar进行一些外观上的设置
设置searchResultsUpdater以监听搜索事件。如果不需要实时搜索，则不需要这一步。
最后把实例放到navigationItem上。

现在运行代码，下拉可以显示搜索栏，只是还没有实现搜索功能。

(3) 根据状态显示数据

// MARK: - helpers
extension MainViewController {
    var isSearching: Bool {
        return navigationItem.searchController?.isActive ?? false
    }

    func item(at indexPath: IndexPath) -> String {
        return isSearching ? searchResults[indexPath.row] : items[indexPath.row]
    }

    var itemCount: Int {
        return isSearching ? searchResults.count : items.count
    }
}

// MARK: - UITableViewDataSource
extension MainViewController {
    override func numberOfSections(in tableView: UITableView) -> Int {
        return 1
    }

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return itemCount
    }

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        let cell = tableView.dequeueReusableCell(withIdentifier: "cell", for: indexPath)
        cell.textLabel?.text = item(at: indexPath)
        return cell
    }
}

用isActive属性来判断当前是否在搜索状态。只有当搜索栏显示并获得焦点时，isActive才为true。
根据状态切换显示内容

(4) 监听搜索事件
添加search方法，更新searchResults并刷新界面。

// MARK: - helpers
extension MainViewController {
    ...
    func search(_ text: String?) {
        if let text = text, !text.isEmpty {
            searchResults = items.flatMap { $0.range(of: text, options: .caseInsensitive) == nil ? nil : $0 }
        }
        else {
            searchResults = items
        }
        tableView.reloadData()
    }
}

实现UISearchResultsUpdating协议

// MARK: - UISearchResultsUpdating
extension MainViewController : UISearchResultsUpdating {
    func updateSearchResults(for searchController: UISearchController) {
        search(searchController.searchBar.text)
    }
}

运行代码，就可以在搜索栏进行实时搜索了。

(5) 如果不想用实时搜索，而只在输入完成并按return时搜索。就把这行：

searchController.searchResultsUpdater = self

改成

searchController.searchBar.delegate = self
searchController.delegate = self

并实现这两个协议

// MARK: - UISearchBarDelegate
extension MainViewController : UISearchBarDelegate {
    func searchBarSearchButtonClicked(_ searchBar: UISearchBar) {
        search(searchBar.text)
    }
}

// MARK: - UISearchControllerDelegate
extension MainViewController : UISearchControllerDelegate {
    func didDismissSearchController(_ searchController: UISearchController) {
        tableView.reloadData()
    }
}

实现didDismissSearchController方法是为了在点击Cancel按钮退出搜索状态时可以重新显示所有数据。其实UISearchBarDelegate也有个searchBarCancelButtonClicked方法可以监听Cancel按钮事件，但这个事件是发生在Cancel按钮被点击之时，而不是在那之后。也就是当时searchController的isActive属性还是true，此时界面刷新也仍会显示searchResults的内容。

用法2：使用其它View Controller显示搜索结果

多数时候，我们都需要定制搜索界面（参考微信的搜索界面）。
(1) 以上面的代码为基础，在Storyboard中新增一个UITableViewController，类名为SearchResultsViewController

class SearchResultsViewController: UITableViewController {

    private var results = [NSAttributedString]() {
        didSet {
            tableView.reloadData()
        }
    }

    func search(_ text: String, in items: [String]) {
        results = items.flatMap { item in
            let matchedRange = (item as NSString).range(of: text, options: .caseInsensitive)
            guard matchedRange.location != NSNotFound else {
                return nil
            }
            return highlighted(string: item, in: matchedRange)
        }
    }

    private func highlighted(string s: String, in range: NSRange) -> NSAttributedString {
        let s = NSMutableAttributedString(string: s)
        s.beginEditing()
        let highlightAttributes: [NSAttributedStringKey : Any] = [
            .foregroundColor : UIColor.blue,
            .font : UIFont.boldSystemFont(ofSize: 17),
        ]
        s.addAttributes(highlightAttributes, range: range)
        s.endEditing()
        return s
    }
}

extension SearchResultsViewController {
    override func numberOfSections(in tableView: UITableView) -> Int {
        return 1
    }

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return results.count
    }

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        let cell = tableView.dequeueReusableCell(withIdentifier: "cell", for: indexPath)
        cell.textLabel?.attributedText = results[indexPath.row]
        return cell
    }
}

search方法跟前面差不多，只是多了一步，把匹配的部分高亮显示。为此，要使用NSAttributedString数组来保存搜索结果。

接下来可以把MainViewController里搜索相关的代码都去掉，变成：

class MainViewController: UITableViewController {

    private let items = ...

    override func viewDidLoad() {
        super.viewDidLoad()

        let searchResultsController = storyboard?.instantiateViewController(withIdentifier: "searchResults")
        let searchController = UISearchController(searchResultsController: searchResultsController)
        searchController.searchBar.placeholder = "Search name..."
        searchController.searchBar.autocapitalizationType = .none
        searchController.searchBar.delegate = self
        searchController.delegate = self
        navigationItem.searchController = searchController
        definesPresentationContext = true
    }

    private var searchResultsController: SearchResultsViewController? {
        return navigationItem.searchController?.searchResultsController as? SearchResultsViewController
    }
}

// MARK: - helpers
extension MainViewController {
    func search(_ text: String?) {
        guard let text = text, !text.isEmpty else {
            return
        }
        searchResultsController?.search(text, in: items)
    }
}

删除searchResults
创建SearchResultsViewController对象，并传给UISearchController对象。后面点击搜索栏的时候就会通过present方法来显示这个界面。
下面是definesPresentationContext属性的官方说明

When a context-based presentation occurs, UIKit starts at the presenting view controller and walks up the view controller hierarchy. If it finds a view controller whose value for this property is true, it asks that view controller to present the new view controller. If no view controller defines the presentation context, UIKit asks the window’s root view controller to handle the presentation.

也就是说，把它设为true的话，presentation就会以这一层为root view来展示。如果保持默认值false，则会以window为root view，将导致SearchResultsViewController遮住整个屏幕（包括搜索栏）。

obscuresBackgroundDuringPresentation可以使用默认值true来显示半透明遮罩了。把原先的赋值语句删掉就好了。
原来的search方法改为直接调用searchResultsController上的search方法。

剩下的部分简化成：

// MARK: - UITableViewDataSource
extension MainViewController {
    override func numberOfSections(in tableView: UITableView) -> Int {
        return 1
    }

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return items.count
    }

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        let cell = tableView.dequeueReusableCell(withIdentifier: "cell", for: indexPath)
        cell.textLabel?.text = items[indexPath.row]
        return cell
    }
}

// MARK: - UISearchBarDelegate
extension MainViewController : UISearchBarDelegate {
    func searchBarSearchButtonClicked(_ searchBar: UISearchBar) {
        search(searchBar.text)
    }
}

// MARK: - UISearchControllerDelegate
extension MainViewController : UISearchControllerDelegate {
    func didDismissSearchController(_ searchController: UISearchController) {
        tableView.reloadData()
    }
}

现在运行代码，输入文字并点return，可以显示搜索结果，并把匹配部分高亮显示。看起来不错。
此时点Cancel，再点搜索栏，输入文字。这时发现searchResultsController还显示着上次的结果。这是因为每次present用的是同一个SearchResultsViewController的实例。

个人觉得API的设计还不如改成在UISearchControllerDelegate里提供一个接口，用来返回一个UIViewController实例，作为显示结果的界面。这样可以在需要显示时才去创建这个view controller。

解决这个问题，只要在present的时候把搜索结果重置一下就好了。

在SearchResultsViewController中添加一个reset，负责重置状态。

func reset() {
    results.removeAll()
}

然后在MainViewController里响应willPresentSearchController事件

extension MainViewController : UISearchControllerDelegate {
    func willPresentSearchController(_ searchController: UISearchController) {
        searchResultsController?.reset()
    }
}

运行，妥妥的。

UISearchController的用法

简介

行为

用法1：使用当前View Controller显示搜索结果

用法2：使用其它View Controller显示搜索结果

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

OC-开发案例收集