private extensionとは？使用するメリットがわからない。

Question

##HomeController

private extension HomeViewController {
    
    func searchBy(naturalLanguageQuery: String, completion: @escaping([MKPlacemark]) -> Void) {
        
        var results = [MKPlacemark]()
        
        let request = MKLocalSearch.Request()
        request.naturalLanguageQuery = naturalLanguageQuery
        request.region = mapView.region
        
        let search = MKLocalSearch(request: request)
        search.start { (response, error) in
            
            guard let response = response else { return }
            response.mapItems.forEach({ (mapItem) in
                results.append(mapItem.placemark)
            })
            completion(results)
        }
        
    }
}

##HomeController LocationInputViewDelegate

extension HomeController: LocationInputViewDelegate {
    
    
    func executeSearch(query: String) {
        
        self.searchBy(naturalLanguageQuery: query) { (placeMarks) in
            
            self.searchResultPlaceMarks = placeMarks
            self.tableView.reloadData()
        }
    }

    func dismiss() {
        
        self.dismissLocationInputView { (_) in
            UIView.animate(withDuration: 0.3) {
                self.inputActivationView.alpha = 1
            }
        }
        
    }
}

LocationInputView

extension LocationInputView: UITextFieldDelegate {
    
    func textFieldShouldReturn(_ textField: UITextField) -> Bool {
        
        guard let query = textField.text else { return false }
        delegate?.executeSearch(query: query)
        return true
    }
}

わからないこと

private extensionが必要になる、または使い所が知りたいです！
調べてみたのですが、理解するには至らずに質問させていただきました。回答お願いします。

Answer 1

メリットという観点ではわからないのですが、それに関連しそうなところが浮かぶので、あくまでも自分の主観で真偽のほどはわからないのですけれど綴ってみます。

Swift には、公式の API デザインガイドラインという、コードを書くときに心がけたい指針が用意されています。その中で、関数ではなくメソッドで、その機能を主体とするところに所属させるようにする方針が記されています。

型を名前空間として、そこに機能を所属させる。それを実現するために extension が使われる、という側面もあると思っているのですけれど、その機能がそのファイル内からだけ利用できれば良い（アクセスコントロールの目的として、必要ない機能はそれ以上の範囲に公開しない）のであれば fileprivate func でメソッドを定義すれば良くなります。

// 識別子を生成する過程で `ObjectManager` クラスが一時的に使いたいメソッド
// 扱う主体が `Object` 型なので、そこに所属させて、関係性を明瞭にする
extension Object {

    fileprivate func idStringForKeyPart() -> String {
    }

    fileprivate func idStringForValuePart() -> String {
    }
}

class ObjectManager {

    var key: Object
    var value: Object

    // このメソッドだけ、外から利用できれば良い
    func objectIdentifier() -> String {

        return "(key.idStringForKeyPart):(value.idStringForValuePart)"
    }
}

そしてそれらが複数のまとまりで存在していたときに private extension を使って明示的にグループにまとめて主体に所属させる、みたいな使い方もできそうです。

// 識別子を生成する過程で `ObjectManager` クラスが一時的に使いたいメソッド
// 扱う主体が `Object` 型なので、そこに所属させて、関係性を明瞭にする
private extension Object {

    func idStringForKeyPart() -> String {
    }

    func idStringForValuePart() -> String {
    }
} 

class ObjectManager {

    var key: Object
    var value: Object

    // このメソッドだけ、外から利用できれば良い
    func objectIdentifier() -> String {

        return "(key.idStringForKeyPart):(value.idStringForValuePart)"
    }
}

Comments

[atk_721]

回答ありがとうございます！関数ではなくメソッドで、その機能を主体とするところに所属させるようにする方針があるということ知らなかったので勉強になりました！複数のまとまりで存在していたときに private extension を使って明示的にグループにまとめて主体に所属させる。という理解で納得できました！

Answer 2

調べてみましたがよくわかりませんでした。
自分で考えてみたのですが、HomeControllerはMapKitをimportしているので,MapKitの持つプロパティーにアクセスさせない為にPrivateにExtensionしているという結論に至りました。