java_general

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

ยูทิลิตีสำหรับการรองรับการคอมไพล์ Java ใน Starlark

สำหรับสมาชิก

BootClassPathInfo

Provider java_common.BootClassPathInfo

ผู้ให้บริการที่ใช้ให้ข้อมูล Bootclasspath

compile

struct java_common.compile(ctx, *, source_jars=[], source_files=[], output, output_source_jar=None, javac_opts=[], deps=[], runtime_deps=[], exports=[], plugins=[], exported_plugins=[], native_libraries=[], annotation_processor_additional_inputs=[], annotation_processor_additional_outputs=[], strict_deps='ERROR', java_toolchain, bootclasspath=None, host_javabase=None, sourcepath=[], resources=[], resource_jars=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True, add_exports=[], add_opens=[])

คอมไพล์ไฟล์/jar ของ Java จากการใช้งานกฎของ Starlark และแสดงผลผู้ให้บริการที่แสดงถึงผลลัพธ์ของการคอมไพล์ และสามารถเพิ่มไปยังกลุ่มผู้ให้บริการที่เกิดขึ้นจากกฎนี้ได้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
ctx ctx; ต้องระบุ
บริบทของกฎ
source_jars ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
รายการ Jar ที่จะรวบรวม ควรระบุ source_jars หรือ source_files อย่างน้อย 1 รายการ
source_files ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
รายการไฟล์ต้นทางของ Java ที่จะคอมไพล์ ควรระบุ source_jars หรือ source_files อย่างน้อย 1 รายการ
output ไฟล์ ต้องระบุ
output_source_jar ไฟล์ หรือ None ค่าเริ่มต้นคือ None
jar แหล่งที่มาของเอาต์พุต ค่าเริ่มต้นคือ "{output_jar}-src.jar" หากไม่ได้ตั้งค่า
javac_opts sequence ของ strings ค่าเริ่มต้นคือ []
รายการตัวเลือก Javac ที่ต้องการ
deps sequence ของ structs ซึ่งค่าเริ่มต้นคือ []
รายการทรัพยากร Dependency
runtime_deps ลำดับของโครงสร้าง ค่าเริ่มต้นคือ []
รายการทรัพยากร Dependency ของรันไทม์
exports sequence ของ structs ค่าเริ่มต้นคือ []
รายการการส่งออก
plugins sequence ของ structs หรือลำดับของ structs ค่าเริ่มต้นคือ []
รายการปลั๊กอิน
exported_plugins sequence ของ structs หรือลำดับของ structs ค่าเริ่มต้นคือ []
รายการปลั๊กอินที่ส่งออก
native_libraries ลำดับ ของ CcInfo ค่าเริ่มต้นคือ []
CC ทรัพยากร Dependency ของไลบรารีแบบเนทีฟที่จำเป็นสำหรับไลบรารีนี้
annotation_processor_additional_inputs ลำดับของไฟล์ ค่าเริ่มต้นคือ []
รายการอินพุตที่การดำเนินการคอมไพล์ Java จะดำเนินการเพิ่มเติมจากซอร์สของ Java สำหรับการประมวลผลคำอธิบายประกอบ
annotation_processor_additional_outputs ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
รายการเอาต์พุตที่การดำเนินการคอมไพล์ Java จะแสดงผลเพิ่มเติมจากคลาส jar จากการประมวลผลคำอธิบายประกอบ
strict_deps string; ค่าเริ่มต้นคือ 'ERROR'
สตริงที่ระบุวิธีจัดการที่เข้มงวด ค่าที่เป็นไปได้คือ "OFF", "ERROR", "WARN" และ "DEFAULT" ดูรายละเอียดเพิ่มเติมได้ที่ --strict_java_deps flag. By default 'ERROR'.
java_toolchain ข้อมูล ต้องระบุ
JavaToolchainInfo ที่จะใช้สำหรับการคอมไพล์นี้ บังคับ
bootclasspath ค่าเริ่มต้นคือ None
BootClassPathInfo ที่จะใช้สำหรับการคอมไพล์นี้ หากมี จะลบล้าง Bootclasspath ที่เชื่อมโยงกับ java_toolchain ที่ระบุ
host_javabase ค่าเริ่มต้นคือ None
เลิกใช้งานแล้ว พารามิเตอร์นี้เลิกใช้งานแล้วและจะนำออกเร็วๆ นี้ โปรดอย่าพึ่งพา ถูกปิดใช้ด้วย --incompatible_java_common_parameters ใช้ธงนี้เพื่อยืนยันว่าโค้ดของคุณเข้ากันได้กับการนำออกในเร็วๆ นี้
เลิกใช้งาน: คุณวางพารามิเตอร์นี้ได้ (host_javabase มาพร้อมกับ java_toolchain)
sourcepath sequence ของไฟล์ ค่าเริ่มต้นคือ []
resources sequence ของไฟล์ ค่าเริ่มต้นคือ []
resource_jars sequence ของไฟล์ ค่าเริ่มต้นคือ []
classpath_resources sequence ของไฟล์ ค่าเริ่มต้นคือ []
bool; ค่าเริ่มต้นคือ False
enable_annotation_processing bool; ค่าเริ่มต้นคือ True
ปิดใช้การประมวลผลคำอธิบายประกอบในการคอมไพล์นี้ ซึ่งทำให้ระบบละเว้นตัวประมวลผลคำอธิบายประกอบที่มีอยู่ในปลั๊กอินหรือใน Export_plugins of dep
enable_compile_jar_action bool; ค่าเริ่มต้นคือ True
เปิดใช้การคอมไพล์ส่วนหัวหรือการสร้าง JAR หากตั้งค่าเป็น "เท็จ" ระบบจะบังคับให้ใช้ jar คลาสแบบเต็มในคลาสพาธการคอมไพล์ของทรัพยากร Dependency ทั้งหมด การกระทำดังกล่าวมีไว้ใช้กับเป้าหมายที่ไม่ใช่ไลบรารี เช่น ไบนารีที่ไม่มีทรัพยากร Dependency
add_exports ลำดับของสตริง ค่าเริ่มต้นคือ []
อนุญาตให้ไลบรารีนี้เข้าถึง /ที่กำหนด
add_opens ลำดับของสตริง ค่าเริ่มต้นคือ []
อนุญาตให้ไลบรารีนี้เข้าถึง /ที่กำหนด

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

คีย์ที่ใช้ในการเรียกข้อมูลผู้ให้บริการที่มีข้อมูลเกี่ยวกับรันไทม์ของ Java ที่ใช้อยู่

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

คีย์ที่ใช้ในการเรียกข้อมูลผู้ให้บริการที่มีข้อมูลเกี่ยวกับเครื่องมือเชน Java ที่ใช้อยู่

ผสาน

struct java_common.merge(providers)

รวมผู้ให้บริการที่ระบุเป็น JavaInfo เดียว

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
providers sequence ของ structs; ต้องระบุ
รายชื่อผู้ให้บริการที่จะรวม

pack_sources

File java_common.pack_sources(actions, *, output_jar=None, output_source_jar=None, sources=[], source_jars=[], java_toolchain, host_javabase=None)

แพ็กแหล่งที่มาและ Jar แหล่งที่มาลงในไฟล์ Jar แหล่งที่มาเดียว โดยทั่วไป ผลลัพธ์จะส่งไปที่

JavaInfo#source_jar

ต้องระบุพารามิเตอร์output_jar หรือ exit_source_jar อย่างน้อย 1 รายการ

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
actions actions; required
ctx.actions
output_jar ไฟล์ หรือ None ค่าเริ่มต้นคือ None
เลิกใช้งาน พารามิเตอร์นี้เลิกใช้งานแล้วและจะนำออกเร็วๆ นี้ โปรดอย่าพึ่งพา ถูกปิดใช้ด้วย --incompatible_java_common_parameters ใช้ธงนี้เพื่อยืนยันว่าโค้ดของคุณเข้ากันได้กับการนำออกในเร็วๆ นี้
เลิกใช้งานแล้ว: โถเอาต์พุตของกฎ ใช้เพื่อตั้งชื่อ Jar ต้นทางที่ได้ พารามิเตอร์จะตั้งพารามิเตอร์ audio_source_jar เป็น `{output_jar}-src.jar`.ใช้พารามิเตอร์ exit_source_jar โดยตรงแทน
output_source_jar ไฟล์ หรือ None ค่าเริ่มต้นคือ None
jar แหล่งที่มาของเอาต์พุต
sources ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
รายการไฟล์ต้นฉบับของ Java ที่จะแพ็กลงใน Jar ต้นทาง
source_jars ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
รายการ Jar แหล่งที่มาที่จะแพคข้อมูลลงใน Jar ต้นทาง
java_toolchain ข้อมูล ต้องระบุ
JavaToolchainInfo สำหรับค้นหาเครื่องมือ JAR
host_javabase ค่าเริ่มต้นคือ None
เลิกใช้งานแล้ว พารามิเตอร์นี้เลิกใช้งานแล้วและจะนำออกเร็วๆ นี้ โปรดอย่าพึ่งพา ถูกปิดใช้ด้วย --incompatible_java_common_parameters ใช้ธงนี้เพื่อยืนยันว่าโค้ดของคุณเข้ากันได้กับการนำออกในเร็วๆ นี้
เลิกใช้งาน: คุณวางพารามิเตอร์นี้ได้ (host_javabase มาพร้อมกับ java_toolchain)

run_ijar

File java_common.run_ijar(actions, *, jar, target_label=None, java_toolchain)

วิ่งเหยาะๆ บนโหล โดยปอกเปลือกมัน ซึ่งจะช่วยลดการสร้าง Jar อ้างอิงใหม่ในระหว่างการคอมไพล์ซ้ำซึ่งประกอบด้วยการเปลี่ยนแปลงง่ายๆ ในการใช้งานเมธอด โดยทั่วไปแล้ว ค่าการแสดงผลจะส่งต่อไปยัง JavaInfo#compile_jar

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
actions actions; required
ctx.actions
jar File; required
jar ที่จะเรียกใช้ Jar
target_label ป้ายกำกับ หรือ None ค่าเริ่มต้นคือ None
ป้ายกำกับเป้าหมายที่จะใช้ประทับโหล ใช้สำหรับการสนับสนุน add_dep โดยปกติแล้ว คุณจะต้องส่ง ctx.label เพื่อประทับตราโหลด้วยป้ายกำกับของกฎปัจจุบัน
java_toolchain ข้อมูล ต้องระบุ
JavaToolchainInfo สำหรับค้นหาเครื่องมือ JAR

stamp_jar

File java_common.stamp_jar(actions, *, jar, target_label, java_toolchain)

ประทับตราโหลที่มีป้ายกำกับเป้าหมายเพื่อรับการสนับสนุน add_dep โดยทั่วไปแล้ว ค่าการแสดงผลจะส่งต่อไปยัง JavaInfo#compile_jar ต้องการใช้ run_ijar เมื่อเป็นไปได้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
actions actions; required
ctx.actions
jar File; ต้องระบุ
jar ที่จะเรียกใช้ stamp_jar
target_label ป้ายกำกับ ต้องระบุ
ป้ายกำกับเป้าหมายที่จะใช้ประทับโหล ใช้สำหรับการสนับสนุน add_dep โดยปกติแล้ว คุณจะต้องส่ง ctx.label เพื่อประทับตราโหลด้วยป้ายกำกับของกฎปัจจุบัน
java_toolchain ข้อมูล ต้องระบุ
JavaToolchainInfo สำหรับค้นหาเครื่องมือ stamp_jar