จัดระเบียบแพ็กเกจภายในโมดูล

แพ็กเกจจัดกลุ่มไฟล์ Kotlin ที่เกี่ยวข้องกันไว้ภายใต้ชื่อแบบมีจุดคั่น แพ็กเกจที่ดีทำให้โมดูลที่ใช้ร่วมกันซึ่งเติบโตขึ้นนำทางได้ง่าย 📁

ทุกไฟล์เริ่มต้นด้วยบรรทัด แพ็กเกจ ควรตั้งชื่อให้สอดคล้องกับเส้นทางโฟลเดอร์ เพื่อให้โครงสร้างคาดเดาได้สำหรับทุกคน

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

การแยกที่สะอาดคือ โดเมนสำหรับแบบจำลองและกฎบริสุทธิ์ ส่วนข้อมูลใช้กับเครือข่ายและพื้นที่จัดเก็บ ขอบเขตนี้ช่วยให้แต่ละส่วนมีจุดมุ่งหมายชัดเจน

เริ่มแพ็กเกจด้วยชื่อ โดเมนย้อนกลับ เช่น com.acme.shared วิธีนี้ช่วยป้องกันไม่ให้โค้ดของคุณชนกับแพ็กเกจของไลบรารี

จัดโครงสร้าง โฟลเดอร์ให้ตรงกับชื่อแพ็กเกจ เมื่อทั้งสองอย่างสอดคล้องกัน ทุกคนก็หาไฟล์คลาสได้จากชื่อเต็มของมัน

ใส่ชนิดข้อมูลที่เปิดเผยไว้ในแพ็กเกจ สาธารณะที่เห็นได้ชัดเจน เช่น com.acme.shared.api จากนั้นผู้เรียกใช้ก็มีที่เดียวให้ค้นหา

เก็บตัวช่วยไว้ในแพ็กเกจ ภายใน เช่น .impl หรือ .util ชื่อนี้บอกได้ทันทีว่าผู้เรียกใช้ไม่ควรเข้ามายุ่ง

หลีกเลี่ยงการซ้อนโฟลเดอร์ไม่รู้จบ โครงสร้างแบบ ตื้นที่มีแพ็กเกจชัดเจนไม่กี่แพ็กเกจดูง่ายกว่าการมีโฟลเดอร์เล็ก ๆ ซ้อนกันสิบชั้น

ใช้โครงสร้างแพ็กเกจเดียวกันใน commonMain, androidMain และ iosMain เส้นทางที่ตรงกันทำให้มองเห็นคู่ expect และ actual ได้ง่าย

อ่านรายการแพ็กเกจจากบนลงล่าง ชื่อเพียงอย่างเดียวควรอธิบายได้ว่าโมดูลทำอะไรและแต่ละส่วนอยู่ที่ใด

จัดกลุ่มตาม ฟีเจอร์หรือชั้น ให้โฟลเดอร์สอดคล้องกับแพ็กเกจ รักษาโครงสร้างให้ตื้น และซ่อนส่วนภายใน โครงสร้างที่ชัดเจนจะรองรับการเติบโตของโมดูลได้ 🎉