Яка найкраща практика називати файли Swift, які додають розширення до існуючих об'єктів?

Можна додати розширення до існуючих типів об'єктів Swift, використовуючи розширення, як описано в специфікації мови .

Як результат, можна створити розширення, такі як:

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

Однак яка найкраща практика іменування вихідних файлів Swift, що містять такі розширення?

У минулому конвенція мала використовуватись extendedtype+categoryname.mдля типу "Об'єктив-С", про який говорилося в посібнику "Об'єктив-С" . Але приклад Swift не має назви категорії, і називати його String.swiftне здається доцільним.

Отже, питання: з огляду на вищезазначене Stringрозширення, як слід називати швидкий вихідний файл?

Більшість прикладів, які я бачив, імітують підхід Objective-C. Приклад розширення вище:

String+UTF8Data.swift

Переваги полягають у тому, що конвенція про іменування полегшує розуміння того, що це розширення і який клас поширюється.

Проблема з використанням Extensions.swift або навіть StringExtensions.swiftтим, що неможливо зробити призначення файлу за його ім'ям, не дивлячись на його вміст.

Використання xxxable.swiftпідходу, який використовується Java, працює добре для протоколів або розширень, які визначають лише методи. Але знову ж таки, приклад вище визначає атрибут, щоб UTF8Dataable.swiftвін не мав особливого граматичного сенсу.

Не існує конвенції Свіфта. Не ускладнювати:

StringExtensions.swift

Я створюю один файл для кожного класу, який я розширюю. Якщо ви використовуєте один файл для всіх розширень, він швидко перетвориться в джунглі.

Я вважаю за краще, StringExtensions.swiftпоки я не додав занадто багато речей, щоб розділити файл на щось подібне String+utf8Data.swiftі String+Encrypt.swift.

І ще одне - об'єднання подібних файлів в один зробить вашу будівлю швидшою. Див. Розділ Optimizing-Swift-Build-Times

Якщо у вас є узгоджений командою набір загальних та різноманітних удосконалень, їх згуртовування, як Extensions.swift, працює як рішення першого рівня Keep-It-Simple. Однак у міру того, як ваша складність зростає або розширення стають все більш задіяними, необхідна ієрархія для інкапсулювання складності. За таких обставин я рекомендую наступну практику з прикладом.

У мене був клас, який розмовляв із моїм бек-ендом Server. Він почав зростати, щоб охопити два різних цільових додатки. Дехто любить великий файл, але просто логічно розділений на розширення. Я вважаю за краще тримати кожен файл порівняно коротко, тому я вибрав наступне рішення. Serverспочатку відповідав CloudAdapterProtocolі впроваджував усі його методи. Що я зробив, це перетворити протокол на ієрархію, змусивши його посилатися на підпорядковані протоколи:

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

У Server.swiftмене є

import Foundation
import UIKit
import Alamofire
import AlamofireImage

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

Server.swiftтоді просто реалізується API сервера для настройки сервера та отримання версії API. Справжня робота розділена на два файли:

Server_ReggyCloudProtocol.swift
Server_ProReggyCloudProtocol.swift

Вони реалізують відповідні протоколи.

Це означає, що вам потрібно мати декларації про імпорт в інших файлах (для Alamofire в цьому прикладі), але це чисте рішення з точки зору розділення інтерфейсів, на мій погляд.

Я думаю, що цей підхід однаково добре працює як із зовнішньо визначеними класами, так і з вашим власним.

Чому це навіть дискусія? Чи повинен я помістити всі свої підкласи у файл під назвою _Subclasses.swift. Я думаю, що не. У Swift є інтервал назви модулів. Для розширення відомого класу Swift потрібен файл, специфічний за його призначенням. Я міг би створити велику команду, яка створює файл, який є UIViewExtensions.swift, який не виражає мети і заплутає розробників, і його можна легко дублювати в проекті, який не будується. Конвенція про іменування Objective-C працює чудово, і поки Swift не має реального інтервалу імен, це найкращий шлях.

Замість того, щоб додавати свої коментарі повсюдно, я тут їх викриваю в одній відповіді.

Особисто я приймаю гібридний підхід, який дає як хорошу зручність використання, так і чіткість, а також не захаращуючи площу поверхні API для об'єкта, який я розширюю.

Наприклад, все, що має сенс бути доступним для будь-якого рядка, буде входити в StringExtensions.swiftтакі, як trimRight()іremoveBlankLines() .

Однак, якби у мене була така функція розширення, як formatAsAccountNumber()вона не входила б у цей файл, оскільки "Номер рахунку" - це не те, що природно стосується будь-яких / всіх рядків і має сенс лише в контексті облікових записів. У такому випадку я створив би файл, який називається Strings+AccountFormatting.swiftабо, можливо, навіть Strings+CustomFormatting.swiftз aformatAsAccountNumber() функцією , якщо існує кілька типів / способи фактично форматувати його.

Власне, в цьому останньому прикладі я активно відмовляю свою команду від використання таких розширень в першу чергу, і натомість заохочую щось на зразок, AccountNumberFormatter.format(String)оскільки це зовсім не торкається Stringповерхні поверхні API, як це не повинно. Виняток буде, якби ви визначили це розширення в тому самому файлі, де воно використовується, але тоді б у нього не було власного імені файлу.

Я вважаю за +краще підкреслити той факт, що він містить розширення:

String+Extensions.swift

І якщо файл стає занадто великим, ви можете розділити його на кожну мету:

String+UTF8Data.swift

String+Encrypt.swift