API สาธารณะและโครงสร้าง
ตัดสินใจว่าจะเปิดเผยสิ่งใด
API สาธารณะและโครงสร้าง เป็นบทเรียน Mojo Academy ฟรีบน CoddyKit นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน Mojo Academy และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส Mojo Academy มีบทเรียนทั้งหมด 4 บทเรียน
สิ่งที่คุณเปิดเผยมีความสำคัญ
ไลบรารีที่ดีจะถูกประเมินจากส่วนที่เปิดให้ใช้งาน การตัดสินใจว่าจะเปิดเผยอะไรส่งผลต่อความง่ายในการใช้APIของคุณ 🚪
API สาธารณะของคุณ
ฟังก์ชันและชนิดข้อมูลที่โค้ดอื่นตั้งใจเรียกใช้ประกอบกันเป็นAPI สาธารณะของคุณ ซึ่งเป็นคำมั่นสัญญาที่คุณให้ไว้กับผู้ใช้
ซ่อนส่วนภายในไว้
โค้ดช่วยเหลือที่สนับสนุน API ของคุณแต่ไม่ได้มีไว้ให้ผู้เรียกใช้ คือโค้ดภายใน การซ่อนโค้ดนี้ช่วยให้ส่วนที่เปิดเผยมีขนาดเล็ก
ส่วนที่เปิดเผยเล็กลง ความเสี่ยงน้อยลง
ยิ่งคุณเปิดเผยชื่อน้อยเท่าไร ไลบรารีก็ยิ่งเรียนรู้ได้ง่ายขึ้น และคุณก็ยิ่งเปลี่ยนแปลงส่วนภายในได้อย่างอิสระในภายหลัง
ส่งออกซ้ำจาก __init__
__init__.mojo ของแพ็กเกจสามารถนำเข้าชื่อสำคัญ เพื่อให้ผู้ใช้เข้าถึงชื่อเหล่านั้นได้โดยตรงจากแพ็กเกจ แทนการเข้าถึงผ่านไฟล์ที่อยู่ลึกลงไป
from .core import add, subtractทางเข้าด้านหน้าที่เป็นระเบียบ
เมื่อรวบรวมการนำเข้าไว้ใน __init__ คุณจะมอบจุดเริ่มต้นที่ชัดเจนเพียงจุดเดียวให้ผู้เรียกใช้ แทนเส้นทางโมดูลที่ยาวและเปราะบาง
from mypkg import addซ่อนโครงสร้างภายใน
ผู้ใช้นำเข้าจากแพ็กเกจ ไม่ใช่จากไฟล์ภายใน ทำให้คุณจัดเรียงโมดูลด้านในใหม่ได้โดยไม่ทำให้โค้ดของผู้ใช้เสียหาย
ตั้งชื่อให้ชัดเจน
ชื่อสาธารณะควรอธิบายตัวเองได้ ชื่อที่ชัดเจนและคงที่เป็นส่วนหนึ่งของข้อตกลงที่คุณไม่ควรเปลี่ยน
จัดทำเอกสารส่วนที่เปิดเผย
เพิ่มเอกสารกำกับให้กับฟังก์ชันและชนิดข้อมูลสาธารณะแต่ละรายการ เอกสารที่ดีจะบอกผู้เรียกใช้ว่าควรใช้ API อย่างถูกต้องอย่างไร
fn add(a: Int, b: Int) -> Int:
"""Return the sum of a and b."""
return a + bคำมั่นสัญญาที่มั่นคง
ถือว่า API สาธารณะของคุณเป็นข้อตกลง การเปลี่ยนแปลงอาจทำให้ผู้ใช้ได้รับผลกระทบ ดังนั้นควรรักษาให้มีขนาดเล็กและคิดให้รอบคอบก่อนเพิ่มสิ่งใหม่
ออกแบบจากภายนอกสู่ภายใน
ลองนึกก่อนว่าผู้เรียกใช้ต้องการใช้ไลบรารีของคุณอย่างไร จากนั้นจึงสร้างส่วนภายในเพื่อรองรับประสบการณ์ที่ราบรื่นนั้น 🎨
ตรวจสอบอย่างรวดเร็ว
มาคิดกันว่าจะทำให้ API ดูแลรักษาได้ง่ายอย่างไร
สรุปทบทวน
เปิดเผยAPI สาธารณะที่มีขนาดเล็กและชัดเจน ส่งออกชื่อสำคัญซ้ำใน __init__ ซ่อนส่วนภายใน และจัดทำเอกสารสำหรับสิ่งที่คุณแชร์ 🎯
เรียนรู้ Mojo ด้วย AI tutor — ฟรี
เขียนและเรียกใช้โค้ดจริงในเบราว์เซอร์ของคุณ รับความช่วยเหลือทันทีจาก AI tutor 24/7 และเรียนรู้ต่อจากที่คุณหยุดบนเว็บหรือในแอป
- คอร์ส
- 30
- บทเรียน
- 120
คำถามที่พบบ่อย
บทเรียน “API สาธารณะและโครงสร้าง” ฟรีหรือไม่
ใช่ — ข้อความเต็มของ “API สาธารณะและโครงสร้าง” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส Mojo Academy ให้อัปเกรดเป็น CoddyKit PRO คอร์ส Mojo Academy มีบทเรียนทั้งหมด 4 บทเรียน
คุณจะเรียนรู้อะไรในบทเรียน “API สาธารณะและโครงสร้าง”
ตัดสินใจว่าจะเปิดเผยสิ่งใด คุณปฏิบัติ Mojo Academy ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน
คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน Mojo Academy หรือไม่
ไม่จำเป็นต้องมีประสบการณ์มาก่อน Mojo Academy บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน
บทเรียน “API สาธารณะและโครงสร้าง” ใช้เวลานานแค่ไหน
บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย
ฉันเขียนและรันโค้ดในบทเรียน Mojo Academy นี้ได้ไหม
ได้ บทเรียน Mojo Academy ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ
บทเรียนทั้งหมดในหลักสูตรนี้
- โมดูลและการนำเข้า
- การสร้าง .mojopkg
- API สาธารณะและโครงสร้าง
- แนวปฏิบัติที่ดีในการจัดวางโครงการ