กฎพื้นที่ทำงาน

กฎของพื้นที่ทำงานใช้เพื่อดึง ทรัพยากร Dependency ภายนอก ซึ่งโดยปกติจะเป็น ซอร์สโค้ดที่อยู่นอกที่เก็บหลัก

หมายเหตุ: นอกจากกฎของพื้นที่ทำงานแบบเนทีฟแล้ว Bazel ยังฝังกฎของพื้นที่ทำงาน Starlarkต่างๆ ไว้ด้วย โดยเฉพาะกฎที่ใช้จัดการที่เก็บ Git หรือไฟล์เก็บถาวรที่โฮสต์บนเว็บ

กฎ

• bind
• local_repository
• new_local_repository

bind

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

คำเตือน: ไม่แนะนำให้ใช้ bind() โปรดดู "พิจารณานำ bind ออก" เพื่อดูการอภิปรายอย่างละเอียดเกี่ยวกับปัญหาและทางเลือกอื่นๆ โดยเฉพาะอย่างยิ่ง ให้พิจารณาใช้แอตทริบิวต์ที่เก็บ repo_mapping

ประกาศเตือน: ไม่สามารถใช้select() ในbind() ได้ ดูรายละเอียดในคำถามที่พบบ่อยเกี่ยวกับแอตทริบิวต์ที่กำหนดค่าได้สำหรับ รายละเอียด

ให้เป้าหมายมีชื่อแทนในแพ็กเกจ //external

แพ็กเกจ //external ไม่ใช่แพ็กเกจ "ปกติ" เนื่องจากไม่มีไดเรกทอรี external/ จึงถือได้ว่าเป็น "แพ็กเกจเสมือน" ที่มีเป้าหมายทั้งหมดที่ผูกไว้

ตัวอย่าง

หากต้องการให้เป้าหมายมีชื่อแทน ให้ bind เป้าหมายนั้นในไฟล์ WORKSPACE เช่น สมมติว่ามีเป้าหมาย java_library ชื่อ //third_party/javacc-v2 คุณสามารถตั้งชื่อแทนเป้าหมายนี้ได้โดยเพิ่มโค้ดต่อไปนี้ลงในไฟล์ WORKSPACE

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

ตอนนี้เป้าหมายสามารถขึ้นอยู่กับ //external:javacc-latest แทน //third_party/javacc-v2 ได้แล้ว หากมีการเผยแพร่ javacc-v3 คุณสามารถอัปเดตกฎ bind และไฟล์ BUILD ทั้งหมดที่ขึ้นอยู่กับ //external:javacc-latest จะขึ้นอยู่กับ javacc-v3 โดยไม่ต้องแก้ไข

นอกจากนี้ คุณยังใช้ bind เพื่อทำให้เป้าหมายในที่เก็บภายนอกพร้อมใช้งานในพื้นที่ทำงานได้ด้วย เช่น หากมีที่เก็บระยะไกลชื่อ @my-ssl ที่นำเข้าในไฟล์ WORKSPACE และมีเป้าหมาย cc_library //src:openssl-lib คุณสามารถ สร้างชื่อแทนสำหรับเป้าหมายนี้ได้โดยใช้ bind ดังนี้

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

จากนั้นในไฟล์ BUILD ในพื้นที่ทำงาน คุณจะใช้เป้าหมายที่ผูกไว้ได้ดังนี้

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

ภายใน sign_in.cc และ sign_in.h คุณสามารถอ้างอิงไฟล์ส่วนหัวที่ //external:openssl เปิดเผยได้โดยใช้เส้นทางสัมพัทธ์กับรูทของที่เก็บ เช่น หากคำจำกัดความของกฎสำหรับ @my-ssl//src:openssl-lib มีลักษณะดังนี้

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

การรวมของ sign_in.cc อาจมีลักษณะดังนี้

#include "sign_in.h"
#include "src/openssl.h"

อาร์กิวเมนต์

local_repository

local_repository(name, path, repo_mapping)

อนุญาตให้ผูกเป้าหมายจากไดเรกทอรีภายใน ซึ่งหมายความว่าที่เก็บปัจจุบันสามารถ ใช้เป้าหมายที่กำหนดไว้ในไดเรกทอรีอื่นนี้ได้ ดูรายละเอียดเพิ่มเติมในส่วน bind section

ตัวอย่าง

สมมติว่าที่เก็บปัจจุบันเป็นไคลเอ็นต์แชทที่รูทอยู่ที่ไดเรกทอรี ~/chat-app และต้องการใช้ไลบรารี SSL ที่กำหนดไว้ในที่เก็บอื่น ~/ssl ไลบรารี SSL มีเป้าหมาย //src:openssl-lib

ผู้ใช้สามารถเพิ่มทรัพยากร Dependency ในเป้าหมายนี้ได้โดยเพิ่มบรรทัดต่อไปนี้ลงใน ~/chat-app/WORKSPACE:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

เป้าหมายจะระบุ @my-ssl//src:openssl-lib เป็นทรัพยากร Dependency เพื่อขึ้นอยู่กับไลบรารีนี้

อาร์กิวเมนต์

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

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

กฎนี้จะสร้างที่เก็บ Bazel โดยการสร้างไฟล์ WORKSPACE และไดเรกทอรีย่อยที่มีลิงก์สัญลักษณ์ไปยังไฟล์ BUILD และเส้นทางที่ระบุ ไฟล์บิลด์ควรสร้างเป้าหมายสัมพัทธ์กับ path สำหรับไดเรกทอรีที่มีไฟล์ WORKSPACE และไฟล์ BUILD อยู่แล้ว คุณสามารถใช้กฎ local_repository ได้

ตัวอย่าง

สมมติว่าที่เก็บปัจจุบันเป็นโปรแกรมแชทที่รูทอยู่ที่ไดเรกทอรี ~/chat-app และต้องการใช้ไลบรารี SSL ที่กำหนดไว้ในไดเรกทอรีอื่น ~/ssl

ผู้ใช้สามารถเพิ่มทรัพยากร Dependency ได้โดยการสร้างไฟล์ BUILD สำหรับไลบรารี SSL (~/chat-app/BUILD.my-ssl) ที่มีโค้ดต่อไปนี้

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

จากนั้นเพิ่มบรรทัดต่อไปนี้ลงใน ~/chat-app/WORKSPACE

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

การดำเนินการนี้จะสร้างที่เก็บ @my-ssl ที่ลิงก์สัญลักษณ์ไปยัง /home/user/ssl เป้าหมายสามารถขึ้นอยู่กับไลบรารีนี้ได้โดยการเพิ่ม @my-ssl//:openssl ลงในทรัพยากร Dependency ของเป้าหมาย

นอกจากนี้ คุณยังใช้ new_local_repository เพื่อรวมไฟล์เดียว ไม่ใช่แค่ไดเรกทอรีได้ด้วย เช่น สมมติว่าคุณมีไฟล์ jar อยู่ที่ /home/username/Downloads/piano.jar คุณสามารถเพิ่มไฟล์นั้นลงในบิลด์ได้โดยเพิ่มโค้ดต่อไปนี้ลงในไฟล์ WORKSPACE

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

และสร้างไฟล์ BUILD.piano ต่อไปนี้

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

อาร์กิวเมนต์