Mevcut nesnelere uzantı ekleyen Swift dosyalarını adlandırmak için en iyi yöntem nedir?

Dil belirtiminde açıklandığı gibi, uzantıları kullanarak mevcut Swift nesne türlerine uzantılar eklemek mümkündür .

Sonuç olarak, aşağıdakiler gibi uzantılar oluşturmak mümkündür:

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

Ancak, bu tür uzantıları içeren Swift kaynak dosyaları için en iyi adlandırma uygulaması nedir?

Geçmişte, kural Objective-C kılavuzundaextendedtype+categoryname.m tartışıldığı gibi Objective-C tipi için kullanmaktı . Ancak Swift örneğinin kategori adı yok ve onu çağırmak uygun görünmüyor.String.swift

Yani soru şudur: yukarıdaki Stringuzantı göz önüne alındığında , hızlı kaynak dosyaya ne denir?

Gördüğüm örneklerin çoğu Objective-C yaklaşımını taklit ediyor. Yukarıdaki örnek uzantı şu şekildedir:

String+UTF8Data.swift

Avantajları, adlandırma kuralının bir uzantı olduğunu ve hangi Sınıfın genişletildiğini anlamayı kolaylaştırmasıdır.

Kullanmayla ilgili Extensions.swiftveya hatta sorun StringExtensions.swift, içeriğine bakmadan dosyanın amacını adıyla çıkarmanın mümkün olmamasıdır.

xxxable.swiftJava tarafından kullanılan yaklaşımı kullanmak , yalnızca yöntemleri tanımlayan protokoller veya uzantılar için uygundur. Fakat yine, yukarıdaki örnek, UTF8Dataable.swiftçok fazla gramer anlamsız bir özellik tanımlar .

Swift sözleşmesi yoktur. Basit tutun:

StringExtensions.swift

Genişlettiğim her sınıf için bir dosya oluşturuyorum. Tüm uzantılar için tek bir dosya kullanırsanız, hızlı bir şekilde orman olur.

Tercihim StringExtensions.swiftben gibi bir şey dosyayı bölmek için çok fazla şeyler katma kadar String+utf8Data.swiftve String+Encrypt.swift.

Bir şey daha, benzer dosyaları bir araya getirmek binanızı daha hızlı hale getirecektir. Bakınız Optimize-Swift-Yap-Times

Takım tarafından kabul edilen bir dizi ortak ve çeşitli geliştirmeler varsa, bunları bir Uzantılar olarak bir araya getirmek. Swift, Keep-It-Simple birinci düzey çözüm olarak çalışır. Bununla birlikte, karmaşıklığınız büyüdükçe veya uzantılar daha karmaşık hale geldiğinde, karmaşıklığı kapsüllemek için bir hiyerarşi gerekir. Bu gibi durumlarda aşağıdaki uygulamayı bir örnekle öneririm.

Arka uçla konuşan bir sınıfım vardı, denir Server. İki farklı hedef uygulamayı kapsayacak şekilde büyümeye başladı. Bazı insanlar büyük bir dosyayı sever, ancak mantıksal olarak uzantılarla bölünür. Benim tercihim her dosyayı nispeten kısa tutmak, bu yüzden aşağıdaki çözümü seçtim. Serverbaşlangıçta CloudAdapterProtocoltüm yöntemlerine uygun ve uygulanmıştır. Yaptığım protokolü, bağımlı protokollere gönderme yaparak bir hiyerarşiye dönüştürmekti:

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

In Server.swiftBen

import Foundation
import UIKit
import Alamofire
import AlamofireImage

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

Server.swiftsonra sunucuyu ayarlamak ve API sürümünü almak için temel sunucu API'sini uygular. Gerçek çalışma iki dosyaya bölünmüştür:

Server_ReggyCloudProtocol.swift
Server_ProReggyCloudProtocol.swift

Bunlar ilgili protokolleri uygular.

Bu, diğer dosyalarda (bu örnekte Alamofire için) ithalat bildirimlerine sahip olmanız gerektiği anlamına geliyor, ancak bence arayüzleri ayırmak açısından temiz bir çözüm.

Bence bu yaklaşım dışsal olarak belirlenmiş sınıfların yanı sıra kendi sınıflarınızla da eşit derecede iyi çalışır.

Bu neden bir tartışma konusu? Tüm alt sınıflarımı _Subclasses.swift adlı bir dosyaya koymalı mıyım? Bence değil. Swift, modül tabanlı ad aralığına sahiptir. İyi bilinen bir Swift sınıfını genişletmek için amacına özgü bir dosyaya ihtiyaç vardır. UIViewExtensions.swift olan, hiçbir amacı ifade etmeyen ve geliştiricileri şaşırtacak ve inşa edilmeyecek projede kolayca çoğaltılabilecek bir dosya oluşturan büyük bir ekibim olabilir. Objective-C adlandırma kuralı iyi çalışır ve Swift gerçek ad aralığına sahip olana kadar gitmek için en iyi yoldur.

Yerine yorumlarımı eklemek yerine, hepsini burada tek bir cevapta ortaya koyuyorum.

Şahsen, hem iyi kullanılabilirlik hem de netlik sağlayan melez bir yaklaşım benimsiyorum, aynı zamanda genişlettiğim nesne için API yüzey alanını karıştırmıyor.

Örneğin, bu şey markaları anlamda kullanılabilir olması için herhangi içinde gider dize StringExtensions.swiftgibi trimRight()ve removeBlankLines().

Ben gibi bir uzatma fonksiyonu olsaydı Ancak, formatAsAccountNumber()bu olur değil 'Hesap Numarası' doğal olarak herhangi için de geçerli olacak bir şey değildir çünkü dosyada go / tüm dizeleri ve sadece hesaplar bağlamında mantıklı. Bu durumda, aslında biçimlendirmek için çeşitli türler / yollar varsa, Strings+AccountFormatting.swifthatta Strings+CustomFormatting.swiftbir formatAsAccountNumber()işlevle adlandırılan bir dosya oluşturabilirim .

Aslında, bu son örnekte, ekibimi ilk etapta böyle uzantıları kullanmaktan caydırıyorum ve bunun yerine API yüzey alanına AccountNumberFormatter.format(String)hiç dokunmaması gerektiği gibi bir şeyi teşvik ediyorum String. İstisna, aynı uzantıyı kullanıldığı yerde tanımlamış olsaydınız, ancak yine de kendi dosya adına sahip olmazdı.

+Uzantıları içeren gerçeğin altını çizmek için bir sahip olmayı tercih ederim :

String+Extensions.swift

Dosya çok büyük olursa, her amaç için bölebilirsiniz:

String+UTF8Data.swift

String+Encrypt.swift