@ObjCName และ API ที่เป็นมิตรกับ Swift

API ที่ใช้ร่วมกันควรอ่านได้อย่างเป็นธรรมชาติใน Swift คำอธิบายประกอบและแนวปฏิบัติบางอย่างจะทำให้สะพานเชื่อมให้ความรู้สึกเป็น native แทนที่จะดูเหมือนนำมาต่อเพิ่ม

คำอธิบายประกอบ @ObjCName ช่วยให้คุณกำหนดชื่อชนิดข้อมูลหรือฟังก์ชันอีกชื่อหนึ่งบนฝั่ง Swift ได้ โดยไม่ต้องเปลี่ยนชื่อฝั่ง Kotlin

ใช้ @ObjCName กับฟังก์ชันด้วย เพื่อให้ชื่อ Kotlin ที่ยาวกลายเป็นจุดเรียกใช้ Swift ที่สั้น เป็นไปตามสำนวน และอ่านได้ดี

Kotlin อนุญาตให้สร้างโอเวอร์โหลดที่ Obj-C ไม่สามารถแสดงได้ การเปลี่ยนชื่อด้วย @ObjCName จะป้องกันชื่อที่ถูกดัดแปลงซึ่ง Swift อาจมองเห็น

กำกับตัวช่วยภายในด้วย @HiddenFromObjC เพื่อไม่ให้ปรากฏในเฟรมเวิร์ก ช่วยให้ส่วนที่ Swift มองเห็นมีขนาดเล็กและสะอาด

อาร์กิวเมนต์เริ่มต้นของ Kotlin จะไม่ข้ามสะพานเชื่อม ดังนั้น Swift จะเห็นลายเซ็นแบบเต็มเพียงแบบเดียว ให้สร้างโอเวอร์โหลดหาก Swift ต้องการตัวเลือกหลายแบบ

เปิดเผยคลาสข้อมูลและ primitive แบบธรรมดาที่ขอบเขตการเชื่อมต่อ ส่วนชนิดทั่วไปที่ซับซ้อนและลำดับชั้นแบบปิดผนึกจะใช้งานยากสำหรับผู้เรียกใช้ Swift

บูลีน Kotlin อย่าง isActive อ่านได้ดีใน Swift แต่ชื่อ getter ที่แปลกอาจดูไม่เป็นธรรมชาติ จึงควรตั้งชื่อคุณสมบัติโดยคำนึงถึง Swift

เพิ่ม KDoc ให้สมาชิกที่ส่งออก บางส่วนจะแสดงใน Xcode และช่วยให้นักพัฒนา iOS ใช้ API ที่ใช้ร่วมกันได้โดยไม่ต้องเดา

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

การตั้งชื่ออย่างรอบคอบและการซ่อนสิ่งที่ไม่จำเป็นจะเปลี่ยน Kotlin ที่ใช้ร่วมกันให้เป็น API ที่นักพัฒนา Swift ใช้งานได้อย่างเพลิดเพลิน ทำให้งานข้ามทีมราบรื่นและเป็นมิตร

จัดรูปแบบสิ่งที่ส่งออกด้วย @ObjCName และ @HiddenFromObjC เลือกใช้ชนิดข้อมูลที่เรียบง่าย และอ่านจุดเรียกใช้ Swift จริง สะพานเชื่อมที่เป็นมิตรย่อมทำงานได้ดีกว่า 🎉