การกำหนดเวอร์ชันและความเสถียรของ API

เมื่อทีมต่าง ๆ พึ่งพาไลบรารีของคุณ หมายเลขรุ่นจะบอกพวกเขาว่าควรคาดหวังอะไรจากการอัปเกรด ให้ถือว่ามันเป็นข้อตกลง ไม่ใช่การคาดเดา 🤝

SemVerใช้ตัวเลขสามส่วน ได้แก่ รุ่นหลัก รุ่นย่อย และแพตช์ แต่ละส่วนสื่อถึงประเภทการเปลี่ยนแปลงที่แตกต่างกันสำหรับผู้ที่พึ่งพาโค้ดของคุณ

เพิ่มหมายเลขแพตช์สำหรับการแก้ไขข้อผิดพลาดที่เข้ากันได้กับรุ่นก่อน ผู้ใช้สามารถอัปเกรดได้อย่างอิสระโดยไม่ต้องเปลี่ยนโค้ดฝั่งตนเอง

เพิ่มหมายเลขรุ่นย่อยเมื่อเพิ่มความสามารถใหม่โดยไม่ทำให้สิ่งใดเสียหาย จุดเรียกใช้เดิมยังคงทำงานเหมือนเดิม

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

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

ทำเครื่องหมายโค้ดที่ยังไม่เสถียรเป็นภายใน เพื่อไม่ให้กลายเป็นส่วนหนึ่งของข้อตกลง คุณสามารถปรับโครงสร้างใหม่ได้อย่างอิสระโดยไม่ต้องเพิ่มรุ่นหลัก

มอบทางลงที่ราบรื่นให้ผู้เรียกใช้ด้วย@Deprecated พวกเขายังสร้างโปรแกรมได้ เห็นคำเตือน และได้รับคำแนะนำว่าควรใช้สิ่งใดแทน

ใช้คำเลิกใช้คู่กับคำใบ้ReplaceWith เพื่อให้สภาพแวดล้อมพัฒนาแก้จุดเรียกใช้เก่าโดยอัตโนมัติ การย้ายโค้ดจึงทำได้ด้วยการคลิกเพียงครั้งเดียว

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

บันทึกการเปลี่ยนแปลงที่ชัดเจนจะแสดงสิ่งที่เปลี่ยนไปในแต่ละรุ่น ทั้งทีม Android และ iOS จึงวางแผนอัปเกรดได้อย่างมั่นใจแทนที่จะหวาดกลัว

ปฏิบัติตามSemVer ปกป้องส่วนเชื่อมต่อการเขียนโปรแกรมสาธารณะ ซ่อนโค้ดที่ยังไม่เสถียรไว้เป็นภายใน เลิกใช้อย่างเหมาะสม และดูแลบันทึกการเปลี่ยนแปลงที่ทั้งสองทีมไว้วางใจ 🎉