การสร้างโค้ดด้วย build_runner

โค้ดบางส่วนเป็นโค้ดประกอบที่ซ้ำซาก เช่น การแยกวิเคราะห์ JSON การสร้างโค้ดจะเขียนโค้ดเหล่านั้นให้คุณจากคำอธิบายกำกับ ช่วยให้คุณทำงานได้ถูกต้องและรวดเร็ว ⚙️

build_runner คือเครื่องมือของ Dart ที่ใช้เรียกตัวสร้างโค้ดในโครงการของคุณ โดยอ่านไฟล์ต้นฉบับ ค้นหาคำอธิบายกำกับ และสร้างไฟล์ใหม่

เพิ่ม build_runner ไว้ใต้ dev_dependencies ใน pubspec.yaml เนื่องจากแพ็กเกจนี้ทำงานขณะสร้างแอปและจะไม่ถูกส่งไปพร้อมแอปของคุณ

ตัวสร้างจะเขียนโค้ดลงในไฟล์ที่อยู่ข้างเคียง คุณเชื่อมไฟล์นี้ด้วยคำสั่ง part ซึ่งตามธรรมเนียมแล้วชื่อลงท้ายด้วย .g.dart

สั่งสร้างโค้ดครั้งเดียวด้วยคำสั่ง build คำสั่งนี้จะสแกนโค้ดของคุณและสร้างหรือปรับปรุงไฟล์ .g.dart ทุกไฟล์

ระหว่างการพัฒนา โหมด watch จะสร้างโค้ดใหม่โดยอัตโนมัติทุกครั้งที่คุณบันทึกไฟล์ จึงทำให้ไฟล์ที่สร้างขึ้นสอดคล้องกับโค้ดอยู่เสมอโดยไม่ต้องเรียกใช้คำสั่งซ้ำด้วยตนเอง

หากผลลัพธ์ขัดแย้งกับไฟล์เก่า ให้เพิ่ม --delete-conflicting-outputs ตัวเลือกนี้จะลบไฟล์ที่สร้างขึ้นซึ่งล้าสมัย เพื่อให้การสร้างใหม่เสร็จสมบูรณ์

ตัวสร้างจะทำงานเฉพาะกับการประกาศที่คุณใส่ คำอธิบายประกอบ ไว้เท่านั้น คำอธิบายประกอบจะบอกตัวสร้างว่าต้องประมวลผลคลาสใดและต้องสร้างโค้ดอะไร

ถือว่าไฟล์ .g.dart ทุกไฟล์เป็นแบบ อ่านอย่างเดียว การสร้างครั้งถัดไปจะเขียนทับการแก้ไขของคุณ ดังนั้นให้แก้ไขไฟล์ต้นฉบับและคำอธิบายประกอบแทน

ทีมอาจเลือกคอมมิตไฟล์ที่สร้างขึ้น หรือเพิ่มไฟล์เหล่านั้นลงใน .gitignore แล้วสร้างใหม่ใน CI ไม่ว่าจะเลือกวิธีใด ให้กำหนดนโยบายอย่างใดอย่างหนึ่งและปฏิบัติให้สอดคล้องกัน

แพ็กเกจจำนวนมากเชื่อมต่อกับ build_runner เช่น json_serializable และ freezed แพ็กเกจเหล่านี้ใช้กระบวนการ builder ร่วมกัน ดังนั้นคำสั่งเดียวจึงเรียกใช้ทั้งหมดได้

คำสั่งใดสร้างโค้ดใหม่ทุกครั้งที่บันทึกไฟล์

build_runner เปลี่ยนคำอธิบายประกอบให้เป็นไฟล์ .g.dart ที่สร้างขึ้น เพิ่มไว้ใน dev_dependencies เรียกใช้ build หรือ watch และอย่าแก้ไขผลลัพธ์โดยตรง 🎉