ส่วนก่อนหน้านี้อธิบายแพ็กเกจ เป้าหมาย และป้ายกำกับ รวมถึงกราฟความเกี่ยวข้องของบิลด์ในเชิงนามธรรม ส่วนนี้จะอธิบายไวยากรณ์ที่เป็นรูปธรรม ที่ใช้ในการกำหนดแพ็กเกจ
ตามคำจำกัดความแล้ว ทุกแพ็กเกจจะมีไฟล์ BUILD
ซึ่งเป็นโปรแกรมสั้นๆ ระบบจะประเมินไฟล์ BUILD
โดยใช้ภาษาบังคับ ซึ่งก็คือ Starlark
ระบบจะตีความเป็นรายการคำสั่งตามลำดับ
โดยทั่วไปแล้วลําดับมีผล เช่น คุณต้องกําหนดตัวแปรก่อนจึงจะใช้ได้ อย่างไรก็ตาม ไฟล์ BUILD
ส่วนใหญ่ประกอบด้วยการประกาศกฎการสร้างเท่านั้น และลําดับสัมพัทธ์ของคำสั่งเหล่านี้ไม่สําคัญ สิ่งที่สําคัญคือมีการประกาศกฎใดและมีค่าใดเมื่อการประเมินแพ็กเกจเสร็จสมบูรณ์
เมื่อเรียกใช้ฟังก์ชันกฎการสร้าง เช่น cc_library
ระบบจะสร้างเป้าหมายใหม่ในกราฟ สามารถอ้างอิงเป้าหมายนี้ในภายหลังโดยใช้ป้ายกำกับ
ในไฟล์ BUILD
แบบง่าย คุณจะเรียงลำดับการประกาศกฎใหม่ได้อย่างอิสระโดยไม่ต้องเปลี่ยนลักษณะการทำงาน
ไฟล์ BUILD
ต้องไม่มีคําจํากัดความฟังก์ชัน คำสั่ง for
หรือคำสั่ง if
(แต่อนุญาตให้ใช้ลิสต์คอมเพรสชันและนิพจน์ if
) เพื่อส่งเสริมให้แยกโค้ดและข้อมูลออกจากกันอย่างชัดเจน คุณสามารถประกาศฟังก์ชันในไฟล์ .bzl
แทนได้ นอกจากนี้ ระบบไม่อนุญาตให้ใช้อาร์กิวเมนต์ *args
และ **kwargs
ในไฟล์ BUILD
ให้ระบุอาร์กิวเมนต์ทั้งหมดอย่างชัดเจนแทน
ที่สำคัญคือ โปรแกรมใน Starlark ไม่สามารถดำเนินการ I/O ที่ไม่ได้กำหนดไว้ อินตัวแปรที่ไม่เปลี่ยนแปลงนี้ทำให้การตีความไฟล์ BUILD
เป็นไปอย่างสมบูรณ์แบบ โดยขึ้นอยู่กับชุดอินพุตที่รู้จักเท่านั้น ซึ่งจำเป็นต่อการทำให้บิวด์สร้างซ้ำได้
ดูรายละเอียดเพิ่มเติมได้ที่การปิดผนึก
ไฟล์ BUILD
ควรเขียนโดยใช้อักขระ ASCII เท่านั้น แม้ว่าในทางเทคนิคแล้วระบบจะตีความโดยใช้ชุดอักขระ Latin-1
เนื่องจากจำเป็นต้องอัปเดตไฟล์ BUILD
ทุกครั้งที่ทรัพยากร Dependency ของโค้ดที่ระบุมีการเปลี่ยนแปลง โดยทั่วไปไฟล์จึงจะได้รับการดูแลโดยผู้ใช้หลายคนในทีม ผู้เขียนไฟล์ BUILD
ควรใส่ความคิดเห็นอย่างละเอียดเพื่อบันทึกบทบาทของเป้าหมายการสร้างแต่ละรายการ ไม่ว่าจะมีไว้เพื่อการใช้งานแบบสาธารณะหรือไม่ก็ตาม และเพื่อบันทึกบทบาทของแพ็กเกจเอง
การโหลดส่วนขยาย
นามสกุล Bazel คือไฟล์ที่ลงท้ายด้วย .bzl
ใช้คำสั่ง load
เพื่อนำเข้าสัญลักษณ์จากส่วนขยาย
load("//foo/bar:file.bzl", "some_library")
โค้ดนี้จะโหลดไฟล์ foo/bar/file.bzl
และเพิ่มสัญลักษณ์ some_library
ลงในสภาพแวดล้อม ซึ่งสามารถใช้เพื่อโหลดกฎ ฟังก์ชัน หรือค่าคงที่ใหม่ (เช่น สตริงหรือลิสต์) คุณสามารถนําเข้าสัญลักษณ์หลายรายการได้โดยใช้อาร์กิวเมนต์เพิ่มเติมในการเรียกใช้ load
อาร์กิวเมนต์ต้องเป็นสตริงตัวอักษรล้วน (ไม่มีตัวแปร) และคำสั่ง load
ต้องปรากฏที่ระดับบนสุด และต้องไม่อยู่ในเนื้อหาของฟังก์ชัน
อาร์กิวเมนต์แรกของ load
คือป้ายกำกับที่ระบุไฟล์ .bzl
หากเป็นป้ายกำกับที่เกี่ยวข้อง จะมีการแก้ไขตามแพ็กเกจ (ไม่ใช่ไดเรกทอรี) ที่มีไฟล์ bzl
ปัจจุบัน ป้ายกำกับแบบสัมพัทธ์ในคำสั่ง load
ควรใช้ :
นำหน้า
load
ยังรองรับชื่อแทนด้วย คุณจึงกำหนดชื่ออื่นให้กับสัญลักษณ์ที่นำเข้าได้
load("//foo/bar:file.bzl", library_alias = "some_library")
คุณสามารถกำหนดชื่อแทนได้หลายชื่อภายในคำสั่ง load
คำสั่งเดียว นอกจากนี้ รายการอาร์กิวเมนต์มีทั้งชื่อแทนและชื่อสัญลักษณ์ปกติ ตัวอย่างต่อไปนี้ถูกต้องตามกฎหมาย (โปรดทราบว่าควรใช้เครื่องหมายคำพูดเมื่อใด)
load(":my_rules.bzl", "some_rule", nice_alias = "some_other_rule")
ในไฟล์ .bzl
ระบบจะไม่ส่งออกสัญลักษณ์ที่ขึ้นต้นด้วย _
และไม่สามารถโหลดจากไฟล์อื่นได้
คุณสามารถใช้การโหลดระดับการมองเห็นเพื่อจำกัดผู้ที่อาจโหลดไฟล์ .bzl
ได้
ประเภทของกฎบิลด์
กฎการสร้างส่วนใหญ่มาจากครอบครัวและจัดกลุ่มตามภาษา เช่น cc_binary
, cc_library
และ cc_test
เป็นกฎการสร้างสำหรับไบนารี C++, ไลบรารี และการทดสอบตามลำดับ ภาษาอื่นๆ ใช้รูปแบบการตั้งชื่อเดียวกัน แต่มีคำนำหน้าต่างกัน เช่น java_*
สำหรับ Java ฟังก์ชันบางอย่างมีอยู่ในสารานุกรม Build แต่ทุกคนสามารถสร้างกฎใหม่ได้
กฎ
*_binary
สร้างโปรแกรมที่เรียกใช้ได้ในภาษาหนึ่งๆ หลังจากสร้าง ไฟล์ปฏิบัติการจะอยู่ในแผนผังเอาต์พุตไบนารีของเครื่องมือบิลด์ในชื่อที่เกี่ยวข้องสำหรับป้ายกำกับของกฎ ดังนั้น//my:program
จะปรากฏที่$(BINDIR)/my/program
(เช่น)ในบางภาษา กฎดังกล่าวจะสร้างไดเรกทอรี Runfile ที่มีไฟล์ทั้งหมดที่กล่าวถึงในแอตทริบิวต์
data
ที่เป็นของกฎ หรือกฎใดๆ ที่ปิด Dependency แบบสโลว์โมชัน ไฟล์ชุดนี้จะรวมอยู่ในที่เดียวเพื่อให้ติดตั้งใช้งานเป็นเวอร์ชันที่ใช้งานจริงได้ง่ายกฎ
*_test
ข้อเป็นความเชี่ยวชาญพิเศษของกฎ*_binary
ที่ใช้สำหรับการทดสอบอัตโนมัติ การทดสอบเป็นเพียงโปรแกรมที่ประสบผลสำเร็จเป็นศูนย์เช่นเดียวกับไบนารี การทดสอบก็มีต้นไม้ไฟล์รันไทม์ด้วย และไฟล์ที่อยู่ด้านล่างเป็นไฟล์เดียวที่การทดสอบอาจเปิดได้อย่างถูกต้องขณะรันไทม์ ตัวอย่างเช่น โปรแกรม
cc_test(name='x', data=['//foo:bar'])
อาจเปิดและอ่าน$TEST_SRCDIR/workspace/foo/bar
ในระหว่างการดำเนินการ (ภาษาโปรแกรมแต่ละภาษามีฟังก์ชันยูทิลิตีของตนเองสำหรับการเข้าถึงค่าของ$TEST_SRCDIR
แต่ทุกภาษาเทียบเท่ากับการใช้ตัวแปรสภาพแวดล้อมโดยตรง) การไม่ปฏิบัติตามกฎจะทำให้การทดสอบล้มเหลวเมื่อดำเนินการบนโฮสต์การทดสอบระยะไกลกฎ
*_library
จะระบุโมดูลที่คอมไพล์แยกต่างหากในภาษาโปรแกรมที่ระบุ ไลบรารีอาจขึ้นอยู่กับไลบรารีอื่นๆ และไบนารีและการทดสอบอาจขึ้นอยู่กับไลบรารี โดยมีลักษณะการคอมไพล์แยกต่างหากตามที่คาดไว้
ป้ายกำกับ | การขึ้นต่อกัน |