เกริ่นนำ
หากเพิ่งเริ่มใช้ Bazel คุณมาถูกที่แล้ว ทำตามบทแนะนำการสร้างครั้งแรกนี้เพื่อดู ข้อมูลเบื้องต้นที่ง่ายขึ้นในการใช้ Bazel บทแนะนำนี้จะให้นิยามคำศัพท์สำคัญเมื่อใช้ในบริบทของ Bazel และแนะนำข้อมูลเบื้องต้นเกี่ยวกับเวิร์กโฟลว์ของ Bazel เริ่มจากเครื่องมือที่ต้องใช้เพื่อสร้างและดำเนินโครงการ 3 โครงการโดยมีความซับซ้อนเพิ่มมากขึ้น และเรียนรู้ว่าทำอย่างไร และเหตุใดโครงการจึงมีความซับซ้อนมากขึ้น
แม้ว่า Bazel จะเป็นระบบบิลด์ที่รองรับบิลด์หลายภาษา แต่บทแนะนำนี้ใช้โปรเจ็กต์ C++ เป็นตัวอย่าง รวมถึงแสดงหลักเกณฑ์และขั้นตอนทั่วไปที่ใช้ได้กับภาษาส่วนใหญ่
เวลาที่ใช้ดำเนินการจนเสร็จสิ้นโดยประมาณ: 30 นาที
สิ่งที่ต้องดำเนินการก่อน
เริ่มต้นด้วยการติดตั้ง Bazel บทแนะนำนี้ใช้ Git สำหรับการควบคุมแหล่งที่มา ดังนั้นโปรดติดตั้ง Git ด้วยเพื่อให้ได้ผลลัพธ์ที่ดีที่สุด
ถัดไป ให้เรียกข้อมูลโปรเจ็กต์ตัวอย่างจากที่เก็บ GitHub ของ Bazel โดยเรียกใช้โค้ดต่อไปนี้ในเครื่องมือบรรทัดคำสั่งที่ต้องการ
git clone https://github.com/bazelbuild/examples
โปรเจ็กต์ตัวอย่างสำหรับบทแนะนำนี้อยู่ในไดเรกทอรี examples/cpp-tutorial
ลองดูโครงสร้างของระบบด้านล่างนี้
examples
└── cpp-tutorial
├──stage1
│ ├── main
│ │ ├── BUILD
│ │ └── hello-world.cc
│ └── WORKSPACE
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
ไฟล์มีอยู่ 3 ชุด โดยแต่ละชุดจะแสดงขั้นตอนในบทแนะนำนี้ ในระยะแรก คุณจะต้องสร้างเป้าหมายเดียวที่อยู่ในแพ็กเกจเดียว ในขั้นตอนที่ 2 คุณจะสร้างทั้งไบนารีและไลบรารีจากแพ็กเกจเดียว ในขั้นตอนที่ 3 ซึ่งเป็นระยะสุดท้าย คุณจะได้สร้างโปรเจ็กต์ที่มีแพ็กเกจหลายรายการและสร้างโดยมีหลายเป้าหมาย
สรุป: บทนำ
การติดตั้ง Bazel (และ Git) และโคลนที่เก็บสำหรับบทแนะนำนี้เป็นการปูพื้นฐานสำหรับบิลด์แรกด้วย Bazel ไปที่ส่วนถัดไปเพื่อกำหนดข้อกำหนดและตั้งค่าพื้นที่ทำงาน
เริ่มต้นใช้งาน
ตั้งค่าพื้นที่ทำงาน
คุณต้องตั้งค่าพื้นที่ทำงานของโปรเจ็กต์ก่อนจึงจะสร้างโปรเจ็กต์ได้ พื้นที่ทำงานคือไดเรกทอรีที่เก็บไฟล์ต้นทางของโปรเจ็กต์และเอาต์พุตบิลด์ของ Bazel นอกจากนี้ยังมีไฟล์สำคัญต่อไปนี้ด้วย
ซึ่งระบุไดเรกทอรีและเนื้อหาในไดเรกทอรีเป็นพื้นที่ทำงานของ Bazel และอยู่ที่รูทของโครงสร้างไดเรกทอรีของโปรเจ็กต์WORKSPACE
file
อย่างน้อย 1 รายการ ซึ่งบอก Bazel ถึงวิธีสร้างส่วนต่างๆ ของโปรเจ็กต์ ไดเรกทอรีภายในพื้นที่ทำงานที่มีไฟล์BUILD
filesBUILD
เป็นแพ็กเกจ (ดูข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจได้ภายหลังในบทแนะนำนี้)
ในโปรเจ็กต์ในอนาคต หากต้องการกำหนดไดเรกทอรีเป็นพื้นที่ทำงาน Bazel ให้สร้างไฟล์เปล่าชื่อ WORKSPACE
ในไดเรกทอรีนั้น ตามวัตถุประสงค์ของบทแนะนำนี้
มีไฟล์ WORKSPACE
อยู่ในแต่ละขั้นตอนแล้ว
หมายเหตุ: เมื่อ Bazel สร้างโปรเจ็กต์ อินพุตทั้งหมดต้องอยู่ในพื้นที่ทำงานเดียวกัน ไฟล์ที่อยู่ในพื้นที่ทำงานที่ต่างกันจะเป็นอิสระต่อกัน เว้นแต่จะมีการเชื่อมโยงกัน ดูข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับกฎพื้นที่ทำงานได้ในคู่มือนี้
ทำความเข้าใจไฟล์ BUILD
ไฟล์ BUILD
มีวิธีการหลายประเภทสำหรับ Bazel ไฟล์ BUILD
แต่ละไฟล์ต้องมีกฎอย่างน้อย 1 ข้อเป็นชุดวิธีการ ซึ่งจะบอก Bazel ถึงวิธีสร้างเอาต์พุตที่ต้องการ เช่น ไบนารีหรือไลบรารีสั่งการ แต่ละอินสแตนซ์ของกฎบิลด์ในไฟล์ BUILD
จะเรียกว่า target และชี้ไปยังชุดไฟล์แหล่งที่มาและทรัพยากร Dependency ที่เฉพาะเจาะจง
เป้าหมายชี้ไปยังเป้าหมายอื่นได้ด้วย
ดูไฟล์ BUILD
ในไดเรกทอรี cpp-tutorial/stage1/main
:
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
)
ในตัวอย่างของเรา เป้าหมาย hello-world
จะสร้างอินสแตนซ์ cc_binary rule
ในตัวของ Bazel
กฎนี้จะบอก Bazel ให้สร้างไบนารีสั่งการที่มีในตัวจากไฟล์ต้นทาง hello-world.cc
โดยไม่มีทรัพยากร Dependency
สรุป: การเริ่มต้นใช้งาน
ตอนนี้คุณก็คุ้นเคยกับคำศัพท์สำคัญและความหมายในบริบทของโปรเจ็กต์นี้และ Bazel โดยทั่วไปแล้ว ในหัวข้อถัดไป คุณจะได้สร้างและทดสอบระยะที่ 1 ของโปรเจ็กต์
ขั้นที่ 1: เป้าหมายเดียว แพ็กเกจเดียว
ถึงเวลาสร้างส่วนแรกของโปรเจ็กต์แล้ว สำหรับการอ้างอิงด้วยภาพ โครงสร้างของส่วนระยะที่ 1 ของโปรเจ็กต์คือ
examples
└── cpp-tutorial
└──stage1
├── main
│ ├── BUILD
│ └── hello-world.cc
└── WORKSPACE
เรียกใช้คำสั่งต่อไปนี้เพื่อย้ายไปยังไดเรกทอรี cpp-tutorial/stage1
cd cpp-tutorial/stage1
ต่อไป ให้เรียกใช้
bazel build //main:hello-world
ในป้ายกำกับเป้าหมาย ส่วน //main:
คือตำแหน่งของไฟล์ BUILD
ที่สัมพันธ์กับรูทของพื้นที่ทำงาน และ hello-world
คือชื่อเป้าหมายในไฟล์ BUILD
Bazel ผลิตเนื้อหาที่มีลักษณะเช่นนี้
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.267s, Critical Path: 0.25s
คุณเพิ่งสร้างเป้าหมาย Bazel แรก Bazel จะวางเอาต์พุตของบิลด์ในไดเรกทอรี bazel-bin
ที่รูทของพื้นที่ทำงาน
ตอนนี้ให้ทดสอบไบนารีที่สร้างใหม่ ซึ่งก็คือ
bazel-bin/main/hello-world
ซึ่งส่งผลให้มีข้อความ "Hello world
" ที่พิมพ์ออกมา
กราฟการขึ้นต่อกันของระยะที่ 1 มีดังนี้
สรุป: ขั้นที่ 1
เมื่อคุณสร้างงานสร้างแรกเสร็จแล้ว คุณจะมีไอเดียพื้นฐานว่างานสร้างมีโครงสร้างอย่างไร ในขั้นตอนถัดไป คุณจะเพิ่มความซับซ้อนโดยการเพิ่มเป้าหมายอื่น
ขั้นที่ 2: เป้าหมายบิลด์หลายรายการ
แม้ว่าเป้าหมายเดียวจะเพียงพอแล้วสำหรับโปรเจ็กต์ขนาดเล็ก แต่คุณอาจต้องแบ่งโปรเจ็กต์ขนาดใหญ่ออกเป็นหลายเป้าหมายและแพ็กเกจ ซึ่งทำให้งานสร้างเพิ่มขึ้นอย่างรวดเร็ว กล่าวคือ Bazel จะสร้างเฉพาะสิ่งที่เปลี่ยนแปลงไปขึ้นมาใหม่เท่านั้น และทำให้งานสร้างของคุณเร็วขึ้นด้วยการสร้างส่วนต่างๆ ของโปรเจ็กต์พร้อมกัน ขั้นตอนนี้ของบทแนะนำจะเพิ่มเป้าหมาย ส่วนถัดไปจะเพิ่มแพ็กเกจ
นี่คือไดเรกทอรีที่คุณกำลังใช้งานสำหรับระยะที่ 2:
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
ลองดูไฟล์ BUILD
ในไดเรกทอรี cpp-tutorial/stage2/main
ด้านล่าง
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
],
)
ด้วยไฟล์ BUILD
นี้ Bazel จะสร้างไลบรารี hello-greet
ก่อน (โดยใช้ cc_library rule
ในตัวของ Bazel) จากนั้นจึงสร้างไบนารี hello-world
แอตทริบิวต์ deps
ในเป้าหมาย hello-world
จะบอก Bazel ว่าไลบรารี hello-greet
จำเป็นต้องสร้างไบนารี hello-world
คุณต้องเปลี่ยนไดเรกทอรีและเปลี่ยนเป็นไดเรกทอรี cpp-tutorial/stage2
โดยเรียกใช้รายการต่อไปนี้ก่อนสร้างโปรเจ็กต์เวอร์ชันใหม่นี้
cd ../stage2
ตอนนี้คุณสร้างไบนารีใหม่ได้โดยใช้คำสั่งที่คุ้นเคยต่อไปนี้
bazel build //main:hello-world
Bazel ผลิตเนื้อหาที่มีลักษณะเช่นนี้อีกแล้ว
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.399s, Critical Path: 0.30s
ตอนนี้คุณทดสอบไบนารีที่สร้างใหม่ได้แล้ว ซึ่งจะแสดงผล “Hello world
” อีกรายการหนึ่ง:
bazel-bin/main/hello-world
หากคุณแก้ไข hello-greet.cc
แล้วสร้างโปรเจ็กต์ใหม่ Bazel จะคอมไพล์เฉพาะไฟล์นั้นซ้ำเท่านั้น
เมื่อดูกราฟทรัพยากร Dependency แล้ว คุณจะเห็นว่า hello-world
อิงตามอินพุตเพิ่มเติมที่ชื่อว่า hello-greet
สรุป: ขั้นที่ 2
ตอนนี้คุณได้สร้างโปรเจ็กต์ที่มีเป้าหมาย 2 รายการแล้ว เป้าหมาย hello-world
จะสร้างไฟล์ต้นฉบับ 1 ไฟล์และขึ้นอยู่กับเป้าหมายอื่นอีก 1 รายการ (//main:hello-greet
) ซึ่งจะสร้างไฟล์ต้นทางเพิ่มอีก 2 ไฟล์ ในส่วนถัดไป ดำเนินการเพิ่ม
และเพิ่มแพ็กเกจอีกรายการ
ขั้นที่ 3: หลายแพ็กเกจ
ขั้นตอนถัดไปนี้จะเพิ่มข้อมูลแทรกอีกชั้นหนึ่งและสร้างโปรเจ็กต์ที่มีแพ็กเกจหลายรายการ ลองดูโครงสร้างและเนื้อหาของไดเรกทอรี cpp-tutorial/stage3
ที่ด้านล่าง
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
คุณจะเห็นว่าขณะนี้มีไดเรกทอรีย่อย 2 รายการ และแต่ละไดเรกทอรีย่อยมีไฟล์ BUILD
ดังนั้นสำหรับ Bazel พื้นที่ทำงานจะมี 2 แพ็กเกจ ได้แก่ lib
และ main
ดูไฟล์ lib/BUILD
:
cc_library(
name = "hello-time",
srcs = ["hello-time.cc"],
hdrs = ["hello-time.h"],
visibility = ["//main:__pkg__"],
)
และในไฟล์ main/BUILD
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
"//lib:hello-time",
],
)
เป้าหมาย hello-world
ในแพ็กเกจหลักขึ้นอยู่กับเป้าหมาย hello-time
ในแพ็กเกจ lib
(ดังนั้นป้ายกำกับเป้าหมาย //lib:hello-time
) Bazel จะทราบเรื่องนี้ผ่านแอตทริบิวต์ deps
คุณจะเห็นข้อมูลนี้แสดงในกราฟทรัพยากร Dependency
เพื่อให้บิลด์ประสบความสำเร็จ คุณทำให้เป้าหมาย //lib:hello-time
ใน lib/BUILD
เห็นอย่างชัดเจนกับเป้าหมายใน main/BUILD
โดยใช้แอตทริบิวต์ระดับการเข้าถึง
ทั้งนี้เนื่องจากโดยค่าเริ่มต้น เป้าหมายเริ่มต้นจะปรากฏเฉพาะกับเป้าหมายอื่นในไฟล์ BUILD
เดียวกันเท่านั้น Bazel ใช้ระดับการเข้าถึงเป้าหมายเพื่อป้องกันปัญหาต่างๆ เช่น ไลบรารีที่มีรายละเอียดการใช้งานรั่วไหลใน API สาธารณะ
จากนั้นสร้างโปรเจ็กต์เวอร์ชันสุดท้ายนี้ เปลี่ยนไปใช้ไดเรกทอรี cpp-tutorial/stage3
โดยเรียกใช้
cd ../stage3
เรียกใช้คำสั่งต่อไปนี้อีกครั้ง
bazel build //main:hello-world
Bazel ผลิตเนื้อหาที่มีลักษณะเช่นนี้
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 0.167s, Critical Path: 0.00s
ตอนนี้ให้ทดสอบไบนารีสุดท้ายของบทแนะนำนี้สำหรับข้อความ Hello world
สุดท้าย:
bazel-bin/main/hello-world
สรุป: ระยะที่ 3
ตอนนี้คุณได้สร้างโปรเจ็กต์จาก 2 แพ็กเกจที่มี 3 เป้าหมายแล้ว และเข้าใจทรัพยากร Dependency ระหว่างแพ็กเกจทั้งสอง ซึ่งจะเตรียมความพร้อมให้คุณดำเนินการต่อและสร้างโปรเจ็กต์ในอนาคตด้วย Bazel ในส่วนถัดไป เรามาดูวิธีการเดินทางของคุณต่อในบาเซล
ขั้นตอนถัดไป
ตอนนี้คุณสิ้นสุดงานสร้างพื้นฐานกับ Bazel เสร็จเรียบร้อยแล้ว แต่นี่เป็นเพียงจุดเริ่มต้น แหล่งข้อมูลเพิ่มเติมเพื่อการเรียนรู้กับ Bazel ต่อไปมีดังนี้
- หากต้องการมุ่งเน้นที่ C++ ต่อไป โปรดอ่านเกี่ยวกับ Use Case ทั่วไปของ C++
- หากต้องการเริ่มต้นสร้างแอปพลิเคชันอื่นๆ ด้วย Bazel โปรดดูบทแนะนำสำหรับ Java, แอปพลิเคชัน Android หรือแอปพลิเคชัน iOS)
- หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับที่เก็บในเครื่องและระยะไกล โปรดอ่านเกี่ยวกับทรัพยากร Dependency ภายนอก
- ดูข้อมูลเพิ่มเติมเกี่ยวกับกฎอื่นๆ ของ Bazel ได้ที่คู่มืออ้างอิงนี้
ขอให้สนุกกับการสร้าง