Jaka jest najlepsza metoda nazywania plików Swift, które dodają rozszerzenia do istniejących obiektów?

Możliwe jest dodawanie rozszerzeń do istniejących typów obiektów Swift za pomocą rozszerzeń, zgodnie z opisem w specyfikacji języka .

Dzięki temu możliwe jest tworzenie rozszerzeń takich jak:

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

Jaka jest jednak najlepsza praktyka nazywania plików źródłowych Swift zawierających takie rozszerzenia?

W przeszłości konwencja była używana extendedtype+categoryname.mdla typu Objective-C, jak omówiono w przewodniku Objective-C . Ale przykład Swift nie ma nazwy kategorii, a nazywanie jej String.swiftnie wydaje się odpowiednie.

Tak więc pytanie brzmi: biorąc pod uwagę powyższe Stringrozszerzenie, jak powinien się nazywać szybki plik źródłowy?

Większość przykładów, które widziałem, naśladuje podejście Objective-C. Przykładowe rozszerzenie powyżej to:

String+UTF8Data.swift

Zaletą jest to, że konwencja nazewnictwa ułatwia zrozumienie, że jest to rozszerzenie i która klasa jest rozszerzana.

Problem z używaniem, Extensions.swifta nawet StringExtensions.swiftpolega na tym, że nie można wywnioskować przeznaczenia pliku na podstawie jego nazwy bez patrzenia na jego zawartość.

Używanie xxxable.swiftpodejścia używanego przez Javę działa dobrze w przypadku protokołów lub rozszerzeń, które definiują tylko metody. Ale znowu, powyższy przykład definiuje atrybut, więc UTF8Dataable.swiftnie ma to większego sensu gramatycznego.

Nie ma konwencji Swift. Nie komplikuj:

StringExtensions.swift

Tworzę jeden plik dla każdej rozszerzanej klasy. Jeśli użyjesz jednego pliku dla wszystkich rozszerzeń, szybko stanie się on dżunglą.

Wolę, StringExtensions.swiftdopóki nie dodam zbyt wielu rzeczy, aby podzielić plik na coś takiego jak String+utf8Data.swifti String+Encrypt.swift.

Jeszcze jedno, połączenie podobnych plików w jeden przyspieszy budowanie. Zobacz Optymalizacja-Swift-Build-Times

Jeśli masz uzgodniony przez zespół zestaw wspólnych i różnych ulepszeń, wrzucenie ich razem jako Extensions.swift działa jako rozwiązanie pierwszego poziomu Keep-It-Simple. Jednak w miarę wzrostu złożoności lub większego zaangażowania rozszerzeń potrzebna jest hierarchia, aby zamknąć złożoność. W takich okolicznościach polecam następującą praktykę wraz z przykładem.

Miałem klasę, która rozmawiała z moim zapleczem, o nazwie Server. Zaczął się rozrastać, aby objąć dwie różne aplikacje docelowe. Niektórzy ludzie lubią duży plik, ale logicznie dzielą się na rozszerzenia. Wolę, aby każdy plik był stosunkowo krótki, więc wybrałem następujące rozwiązanie. Serverpierwotnie dostosował się CloudAdapterProtocoli wdrożył wszystkie jej metody. To, co zrobiłem, to przekształcić protokół w hierarchię, czyniąc z niego odniesienie do protokołów podrzędnych:

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

W Server.swiftmam

import Foundation
import UIKit
import Alamofire
import AlamofireImage

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

Server.swiftnastępnie po prostu implementuje podstawowe API serwera do ustawiania serwera i pobierania wersji API. Prawdziwa praca jest podzielona na dwa pliki:

Server_ReggyCloudProtocol.swift
Server_ProReggyCloudProtocol.swift

Implementują one odpowiednie protokoły.

Oznacza to, że musisz mieć deklaracje importu w innych plikach (dla Alamofire w tym przykładzie), ale moim zdaniem jest to czyste rozwiązanie pod względem segregowania interfejsów.

Myślę, że to podejście działa równie dobrze w przypadku klas określonych zewnętrznie, jak i własnych.

Dlaczego to w ogóle debata? Czy powinienem umieścić wszystkie moje podklasy w pliku o nazwie _Subclasses.swift. Myślę, że nie. Swift ma odstępy między nazwami oparte na modułach. Aby rozszerzyć dobrze znaną klasę Swift, potrzebny jest plik odpowiedni do jej przeznaczenia. Mógłbym mieć duży zespół, który utworzyłby plik UIViewExtensions.swift, który nie ma żadnego celu i wprowadziłby w błąd programistów i mógłby być łatwo zduplikowany w projekcie, który nie zostałby zbudowany. Konwencja nazewnictwa Objective-C działa dobrze i dopóki Swift nie ma prawdziwych odstępów między nazwami, jest to najlepsza droga.

Zamiast dodawać moje komentarze w każdym miejscu, ujawniam je wszystkie tutaj w jednej odpowiedzi.

Osobiście stosuję podejście hybrydowe, które zapewnia zarówno dobrą użyteczność, jak i przejrzystość, a jednocześnie nie zaśmieca powierzchni interfejsu API dla obiektu, który rozszerzam.

Na przykład wszystko, co ma sens, aby być dostępne dla dowolnego ciągu, powinno znaleźć się w StringExtensions.swifttakich jak trimRight()i removeBlankLines().

Jednak gdybym miał funkcję rozszerzenia takie jak formatAsAccountNumber()byłoby nie pójść w tym pliku, ponieważ „Numer rachunku” nie jest czymś, co naturalnie zastosować do każdego / wszystkie sznurki i ma sens tylko w kontekście rachunków. W takim przypadku utworzyłbym plik o nazwie Strings+AccountFormatting.swiftlub nawet Strings+CustomFormatting.swiftz formatAsAccountNumber()funkcją, jeśli istnieje kilka typów / sposobów jego sformatowania.

Właściwie w tym ostatnim przykładzie aktywnie odradzam mojemu zespołowi używanie takich rozszerzeń w pierwszej kolejności i zamiast tego zachęcam do czegoś podobnego, AccountNumberFormatter.format(String)ponieważ w ogóle nie dotyka to Stringpowierzchni interfejsu API, a nie powinno. Wyjątkiem byłoby zdefiniowanie tego rozszerzenia w tym samym pliku, w którym jest używane, ale i tak nie miałoby ono własnej nazwy pliku.

Wolę mieć znak +podkreślający fakt, że zawiera rozszerzenia:

String+Extensions.swift

A jeśli plik stanie się zbyt duży, możesz go podzielić w każdym celu:

String+UTF8Data.swift

String+Encrypt.swift