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

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

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

กฎ

• bind
• local_repository
• new_local_repository

เชื่อมโยง

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 ไม่ใช่แพ็กเกจ "ปกติ" เนื่องจากไม่มีไดเรกทอรีภายนอก จึงถือได้ว่าเป็น "แพ็กเกจเสมือน" ที่มีเป้าหมายที่เชื่อมโยงทั้งหมด

ตัวอย่าง

หากต้องการตั้งชื่อแทนให้เป้าหมาย ให้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's includes อาจมีลักษณะดังนี้

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

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

local_repository

local_repository(name, path, repo_mapping)

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

ตัวอย่าง

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

ผู้ใช้สามารถเพิ่มการอ้างอิงเป้าหมายนี้ได้โดยเพิ่มบรรทัดต่อไปนี้ลงใน ~/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 ลงใน การอ้างอิงของเป้าหมาย

นอกจากนี้ คุณยังใช้ 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"],
)

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