แนวปฏิบัติที่เหมาะสมที่สุดสำหรับการตั้งชื่อไฟล์ Swift ที่เพิ่มส่วนขยายไปยังวัตถุที่มีอยู่คืออะไร

มันเป็นไปได้ที่จะเพิ่มส่วนขยายที่มีอยู่วัตถุประเภทสวิฟท์ใช้ส่วนขยายตามที่อธิบายไว้ในสเปคภาษา

ด้วยเหตุนี้จึงเป็นไปได้ที่จะสร้างส่วนขยายเช่น:

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

อย่างไรก็ตามวิธีการตั้งชื่อที่ดีที่สุดสำหรับไฟล์ต้นฉบับของ Swift ที่มีนามสกุลดังกล่าวคืออะไร

ในอดีตที่ผ่านมาการประชุมคือการใช้extendedtype+categoryname.mสำหรับชนิด Objective-C ที่กล่าวไว้ในวัตถุประสงค์-C คู่มือ แต่ตัวอย่างของ Swift ไม่มีชื่อหมวดหมู่และการเรียกมันString.swiftดูไม่เหมาะสม

ดังนั้นคำถามคือ: จากการStringขยายข้างต้นไฟล์ swift ควรจะเรียกว่าอะไร?

ตัวอย่างส่วนใหญ่ที่ฉันได้เห็นเลียนแบบวิธีการ Objective-C ตัวอย่างส่วนขยายด้านบนจะเป็น:

String+UTF8Data.swift

ข้อดีคืออนุสัญญาการตั้งชื่อทำให้ง่ายต่อการเข้าใจว่าเป็นส่วนขยายและคลาสใดที่กำลังถูกขยาย

ปัญหาเกี่ยวกับการใช้งานExtensions.swiftหรือแม้กระทั่งStringExtensions.swiftว่าเป็นไปไม่ได้ที่จะอนุมานจุดประสงค์ของไฟล์ตามชื่อไฟล์โดยไม่ดูที่เนื้อหา

การใช้xxxable.swiftวิธีการที่ใช้โดย Java ทำงานได้ดีสำหรับโปรโตคอลหรือส่วนขยายที่กำหนดวิธีการเท่านั้น แต่อีกครั้งตัวอย่างข้างต้นจะกำหนดแอตทริบิวต์เพื่อที่UTF8Dataable.swiftจะไม่ใช้ไวยากรณ์มากนัก

ไม่มีการประชุม Swift ง่าย ๆ เข้าไว้:

StringExtensions.swift

ฉันสร้างหนึ่งไฟล์สำหรับแต่ละชั้นที่ฉันขยาย หากคุณใช้ไฟล์เดียวสำหรับทุกนามสกุลมันจะกลายเป็นป่าอย่างรวดเร็ว

ฉันชอบStringExtensions.swiftจนกว่าฉันจะเพิ่มสิ่งที่มากเกินไปที่จะแยกไฟล์ลงในสิ่งที่ต้องการและString+utf8Data.swiftString+Encrypt.swift

การรวมไฟล์ที่คล้ายกันเข้าเป็นหนึ่งเดียวจะทำให้สิ่งปลูกสร้างของคุณเร็วขึ้น อ้างถึงOptimizing-Swift-Build-Times

หากคุณมีชุดการปรับปรุงทั่วไปและเบ็ดเตล็ดที่ทีมตกลงร่วมกันให้รวมเข้าด้วยกันเป็น Extensions.swift ทำงานเป็นโซลูชันระดับแรก Keep-It-Simple อย่างไรก็ตามเมื่อความซับซ้อนของคุณเพิ่มขึ้นหรือส่วนขยายมีส่วนเกี่ยวข้องมากขึ้นจำเป็นต้องมีลำดับชั้นเพื่อห่อหุ้มความซับซ้อน ในกรณีเช่นนี้ฉันขอแนะนำตัวอย่างต่อไปนี้

ฉันมีระดับที่พูดกับฉัน back-end 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 ซึ่งไม่ได้มีจุดประสงค์และจะสร้างความสับสนให้กับผู้พัฒนาและสามารถทำซ้ำได้ง่ายในโครงการที่ไม่ได้สร้าง แบบแผนการตั้งชื่อวัตถุประสงค์ -C ทำงานได้ดีและจนกว่า Swift จะมีการเว้นวรรคชื่อจริงมันเป็นวิธีที่ดีที่สุดที่จะไป

แทนที่จะเพิ่มความคิดเห็นของฉันไปทั่วสถานที่ฉันกำลังแสดงความคิดเห็นทั้งหมดที่นี่ในคำตอบเดียว

โดยส่วนตัวแล้วฉันใช้วิธีไฮบริดที่ให้ทั้งการใช้งานและความชัดเจนที่ดีในขณะที่ยังไม่เกะกะพื้นที่ผิวของ API สำหรับวัตถุที่ฉันกำลังขยาย

ตัวอย่างเช่นสิ่งใดก็ตามที่สมเหตุสมผลที่มีอยู่ในสตริงใด ๆก็จะStringExtensions.swiftเป็นเช่นนั้นtrimRight()และremoveBlankLines()และ

อย่างไรก็ตามถ้าฉันมีฟังก์ชั่นส่วนขยายเช่นformatAsAccountNumber()มันจะไม่ไปในไฟล์นั้นเพราะ 'เลขที่บัญชี' ไม่ใช่สิ่งที่จะใช้กับสตริงใด ๆ / ทั้งหมดตามธรรมชาติและมีเหตุผลในบริบทของบัญชีเท่านั้น ในกรณีนี้ฉันจะสร้างไฟล์ที่เรียกว่าStrings+AccountFormatting.swiftหรือแม้กระทั่งStrings+CustomFormatting.swiftกับformatAsAccountNumber()ฟังก์ชั่นหากมีหลายประเภท / วิธีในการจัดรูปแบบจริง

ในความเป็นจริงในตัวอย่างสุดท้ายนั้นฉันออกคำสั่งทีมอย่างแข็งขันไม่ให้ใช้ส่วนขยายแบบนั้นในตอนแรกและจะกระตุ้นให้มีบางสิ่งเช่นAccountNumberFormatter.format(String)แทนที่จะเป็นสิ่งที่ไม่ได้สัมผัสกับStringพื้นผิว API เลยเนื่องจากไม่ควร ข้อยกเว้นจะเกิดขึ้นหากคุณกำหนดส่วนขยายนั้นในไฟล์เดียวกับที่ใช้ แต่จะไม่มีชื่อไฟล์เป็นของตัวเอง

ฉันต้องการที่+จะขีดเส้นใต้ข้อเท็จจริงที่มีส่วนขยาย:

String+Extensions.swift

และถ้าไฟล์มีขนาดใหญ่เกินไปคุณสามารถแยกมันสำหรับแต่ละวัตถุประสงค์:

String+UTF8Data.swift

String+Encrypt.swift