java_general

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

สมาชิก

BootClassPathInfo

Provider java_common.BootClassPathInfo

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

compile

JavaInfo 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, 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 ต้องระบุ
บริบทของกฎ
source_jars sequence of Files; default = []
รายการ Jars ที่จะรวม ควรระบุ source_jars หรือ source_files อย่างน้อย 1 ไฟล์
source_files sequence of Files; default = []
รายการไฟล์ต้นฉบับ Java ที่จะรวบรวม ควรระบุ source_jars หรือ source_files อย่างน้อย 1 ไฟล์
output ต้องระบุ
output_source_jar File; or None; ค่าเริ่มต้น = ไม่มี
Jar แหล่งที่มาของเอาต์พุต ไม่บังคับ ค่าเริ่มต้นจะเป็น "{output_jar}-src.jar" หากไม่ได้ตั้งค่าไว้
javac_opts sequence of strings; default = []
รายการตัวเลือก JavaScript ที่ต้องการ ไม่บังคับ
deps sequence of JavaInfos; ค่าเริ่มต้น = []
รายการทรัพยากร Dependency ไม่บังคับ
runtime_deps sequence of JavaInfos; ค่าเริ่มต้น = []
รายการทรัพยากร Dependency ของรันไทม์ ไม่บังคับ
exports sequence of JavaInfos; ค่าเริ่มต้น = []
รายการการส่งออก ไม่บังคับ
plugins sequence of JavaPluginInfos; or sequence of JavaInfos; default = []
รายการปลั๊กอิน ไม่บังคับ
exported_plugins sequence of JavaPluginInfos; or sequence of JavaInfos; default = []
รายการปลั๊กอินที่ส่งออก ไม่บังคับ
native_libraries sequence of CcInfos; ค่าเริ่มต้น = []
สำเนาถึงทรัพยากร Dependency ของไลบรารีเนทีฟที่จำเป็นสำหรับไลบรารีนี้
annotation_processor_additional_inputs sequence of Files; default = []
รายการอินพุตที่การดำเนินการคอมไพล์ Java จะใช้เพิ่มเติมจากแหล่งที่มาของ Java สำหรับการประมวลผลคำอธิบายประกอบ
annotation_processor_additional_outputs sequence of Files; ค่าเริ่มต้น = []
รายการเอาต์พุตที่การดำเนินการคอมไพล์ Java จะแสดงเพิ่มเติมจากคลาส Jar จากการประมวลผลคำอธิบายประกอบ
strict_deps ค่าเริ่มต้น = 'ERROR'
สตริงที่ระบุวิธีจัดการ Deps แบบเข้มงวด ค่าที่เป็นไปได้ ได้แก่ "OFF", "ERROR", "WARN" และ "DEFAULT" ดูรายละเอียดเพิ่มเติมได้ที่ /docs/user-manual#flag--strict_java_deps โดยค่าเริ่มต้น "ERROR"
java_toolchain จำเป็น
JavaToolchainInfo ที่จะใช้สำหรับการคอมไพล์นี้ บังคับ
host_javabase default = ไม่มี
เลิกใช้งานแล้ว พารามิเตอร์นี้เลิกใช้งานแล้วและจะถูกนำออกเร็วๆ นี้ โปรดอย่าพึ่งพาสิ่งนี้ ถูกปิดใช้กับ --+incompatible_java_common_parameters ใช้แฟล็กนี้เพื่อยืนยันว่าโค้ดเข้ากันได้กับการนําออกที่กำลังจะเกิดขึ้น
เลิกใช้งาน: คุณสามารถทิ้งพารามิเตอร์นี้ได้ (host_javabase มาพร้อมกับ java_toolchain)
sourcepath sequence of Files; ค่าเริ่มต้น = []
resources sequence of Files; ค่าเริ่มต้น = []
resource_jars sequence of Files; ค่าเริ่มต้น = []
classpath_resources sequence of Files; ค่าเริ่มต้น = []
ค่าเริ่มต้น = เท็จ
enable_annotation_processing default = True
ปิดใช้การประมวลผลคำอธิบายประกอบในการคอมไพล์นี้ ซึ่งทำให้ละเว้นตัวประมวลผลคำอธิบายประกอบที่มีอยู่ในปลั๊กอินหรือใน export_plugins ของ deps
enable_compile_jar_action default = True
เปิดใช้การคอมไพล์ส่วนหัวหรือการสร้าง Ijar หากตั้งค่าเป็น "เท็จ" ระบบจะบังคับให้ใช้ jar คลาสแบบเต็มในคลาสพาธการคอมไพล์ของทรัพยากร Dependency การดำเนินการดังกล่าวมีไว้เพื่อใช้โดยเป้าหมายที่ไม่ใช่ไลบรารี เช่น ไบนารีที่ไม่มีทรัพยากร Dependency
add_exports sequence of strings; default = []
อนุญาตให้ไลบรารีนี้เข้าถึง /ที่ระบุ ไม่บังคับ
add_opens sequence of strings; default = []
อนุญาตให้ไลบรารีนี้เข้าถึง /ที่ระบุได้ ไม่บังคับ

JavaPluginInfo

Provider java_common.JavaPluginInfo

คีย์ที่ใช้เพื่อเรียกข้อมูลผู้ให้บริการที่มีข้อมูลเกี่ยวกับปลั๊กอิน Java ค่านี้จะเข้าถึงได้เป็น JavaPluginInfo
ต้องการใช้ JavaPluginInfo ในรหัสใหม่

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

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

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

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

make_non_strict

JavaInfo java_common.make_non_strict(java_info)

แสดงผลผู้ให้บริการ Java ใหม่ที่มีส่วน Direct-jars เป็นการรวมของทั้ง Jar โดยตรงและโดยอ้อมของผู้ให้บริการ Java ที่ระบุ

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
java_info ต้องระบุ
ข้อมูล Java

ผสาน

JavaInfo java_common.merge(providers, *, merge_java_outputs=True, merge_source_jars=True)

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

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
providers sequence of JavaInfos ต้องระบุ
รายชื่อผู้ให้บริการที่จะรวม
merge_java_outputs ค่าเริ่มต้น = จริง
merge_source_jars ค่าเริ่มต้น = จริง

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

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

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
actions ต้องระบุ
ctx.actions
output_jar File; or None ค่าเริ่มต้น = ไม่มี
เลิกใช้งานแล้ว พารามิเตอร์นี้เลิกใช้งานแล้วและจะถูกนำออกเร็วๆ นี้ โปรดอย่าพึ่งพาสิ่งนี้ ถูกปิดใช้กับ --+incompatible_java_common_parameters ใช้แฟล็กนี้เพื่อยืนยันว่าโค้ดเข้ากันได้กับการนําออกที่กำลังจะเกิดขึ้น
เลิกใช้งานแล้ว: โหนดเอาต์พุตของกฎ ใช้เพื่อตั้งชื่อ jar ต้นทางที่ได้ พารามิเตอร์จะตั้งพารามิเตอร์ export_source_jar เป็น "{output_jar}-src.jar" แต่ให้ใช้พารามิเตอร์ export_source_jar แทน
output_source_jar File; or None; ค่าเริ่มต้น = ไม่มี
Jar แหล่งที่มาของเอาต์พุต
sources sequence of Files; default = []
รายการไฟล์ซอร์สของ Java ที่จะแพ็กลงใน Jar ต้นทาง
source_jars sequence of Files; ค่าเริ่มต้น = []
รายการของ Jar ต้นทางที่จะแพ็กลงใน Jar แหล่งที่มา
java_toolchain ต้องระบุ
JavaToolchainInfo สำหรับใช้ค้นหาเครื่องมือ Jar
host_javabase default = ไม่มี
เลิกใช้งานแล้ว พารามิเตอร์นี้เลิกใช้งานแล้วและจะถูกนำออกเร็วๆ นี้ โปรดอย่าพึ่งพาสิ่งนี้ ถูกปิดใช้กับ --+incompatible_java_common_parameters ใช้แฟล็กนี้เพื่อยืนยันว่าโค้ดเข้ากันได้กับการนําออกที่กำลังจะเกิดขึ้น
เลิกใช้งาน: คุณสามารถทิ้งพารามิเตอร์นี้ได้ (host_javabase มาพร้อมกับ java_toolchain)
อาจส่งคืน None

ผู้ให้บริการ

Provider java_common.provider

แสดงผลผู้ให้บริการที่ประกาศโดย Java
จะเข้าถึงค่าเดียวกับ JavaInfo ได้
ต้องการใช้ JavaInfo ในรหัสใหม่

run_ijar

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

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

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
actions ต้องระบุ
ctx.actions
jar ต้องระบุ
jar สำหรับเรียกใช้ Jar
target_label Label; or None; default = ไม่มี
ป้ายกำกับเป้าหมายที่จะประทับตราโอ่ง ใช้สำหรับการสนับสนุน 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 ต้องระบุ
ctx.actions
jar ต้องระบุ
โหลที่จะเรียกใช้ stamp_jar
target_label ต้องระบุ
ป้ายกำกับเป้าหมายที่จะประทับตราโอ่ง ใช้สำหรับการสนับสนุน add_dep โดยปกติแล้ว คุณจะต้องส่ง ctx.label เพื่อประทับตราโอ่งด้วยป้ายกำกับของกฎปัจจุบัน
java_toolchain ต้องระบุ
JavaToolchainInfo สำหรับใช้ค้นหาเครื่องมือ stamp_jar

to_java_binary_info

JavaInfo java_common.to_java_binary_info(java_info)

แสดงผลสำเนาของ JavaInfo ที่ระบุซึ่งมีข้อมูลน้อยที่สุดที่แสดงผลโดย java_binary

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
java_info จำเป็น
JavaInfo ที่ต้องการเพิ่มประสิทธิภาพ