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

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

หมายเหตุ: นอกจากกฎของเวิร์กสเปซแบบดั้งเดิมแล้ว 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() ดู "พิจารณานำการเชื่อมโยงออก" เป็นเวลานาน การอภิปรายเกี่ยวกับปัญหาและทางเลือกต่างๆ โดยเฉพาะอย่างยิ่ง โปรดพิจารณาการใช้ 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 โดยที่ไม่ต้องแก้ไข

การเชื่อมโยงยังใช้เพื่อทำให้เป้าหมายในที่เก็บภายนอกพร้อมใช้งานในพื้นที่ทำงานของคุณได้ด้วย เช่น หากมีการนำเข้าที่เก็บระยะไกลชื่อ @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"

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

Attributes
name	Name; required ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้
actual	Label; optional เป้าหมายที่จะตั้งชื่อแทน เป้าหมายนี้ต้องมีอยู่ แต่เป็นกฎประเภทใดก็ได้ (รวมถึงการเชื่อมโยง) หากไม่ระบุแอตทริบิวต์นี้ กฎที่อ้างอิงเป้าหมายนี้ใน //external ก็จะไม่เห็นขอบความเกี่ยวข้องนี้ โปรดทราบว่าวิธีนี้แตกต่างจากการละเว้น กฎ bind ทั้งหมดคือข้อผิดพลาดหากทรัพยากร Dependency ของ //external ไม่มีกฎ bind ที่เชื่อมโยง

local_repository

local_repository(name, path, repo_mapping)

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

ตัวอย่าง

สมมติว่าที่เก็บปัจจุบันเป็นไคลเอ็นต์แชทที่รูทที่ไดเรกทอรี ~/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 เพื่อใช้ไลบรารีนี้

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

Attributes
name	Name; required ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
path	String; required เส้นทางไปยังไดเรกทอรีของที่เก็บในเครื่อง โดยต้องเป็นเส้นทางไปยังไดเรกทอรีที่มีไฟล์ WORKSPACE ของที่เก็บ เส้นทางอาจเป็นแบบสัมบูรณ์หรือสัมพัทธ์กับไฟล์ WORKSPACE ของที่เก็บข้อมูลหลักก็ได้
repo_mapping	Dictionary: String -> String; optional พจนานุกรมจากชื่อที่เก็บในเครื่องเป็นชื่อที่เก็บส่วนกลาง วิธีนี้ทำให้ควบคุม การแปลงพื้นที่ทำงานสำหรับทรัพยากร Dependency ของที่เก็บนี้ ตัวอย่างเช่น รายการ "@foo": "@bar" ประกาศว่าเมื่อใดก็ตามที่ที่เก็บข้อมูลนี้ใช้ "@foo" (เช่น ใช้ "@foo//some:target") ก็ควรแก้ไขการพึ่งพานั้นภายใน "@bar" ("@bar//some:target") ที่ประกาศไว้ทั่วโลก

new_local_repository

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

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

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

ตัวอย่าง

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

ผู้ใช้สามารถเพิ่มข้อกำหนดโดยสร้างไฟล์ 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"],
)

จากนั้นเป้าหมายอาจขึ้นอยู่กับ @piano//:play-music เพื่อใช้ piano.jar

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

Attributes
name	Name; required ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
build_file	String; optional ไฟล์ที่จะใช้เป็นไฟล์ BUILD สำหรับไดเรกทอรีนี้ ต้องระบุ build_file หรือ build_file_content แอตทริบิวต์นี้เป็นป้ายกำกับที่เกี่ยวข้องกับพื้นที่ทํางานหลัก ไฟล์ไม่จำเป็นต้อง ชื่อ BUILD แต่สามารถเป็นได้ (ชื่ออย่าง BUILD.new-repo-name อาจเหมาะสําหรับการแยกความแตกต่างจากไฟล์ BUILD จริงของที่เก็บ)
build_file_content	String; optional เนื้อหาของไฟล์ BUILD สำหรับที่เก็บนี้ ต้องระบุ build_file หรือ build_file_content
path	String; required เส้นทางในระบบไฟล์ในเครื่อง ซึ่งอาจเป็นค่าสัมบูรณ์หรือสัมพัทธ์กับไฟล์ WORKSPACE ของที่เก็บข้อมูลหลักก็ได้
repo_mapping	Dictionary: String -> String; optional พจนานุกรมจากชื่อที่เก็บในเครื่องเป็นชื่อที่เก็บส่วนกลาง ซึ่งจะช่วยให้ควบคุมการแก้ไขข้อกำหนดของพื้นที่ทำงานสำหรับข้อกำหนดของที่เก็บข้อมูลนี้ได้ ตัวอย่างเช่น รายการ "@foo": "@bar" จะประกาศว่า ที่เก็บขึ้นอยู่กับ "@foo" (เช่น ทรัพยากร Dependency ของ "@foo//some:target") ซึ่งควรแก้ไขการอ้างอิงนั้นภายใน "@bar" ("@bar//some:target") ที่ประกาศทั่วโลก
workspace_file	String; optional ไฟล์ที่จะใช้เป็นไฟล์ WORKSPACE สำหรับที่เก็บนี้ คุณสามารถระบุ workspace_file หรือ workspace_file_content เพียงรายการใดรายการหนึ่ง แอตทริบิวต์นี้เป็นป้ายกำกับที่เกี่ยวข้องกับพื้นที่ทำงานหลัก ไฟล์ไม่จำเป็นต้องมีชื่อว่า WORKSPACE แต่สามารถตั้งชื่อเป็นเช่นนั้นได้ (ชื่ออย่าง WORKSPACE.new-repo-name อาจใช้ได้ดีในการแยกความแตกต่างจากไฟล์ WORKSPACE จริงของที่เก็บ)
workspace_file_content	String; optional เนื้อหาสำหรับไฟล์ WORKSPACE ของที่เก็บข้อมูลนี้ คุณสามารถระบุ workspace_file หรือ workspace_file_content เพียงรายการใดรายการหนึ่ง