บทแนะนำ Bazel: สร้างโปรเจ็กต์ C++

บทนำ

หากเพิ่งเริ่มใช้ 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
    │  └── MODULE.bazel
    ├──stage2
    │  ├── main
    │  │   ├── BUILD
    │  │   ├── hello-world.cc
    │  │   ├── hello-greet.cc
    │  │   └── hello-greet.h
    │  └── MODULE.bazel
    └──stage3
       ├── main
       │   ├── BUILD
       │   ├── hello-world.cc
       │   ├── hello-greet.cc
       │   └── hello-greet.h
       ├── lib
       │   ├── BUILD
       │   ├── hello-time.cc
       │   └── hello-time.h
       └── MODULE.bazel

โปรเจ็กต์ตัวอย่างมีไฟล์ 3 ชุด โดยแต่ละชุดแสดงถึงระยะหนึ่งในบทแนะนำนี้ ในระยะแรก คุณจะได้สร้างเป้าหมายเดียวที่อยู่ในแพ็กเกจเดียว ในระยะที่ 2 คุณจะได้สร้างทั้งไบนารีและไลบรารีจากแพ็กเกจเดียว ในระยะที่ 3 ซึ่งเป็นระยะสุดท้าย คุณจะได้สร้างโปรเจ็กต์ที่มีหลายแพ็กเกจและสร้างด้วยเป้าหมายหลายรายการ

สรุป: บทนำ

การติดตั้ง Bazel (และ Git) และการโคลนที่เก็บสำหรับบทแนะนำนี้เป็นการวางรากฐานสำหรับการบิลด์ครั้งแรกด้วย Bazel ไปยังส่วนถัดไปเพื่อกำหนดคำบางคำและตั้งค่าพื้นที่ทำงาน

เริ่มต้นใช้งาน

คุณต้องตั้งค่าพื้นที่ทำงานของโปรเจ็กต์ก่อนจึงจะสร้างโปรเจ็กต์ได้ พื้นที่ทำงานคือไดเรกทอรีที่เก็บไฟล์ต้นฉบับของโปรเจ็กต์และเอาต์พุตบิลด์ของ Bazel นอกจากนี้ยังมีไฟล์สำคัญต่อไปนี้ด้วย

• ไฟล์ MODULE.bazel ซึ่งระบุไดเรกทอรีและเนื้อหาเป็นพื้นที่ทำงานของ Bazel และอยู่ในรูทของโครงสร้างไดเรกทอรีของโปรเจ็กต์ นอกจากนี้ยังเป็นที่ที่คุณระบุการขึ้นต่อกันภายนอกด้วย
• ไฟล์ BUILD อย่างน้อย 1 ไฟล์ ซึ่งจะบอก Bazel ถึงวิธีสร้างส่วนต่างๆ ของโปรเจ็กต์ ไดเรกทอรีภายใน พื้นที่ทำงานที่มีไฟล์ BUILD จะเรียกว่า แพ็กเกจ (ดูข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจในส่วนต่อๆ ไปของบทแนะนำนี้)

ในโปรเจ็กต์ในอนาคต หากต้องการกำหนดไดเรกทอรีเป็นพื้นที่ทำงานของ Bazel ให้สร้างไฟล์ว่างชื่อ MODULE.bazel ในไดเรกทอรีนั้น สำหรับบทแนะนำนี้ ไฟล์ MODULE.bazel จะมีอยู่ในแต่ละระยะอยู่แล้ว

ทำความเข้าใจไฟล์ BUILD

ไฟล์ BUILD มีคำแนะนำหลายประเภทสำหรับ Bazel ไฟล์ BUILDแต่ละไฟล์ต้องมีกฎอย่างน้อย 1 ข้อ เป็นชุดคำแนะนำ ซึ่งจะบอก Bazel ถึงวิธีสร้างเอาต์พุตที่ต้องการ เช่น ไบนารีที่เรียกใช้งานได้ หรือไลบรารี อินสแตนซ์แต่ละรายการของกฎบิลด์ในไฟล์ BUILD จะเรียกว่า เป้าหมาย และชี้ไปยัง ชุดไฟล์ต้นฉบับและ การขึ้นต่อกันที่เฉพาะเจาะจง เป้าหมายยังชี้ไปยังเป้าหมายอื่นๆ ได้ด้วย

ดูไฟล์ BUILD ในไดเรกทอรี cpp-tutorial/stage1/main ได้ดังนี้

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
)

ในตัวอย่างของเรา เป้าหมาย hello-world จะสร้างอินสแตนซ์ของกฎ cc_binary ในตัวของ Bazel กฎนี้จะบอก Bazel ให้สร้างไบนารีที่เรียกใช้งานได้แบบสแตนด์อโลนจากไฟล์ต้นฉบับ hello-world.cc> โดยไม่มีการขึ้นต่อกัน

สรุป: เริ่มต้นใช้งาน

ตอนนี้คุณคุ้นเคยกับคำสำคัญบางคำและความหมายของคำเหล่านั้นในบริบทของโปรเจ็กต์นี้และ Bazel โดยทั่วไปแล้ว ในส่วนถัดไป คุณจะได้สร้างและทดสอบระยะที่ 1 ของโปรเจ็กต์

ระยะที่ 1: เป้าหมายเดียว, แพ็กเกจเดียว

ได้เวลาสร้างส่วนแรกของโปรเจ็กต์แล้ว โครงสร้างของส่วนระยะที่ 1 ของโปรเจ็กต์มีดังนี้

examples
└── cpp-tutorial
    └──stage1
       ├── main
       │   ├── BUILD
       │   └── hello-world.cc
       └── MODULE.bazel

เรียกใช้คำสั่งต่อไปนี้เพื่อย้ายไปยังไดเรกทอรี 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
    │  └── MODULE.bazel

ดูไฟล์ 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 ในตัวของ 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 จะคอมไพล์ไฟล์นั้นใหม่เท่านั้น

เมื่อดูกราฟการขึ้นต่อกัน คุณจะเห็นว่า hello-world ขึ้นต่อกันกับอินพุตเพิ่มเติมชื่อ hello-greet

สรุป: ระยะที่ 2

ตอนนี้คุณได้สร้างโปรเจ็กต์ที่มีเป้าหมาย 2 รายการแล้ว เป้าหมาย hello-world จะสร้างไฟล์ต้นฉบับ 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
   └── MODULE.bazel

คุณจะเห็นว่าตอนนี้มีไดเรกทอรีย่อย 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 คุณจะเห็นสิ่งนี้ในกราฟการขึ้นต่อกัน

เพื่อให้การบิลด์สำเร็จ คุณต้องทำให้เป้าหมาย //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 รายการ และเข้าใจการขึ้นต่อกันระหว่างเป้าหมายเหล่านั้นแล้ว ซึ่งจะช่วยให้คุณสามารถสร้างโปรเจ็กต์ในอนาคตด้วย Bazel ได้ ในส่วนถัดไป ให้ดูวิธีดำเนินการต่อในการใช้ Bazel

ขั้นตอนถัดไป

ตอนนี้คุณได้ทำการบิลด์พื้นฐานครั้งแรกด้วย Bazel เสร็จสมบูรณ์แล้ว แต่การบิลด์นี้เป็นเพียงจุดเริ่มต้น แหล่งข้อมูลต่อไปนี้จะช่วยให้คุณเรียนรู้การใช้ Bazel ต่อไปได้

• หากต้องการมุ่งเน้นไปที่ C++ ต่อไป ให้อ่านเกี่ยวกับกรณีการใช้งานบิลด์ C++ ทั่วไป cases
• หากต้องการเริ่มต้นสร้างแอปพลิเคชันอื่นๆ ด้วย Bazel โปรดดู บทแนะนำสำหรับ Java, แอปพลิเคชัน Android หรือ แอปพลิเคชัน iOS
• หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับที่เก็บในเครื่องและที่เก็บระยะไกล โปรดอ่านเกี่ยวกับ การขึ้นต่อกันภายนอก
• หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับกฎอื่นๆ ของ Bazel โปรดดูคู่มือ อ้างอิงนี้

ขอให้สนุกกับการสร้าง