ナビゲーションバーのサーチバーの表示と表示後の不具合について

Question

ナビゲーションバーの中に検索ボタンをおいて、それがタップされたらサーチバーを表示し、サーチバーの使用を終了した際に、サーチバーを削除し、元のUIに戻すという処理を書いています。そこで問題点が二つあります。
問題点１　サーチバーの表示時に一瞬ナビゲーションバー全体が下に下がってそのあとすぐに上に戻るアニメーションとなっているため、ナビゲーションバー全体が上下に動くのをやめたい
問題点２　サーチバーの削除時にナビゲーションバーの高さが高くなっている
↓参考動画

• サーチバーを削除する際に実行しているnavigationController?.view.setNeedsLayout(),navigationController?.view.layoutIfNeeded()はこの記事でサーチバーの削除時に必要と書かれているのを見て参考にしたのですが、この処理をなくすと削除後のレイアウトは正常になります。この処理は必要ないということでしょうか？

import UIKit

class ViewController: UIViewController {
    
    override func viewDidLoad() {
        super.viewDidLoad()
        navigationItem.rightBarButtonItem = startSearchButton
    }
    
    override func viewWillAppear(_ animated: Bool) {
    }


    private lazy var searchController: UISearchController = {
        let searchController = UISearchController()
        searchController.delegate = self
        searchController.obscuresBackgroundDuringPresentation = true
        searchController.hidesNavigationBarDuringPresentation = true
        searchController.searchBar.placeholder = "検索を開始してください"
        searchController.searchBar.tintColor = .black
        searchController.searchBar.sizeToFit()
        return searchController
    }()

    private lazy var startSearchButton: UIBarButtonItem = {
         UIBarButtonItem(title: "検索", style: .plain, target: self, action: #selector(startSearchButtonAction(_:)))
    }()

    @objc private func startSearchButtonAction(_ seander: Any) {
        startSearch()
    }

    private func startSearch() {
        navigationItem.searchController = searchController
        DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(10)) { [weak self] in
            guard let self = self else { return }
            if !self.searchController.isActive {
                self.searchController.isActive = true
            }
            self.searchController.searchBar.becomeFirstResponder()
        }
    }
    
    private func endSearch() {
        if searchController.isActive {
            searchController.isActive = false
        }
        if navigationItem.searchController != nil {
            startSearchButton.isEnabled = false
            navigationItem.searchController = nil
            navigationController?.view.setNeedsLayout()
            navigationController?.view.layoutIfNeeded()
            DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(300)) {[weak self] in
                guard let self = self else { return }
                self.startSearchButton.isEnabled = true
            }
        }
    }


}

extension ViewController:UISearchControllerDelegate{
    func didDismissSearchController(_ searchController: UISearchController) {
        endSearch()
    }
}

Answer 1

Search Controller の公式サンプルを見てみましたが、setNeedsLayout() や layoutIfNeeded() は不要だと思われます。

• Displaying Searchable Content by Using a Search Controller

そもそも、参考にされているサイトは Stackoverflow の公式ページ

• NavigationItem does not return to its original size after removing the UISearchController

を無断で翻訳しているサイトだと思われますが、上記のオリジナルな質問を見る限り、 UIView.animate　を使ってアニメーションさせているため、オートレイアウトに関する2つのメソッドを呼び出しているのかと推測しています。

Comments

[oeiqgfodgfhps]

ご回答ありがとうございます！
表示時のアニメーションの挙動についてはこれはデフォルトのものなのでしょうか？

[TsukubaDepot]

おそらく、デフォルトだと思います（それを示す証拠はありませんが）。

[oeiqgfodgfhps]

ありがとうございます！
重ね重ねの質問で大変恐縮なのですが、``setNeedsLayout() ``や ``layoutIfNeeded()``を行うと画面のレイアウトの不具合が生じるのはサーチバーの消去時に一瞬だけ下に伸びた場所に合わせてレイアウトが行われるからという認識で合っていますか？

[TsukubaDepot]

それを示せるような方法がないか、回答する前に試行錯誤していたのですが、確実に「これが要因」というところまでは分かりませんでした。
ただ、システムとして用意されているアニメーションなので、レイアウトについては想定される範囲で正常に実行されるよう配慮はされているのではないかと推測しています（これも、ドキュメントに明確に書かれていれば良いのですが、そのような記述も見つかりませんでした）。
もしかしたら、SearchBard 関連のクラスを基底クラスとして拡張したカスタムクラスを作った上、レイアウトに関するメソッドをオーバーライドしてデバッグメッセージを出すようにすれば詳しい挙動まで調べられると今おもったのですが、そこまでする必要はないかもしれません。

[oeiqgfodgfhps]

なかなか書いていないですよねえ????‍♂️