แยกมอดูลออกเป็นไฟล์ต่างๆ
จนถึงตอนนี้ ตัวอย่างทั้งหมดในบทนี้ล้วนเป็นการนิยามหลายๆ มอดูลรวมไว้ภายในไฟล์เดียวกัน แต่เมื่อมอดูลเริ่มมีขนาดใหญ่และซับซ้อนขึ้น คุณอาจต้องการย้ายนิยามของมอดูลเหล่านั้นออกไปไว้ในไฟล์แยกต่างหาก เพื่อให้ง่ายต่อการค้นหาและไล่อ่านโค้ด
ตัวอย่างเช่น เราลองมาเริ่มต้นจากโค้ดในลิสติ้ง 7-17 ที่มีหลายมอดูลของร้านอาหารรวมกันอยู่ เราจะแยกมอดูลต่างๆ ออกเป็นไฟล์ย่อยๆ แทนที่จะนิยามมอดูลทั้งหมดไว้ในไฟล์รากของเครต (crate root) ซึ่งในกรณีนี้ ไฟล์รากของเครตคือ src/lib.rs แต่กระบวนการนี้สามารถนำไปใช้กับเครตไบนารีที่มีไฟล์รากเป็น src/main.rs ได้เช่นเดียวกันทุกประการ
อันดับแรก เราจะแยกมอดูล front_of_house ออกไปเป็นไฟล์ของตัวเอง ให้ลบโค้ดที่อยู่ภายในวงเล็บปีกกาของมอดูล front_of_house ออกทั้งหมด โดยคงเหลือไว้เพียงคำประกาศ mod front_of_house; เท่านั้น ส่งผลให้ไฟล์ src/lib.rs มีเนื้อหาดังที่แสดงในลิสติ้ง 7-21 โปรดทราบว่าโค้ดนี้จะยังคอมไพล์ไม่ผ่าน จนกว่าเราจะสร้างไฟล์ src/front_of_house.rs ตามลิสติ้ง 7-22 ขึ้นมา
mod front_of_house;
pub use crate::front_of_house::hosting;
pub fn eat_at_restaurant() {
hosting::add_to_waitlist();
}
ถัดมา ให้นำโค้ดที่เคยอยู่ในวงเล็บปีกกาไปใส่ไว้ในไฟล์ใหม่ชื่อ src/front_of_house.rs ดังที่แสดงในลิสติ้ง 7-22 คอมไพเลอร์จะรู้ได้เองโดยอัตโนมัติว่าต้องเข้ามาค้นหาโค้ดในไฟล์นี้ เพราะพบคำประกาศมอดูลที่ชื่อ front_of_house อยู่ที่รากของเครต
pub mod hosting {
pub fn add_to_waitlist() {}
}
โปรดสังเกตว่า คุณจำเป็นต้องโหลดไฟล์ด้วยคำประกาศ mod เพียง_ครั้งเดียว_เท่านั้นในต้นไม้มอดูลของคุณ และเมื่อคอมไพเลอร์รับรู้แล้วว่าไฟล์ดังกล่าวเป็นส่วนหนึ่งของโปรเจกต์ (และรู้ว่าโค้ดนั้นอยู่ตรงตำแหน่งใดในต้นไม้มอดูลจากจุดที่คุณเขียนสเตตเมนต์ mod) ไฟล์อื่นๆ ในโปรเจกต์ก็ควรจะอ้างอิงถึงโค้ดในไฟล์ที่โหลดมาแล้วนั้น ผ่านทางพาธ (path) ที่ชี้ไปยังตำแหน่งที่มันถูกประกาศเอาไว้ ดังที่เราได้เรียนรู้กันไปในหัวข้อ “พาธสำหรับอ้างถึงรายการในแผนผังมอดูล” หรือพูดอีกอย่างก็คือ คำว่า mod นั้น ไม่ใช่ คำสั่ง “include” เหมือนอย่างที่คุณอาจคุ้นเคยในภาษาโปรแกรมอื่นๆ
ถัดไป เราจะแยกมอดูล hosting ออกไปเป็นไฟล์ของตัวเองอีกทอดหนึ่ง ซึ่งขั้นตอนนี้จะแตกต่างออกไปเล็กน้อย เพราะมอดูล hosting เป็นมอดูลลูกของ front_of_house ไม่ใช่มอดูลลูกของมอดูลราก เราจึงต้องนำไฟล์ของ hosting ไปวางไว้ในไดเรกทอรีใหม่ที่ตั้งชื่อตามมอดูลบรรพบุรุษของมันในต้นไม้มอดูล ซึ่งในกรณีนี้ก็คือไดเรกทอรี src/front_of_house
ในการเริ่มต้นย้าย hosting เราจะปรับแก้ไฟล์ src/front_of_house.rs ให้เหลือเพียงแค่คำประกาศของมอดูล hosting:
pub mod hosting;
จากนั้น เราจึงสร้างไดเรกทอรี src/front_of_house ขึ้นมา แล้วสร้างไฟล์ hosting.rs ไว้ข้างใน เพื่อบรรจุนิยามต่างๆ ของมอดูล hosting:
pub fn add_to_waitlist() {}
หากเรานำไฟล์ hosting.rs ไปวางไว้ในไดเรกทอรี src โดยตรงแทน คอมไพเลอร์จะเข้าใจว่าโค้ดใน hosting.rs นั้นเป็นมอดูล hosting ที่ประกาศไว้ที่รากของเครต ไม่ใช่มอดูลลูกของ front_of_house ซึ่งกฎของคอมไพเลอร์ในการจับคู่ไฟล์กับมอดูลนี้ ทำให้โครงสร้างโฟลเดอร์และไฟล์บนดิสก์สะท้อนโครงสร้างต้นไม้มอดูลได้อย่างแม่นยำและเป็นธรรมชาติ
พาธไฟล์ทางเลือก
จนถึงตอนนี้ เราได้อธิบายรูปแบบพาธไฟล์ที่เป็นสำนวนนิยมที่สุดซึ่งคอมไพเลอร์ Rust ใช้ แต่จริงๆ แล้ว Rust ยังคงรองรับรูปแบบพาธไฟล์แบบเก่าอยู่อีกด้วย สำหรับมอดูลชื่อ
front_of_houseที่ประกาศไว้ที่รากของเครต คอมไพเลอร์จะมองหาโค้ดของมอดูลจากตำแหน่งเหล่านี้:
- src/front_of_house.rs (รูปแบบสำนวนนิยมที่เราได้อธิบายไป)
- src/front_of_house/mod.rs (รูปแบบเก่า ซึ่งยังคงรองรับอยู่)
และสำหรับมอดูลชื่อ
hostingซึ่งเป็นมอดูลย่อยของfront_of_houseคอมไพเลอร์จะมองหาโค้ดของมอดูลจากตำแหน่งเหล่านี้:
- src/front_of_house/hosting.rs (รูปแบบสำนวนนิยมที่เราได้อธิบายไป)
- src/front_of_house/hosting/mod.rs (รูปแบบเก่า ซึ่งยังคงรองรับอยู่)
หากคุณใช้ทั้งสองรูปแบบซ้ำซ้อนกันในมอดูลเดียวกัน คอมไพเลอร์จะแจ้งข้อผิดพลาดขึ้นมาทันที แม้ว่าการใช้รูปแบบผสมผสานกันในแต่ละมอดูลภายในโปรเจกต์เดียวกันจะสามารถทำได้ แต่ก็อาจสร้างความสับสนให้กับผู้ที่เข้ามาอ่านโค้ดในโปรเจกต์ของคุณ
ข้อเสียสำคัญของรูปแบบที่ใช้ไฟล์ชื่อ mod.rs คือ โปรเจกต์ของคุณอาจเต็มไปด้วยไฟล์ที่ชื่อ mod.rs ซ้ำๆ กันหลายไฟล์ ซึ่งสร้างความสับสนได้ง่ายมากเวลาที่คุณเปิดไฟล์เหล่านั้นขึ้นมาพร้อมๆ กันในโปรแกรมแก้ไขโค้ด
ในตอนนี้ เราได้ย้ายโค้ดของแต่ละมอดูลออกไปยังไฟล์แยกต่างหากเรียบร้อยแล้ว โดยที่โครงสร้างต้นไม้มอดูลยังคงเหมือนเดิมทุกประการ ทำให้การเรียกฟังก์ชันต่างๆ ใน eat_at_restaurant ยังคงทำงานได้ตามปกติโดยไม่ต้องแก้ไขโค้ดเลยแม้แต่น้อย แม้ว่านิยามของฟังก์ชันจะกระจายไปอยู่ในคนละไฟล์แล้วก็ตาม เทคนิคนี้จะช่วยให้คุณสามารถแยกมอดูลออกเป็นไฟล์ใหม่ๆ ได้อย่างคล่องตัวเมื่อขนาดของมอดูลเติบโตขึ้น
โปรดสังเกตด้วยว่า สเตตเมนต์ pub use crate::front_of_house::hosting; ใน src/lib.rs ก็ไม่ได้มีการเปลี่ยนแปลงใดๆ เช่นกัน และคำสั่ง use ก็ไม่มีผลใดๆ ต่อการที่ไฟล์จะถูกนำไปคอมไพล์เป็นส่วนหนึ่งของเครตหรือไม่ เพราะคำว่า mod ต่างหากที่เป็นตัวประกาศสร้างมอดูล และ Rust จะคอยค้นหาโค้ดสำหรับมอดูลนั้นจากไฟล์ที่มีชื่อตรงกับชื่อของมอดูลเสมอ
สรุป
Rust ช่วยให้คุณสามารถแยกแพ็กเกจ (package) ออกเป็นหลายๆ เครต (crates) และแยกเครตออกเป็นมอดูลต่างๆ ได้ เพื่อให้คุณสามารถอ้างอิงถึงไอเทมที่นิยามไว้ในมอดูลหนึ่งจากอีกมอดูลหนึ่งได้อย่างเป็นระบบ โดยทำได้ผ่านการระบุพาธแบบสัมบูรณ์หรือแบบสัมพัทธ์ และพาธเหล่านี้สามารถนำเข้ามาไว้ในสโคปได้ด้วยสเตตเมนต์ use เพื่อช่วยลดทอนความยาวของพาธเมื่อต้องเรียกใช้งานซ้ำๆ ในสโคปนั้น โค้ดทั้งหมดในมอดูลจะมีสถานะเป็นแบบส่วนตัว (private) โดยปริยาย แต่คุณก็สามารถเปิดเผยนิยามต่างๆ ให้เป็นสาธารณะ (public) ได้อย่างยืดหยุ่นด้วยการเติมคีย์เวิร์ด pub
ในบทถัดไป เราจะมาเรียนรู้เกี่ยวกับโครงสร้างข้อมูลแบบคอลเลกชัน (collection data structures) ในไลบรารีมาตรฐาน ซึ่งคุณสามารถนำมาปรับใช้ร่วมกับโค้ดที่ได้รับการจัดระเบียบอย่างประณีตของคุณได้ทันที