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

รายงานปัญหา ดูแหล่งที่มา

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

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

กฎ

• เชื่อมโยง
• local_repository
• new_local_repository

bind

ดูแหล่งที่มาของกฎ

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

local_repository

ดูแหล่งที่มาของกฎ

local_repository(name, path, repo_mapping)

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

ตัวอย่าง

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

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

Attributes
name	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
path	สตริง ต้องระบุ เส้นทางไปยังไดเรกทอรีของที่เก็บในเครื่อง ต้องเป็นเส้นทางไปยังไดเรกทอรีที่มีไฟล์ WORKSPACE ของที่เก็บ เส้นทางอาจเป็นแบบสัมบูรณ์หรือสัมพัทธ์กับไฟล์ WORKSPACE ของที่เก็บหลัก
repo_mapping	พจนานุกรม: สตริง -> สตริง ค่าเริ่มต้นคือ {} พจนานุกรมจากชื่อที่เก็บในเครื่องเป็นชื่อที่เก็บส่วนกลาง การดำเนินการนี้ช่วยให้ควบคุมความละเอียดของทรัพยากร Dependency ของที่เก็บนี้ได้ ตัวอย่างเช่น รายการ "@foo": "@bar" ประกาศว่าเมื่อใดก็ตามที่ที่เก็บนี้อ้างอิง "@foo" (เช่น ทรัพยากร Dependency ของ "@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 และไดเรกทอรีย่อยที่มีลิงก์สัญลักษณ์ไปยังไฟล์ 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"],
)

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

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

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