Was ist die beste Vorgehensweise zum Benennen von Swift-Dateien, die vorhandenen Objekten Erweiterungen hinzufügen?

Es ist möglich, Erweiterungen zu vorhandenen Swift-Objekttypen mithilfe von Erweiterungen hinzuzufügen, wie in der Sprachspezifikation beschrieben .

Infolgedessen können Erweiterungen wie die folgenden erstellt werden:

extension String {
    var utf8data:NSData {
        return self.dataUsingEncoding(NSUTF8StringEncoding, allowLossyConversion: false)!
    }
}

Was ist jedoch die beste Benennungspraxis für Swift-Quelldateien, die solche Erweiterungen enthalten?

In der Vergangenheit sollte die Konvention extendedtype+categoryname.mfür den Objective-C-Typ verwendet werden, wie im Objective-C-Handbuch erläutert . Das Swift-Beispiel hat jedoch keinen Kategorienamen, und es String.swifterscheint nicht angemessen , ihn aufzurufen .

Die Frage ist also: StringWie soll die schnelle Quelldatei angesichts der obigen Erweiterung heißen?

Die meisten Beispiele, die ich gesehen habe, ahmen den Objective-C-Ansatz nach. Die obige Beispielerweiterung wäre:

String+UTF8Data.swift

Die Vorteile sind, dass die Namenskonvention leicht verständlich macht, dass es sich um eine Erweiterung handelt und welche Klasse erweitert wird.

Das Problem bei der Verwendung Extensions.swiftoder sogar StringExtensions.swiftist, dass es nicht möglich ist, den Zweck der Datei anhand ihres Namens abzuleiten, ohne auf deren Inhalt zu achten.

Die Verwendung xxxable.swiftdes von Java verwendeten Ansatzes funktioniert in Ordnung für Protokolle oder Erweiterungen, die nur Methoden definieren. Im obigen Beispiel wird jedoch ein Attribut definiert, UTF8Dataable.swiftdas grammatikalisch wenig sinnvoll ist.

Es gibt keine Swift-Konvention. Halte es einfach:

StringExtensions.swift

Ich erstelle eine Datei für jede Klasse, die ich erweitere. Wenn Sie für alle Erweiterungen eine einzige Datei verwenden, wird diese schnell zu einem Dschungel.

Ich bevorzuge es, StringExtensions.swiftbis ich zu viele Dinge hinzugefügt habe, um die Datei in etwas wie String+utf8Data.swiftund aufzuteilen String+Encrypt.swift.

Wenn Sie ähnliche Dateien zu einer kombinieren, wird Ihr Gebäude schneller. Siehe Optimieren von Swift-Build-Zeiten

Wenn Sie über eine vom Team vereinbarte Reihe allgemeiner und verschiedener Verbesserungen verfügen, funktioniert das Zusammenfassen als Extensions.swift als Keep-It-Simple-Lösung der ersten Ebene. Wenn Ihre Komplexität jedoch zunimmt oder die Erweiterungen komplexer werden, ist eine Hierarchie erforderlich, um die Komplexität zu kapseln. Unter solchen Umständen empfehle ich die folgende Übung mit einem Beispiel.

Ich hatte eine Klasse, die mit meinem Backend spricht Server. Es wurde immer größer und deckte zwei verschiedene Ziel-Apps ab. Einige Leute mögen eine große Datei, teilen sich aber logischerweise mit Erweiterungen auf. Ich bevorzuge es, jede Datei relativ kurz zu halten, deshalb habe ich die folgende Lösung gewählt. Serverursprünglich CloudAdapterProtocolalle seine Methoden angepasst und implementiert. Was ich getan habe, war, das Protokoll in eine Hierarchie umzuwandeln, indem ich es auf untergeordnete Protokolle verweisen ließ:

protocol CloudAdapterProtocol: ReggyCloudProtocol, ProReggyCloudProtocol {
    var server: CloudServer {
        get set
    }
    func getServerApiVersion(handler: @escaping (String?, Error?) -> Swift.Void)
}

In Server.swifthabe ich

import Foundation
import UIKit
import Alamofire
import AlamofireImage

class Server: CloudAdapterProtocol {
.
.
func getServerApiVersion(handler: @escaping (String?, Error?) -> Swift.Void) {
.
.
}

Server.swiftImplementiert dann einfach die Kernserver-API, um den Server festzulegen und die API-Version abzurufen. Die eigentliche Arbeit ist in zwei Dateien aufgeteilt:

Server_ReggyCloudProtocol.swift
Server_ProReggyCloudProtocol.swift

Diese implementieren die jeweiligen Protokolle.

Es bedeutet, dass Sie Importdeklarationen in den anderen Dateien haben müssen (in diesem Beispiel für Alamofire), aber meiner Ansicht nach ist dies eine saubere Lösung hinsichtlich der Trennung von Schnittstellen.

Ich denke, dieser Ansatz funktioniert genauso gut mit extern festgelegten Klassen wie mit Ihren eigenen.

Warum ist das überhaupt eine Debatte? Soll ich alle meine Unterklassen in eine Datei namens _Subclasses.swift einfügen? Ich denke nicht. Swift hat einen modulbasierten Namensabstand. Um eine bekannte Swift-Klasse zu erweitern, ist eine Datei erforderlich, die für ihren Zweck spezifisch ist. Ich könnte ein großes Team haben, das eine Datei namens UIViewExtensions.swift erstellt, die keinen Zweck ausdrückt und Entwickler verwirrt und leicht in dem Projekt dupliziert werden kann, das nicht erstellt werden würde. Die Objective-C-Namenskonvention funktioniert einwandfrei. Bis Swift einen echten Namensabstand aufweist, ist dies der beste Weg.

Anstatt meine Kommentare überall hinzuzufügen, tauche ich sie alle hier in einer Antwort auf.

Persönlich verfolge ich einen hybriden Ansatz, der sowohl eine gute Benutzerfreundlichkeit als auch Klarheit bietet und gleichzeitig die API-Oberfläche für das Objekt, das ich erweitere, nicht überfüllt.

Zum Beispiel würde alles, was Sinn macht , für eine beliebige Zeichenfolge verfügbar zu sein , StringExtensions.swiftwie trimRight()und removeBlankLines().

Wenn ich jedoch eine Erweiterungsfunktion hätte, wie formatAsAccountNumber()sie nicht in diese Datei aufgenommen würde, da 'Kontonummer' natürlich nicht für alle Zeichenfolgen gilt und nur im Zusammenhang mit Konten sinnvoll ist. In diesem Fall würde ich eine Datei mit dem Namen Strings+AccountFormatting.swiftoder vielleicht sogar Strings+CustomFormatting.swiftmit einer formatAsAccountNumber()Funktion erstellen, wenn es mehrere Arten / Möglichkeiten gibt, sie tatsächlich zu formatieren.

Tatsächlich habe ich in diesem letzten Beispiel mein Team aktiv davon abgehalten, solche Erweiterungen zu verwenden, und würde stattdessen so etwas AccountNumberFormatter.format(String)empfehlen, da dies die StringAPI-Oberfläche überhaupt nicht berührt , wie es nicht sein sollte. Die Ausnahme wäre, wenn Sie diese Erweiterung in derselben Datei definieren würden, in der sie verwendet wird, aber dann hätte sie sowieso keinen eigenen Dateinamen.

Ich bevorzuge es +, die Tatsache zu unterstreichen, dass es Erweiterungen enthält:

String+Extensions.swift

Und wenn die Datei zu groß wird, können Sie sie für jeden Zweck aufteilen:

String+UTF8Data.swift

String+Encrypt.swift