หน้านี้มีทรัพยากรที่ช่วยให้คุณใช้ Bazel กับโปรเจ็กต์ Java ซึ่งลิงก์ไปยังบทแนะนำ สร้างกฎ และข้อมูลอื่นๆ ที่เกี่ยวข้องกับการสร้างโปรเจ็กต์ Java ด้วย Bazel โดยเฉพาะ
การทำงานกับ Bazel
ทรัพยากรต่อไปนี้จะช่วยให้คุณทำงานกับ Bazel ในโปรเจ็กต์ Java ได้
การย้ายข้อมูลไปยัง Bazel
หากคุณสร้างโปรเจ็กต์ Java ด้วย Maven ให้ทําตามขั้นตอนในคู่มือการย้ายข้อมูลเพื่อเริ่มสร้างโปรเจ็กต์ Maven ด้วย Bazel
เวอร์ชัน Java
Java ที่เกี่ยวข้องมี 2 เวอร์ชันซึ่งมีการตั้งค่าแฟล็กการกำหนดค่า ดังนี้
- เวอร์ชันของไฟล์ต้นฉบับในที่เก็บ
- เวอร์ชันของรันไทม์ของ Java ซึ่งใช้เพื่อเรียกใช้โค้ดและทดสอบ
การกำหนดค่าเวอร์ชันของซอร์สโค้ดในที่เก็บของคุณ
ถ้าไม่มีการกำหนดค่าเพิ่มเติม Bazel จะถือว่าไฟล์ซอร์สของ Java ทั้งหมดในที่เก็บเขียนด้วย Java เวอร์ชันเดียว หากต้องการระบุเวอร์ชันของแหล่งที่มาในที่เก็บ ให้เพิ่มไฟล์ build --java_language_version={ver}
ไปยังไฟล์ .bazelrc
โดยที่ {ver}
เป็นตัวอย่าง 11
เจ้าของที่เก็บ Bazel ควรตั้งค่าแฟล็กนี้เพื่อให้ Bazel และผู้ใช้อ้างอิงหมายเลขเวอร์ชัน Java ของซอร์สโค้ดได้ ดูรายละเอียดเพิ่มเติมได้ที่แฟล็กเวอร์ชันภาษา Java
การกำหนดค่า JVM ที่ใช้เพื่อเรียกใช้และทดสอบโค้ด
Bazel ใช้ JDK 1 ตัวสำหรับการคอมไพล์ และอีก JVM ตัวหนึ่งเพื่อเรียกใช้และทดสอบโค้ด
โดยค่าเริ่มต้น Bazel จะรวบรวมโค้ดโดยใช้ JDK จะดาวน์โหลด และจะดำเนินการและทดสอบโค้ดกับ JVM ที่ติดตั้งในเครื่อง Bazel ค้นหา JVM โดยใช้ JAVA_HOME
หรือเส้นทาง
ไบนารีที่ได้จะเข้ากันได้กับ JVM ที่ติดตั้งในเครื่องในไลบรารีของระบบ ซึ่งหมายความว่าไบนารีที่ได้จะขึ้นอยู่กับสิ่งที่ติดตั้งบนเครื่อง
หากต้องการกำหนดค่า JVM ที่ใช้สำหรับการดำเนินการและการทดสอบ ให้ใช้ Flag --java_runtime_version
ค่าเริ่มต้นคือ local_jdk
การทดสอบและการรวบรวมเนื้อหาแบบสัญชาตญาณ
หากต้องการสร้างคอมไพล์แบบต่อเนื่อง ให้ใช้แฟล็กบรรทัดคำสั่ง --java_runtime_version=remotejdk_11
ระบบจะคอมไพล์โค้ด ดำเนินการ และทดสอบใน JVM ที่ดาวน์โหลดจากที่เก็บระยะไกล ดูรายละเอียดเพิ่มเติมได้ที่แฟล็กเวอร์ชันรันไทม์ของ Java
การกำหนดค่าการคอมไพล์และการดำเนินการของเครื่องมือบิลด์ใน Java
มี JDK และ JVM คู่ที่ 2 ที่ใช้ในการสร้างและใช้งานเครื่องมือ ซึ่งใช้ในกระบวนการบิลด์ แต่ไม่อยู่ในผลลัพธ์ของบิลด์ JDK และ JVM นั้นควบคุมโดยใช้ --tool_java_language_version
และ --tool_java_runtime_version
ค่าเริ่มต้นคือ 11
และ remotejdk_11
ตามลําดับ
การคอมไพล์โดยใช้ JDK ที่ติดตั้งไว้ในเครื่อง
โดยค่าเริ่มต้น Bazel จะรวบรวมโดยใช้ JDK ระยะไกลเพราะจะลบล้างภายในของ JDK ระบบจะกำหนดค่าชุดเครื่องมือคอมไพล์โดยใช้ JDK ที่ติดตั้งไว้ในเครื่อง แต่ไม่มีการใช้งาน
หากต้องการคอมไพล์โดยใช้ JDK ที่ติดตั้งในเครื่อง ซึ่งใช้เครื่องมือการคอมไพล์สำหรับ JDK ในเครื่อง ให้ใช้ Flag --extra_toolchains=@local_jdk//:all
เพิ่มเติม แต่โปรดทราบว่าการดำเนินการนี้อาจใช้ไม่ได้กับ JDK ของผู้ให้บริการที่กำหนดเอง
ดูรายละเอียดเพิ่มเติมได้ที่การกำหนดค่า Java Toolchains
แนวทางปฏิบัติแนะนำ
นอกเหนือจากแนวทางปฏิบัติแนะนำทั่วไปของ Bazel แล้ว ด้านล่างคือแนวทางปฏิบัติแนะนำสำหรับโปรเจ็กต์ Java โดยเฉพาะ
โครงสร้างไดเรกทอรี
เลือกใช้เลย์เอาต์ไดเรกทอรีมาตรฐานของ Maven (แหล่งที่มาภายใต้ src/main/java
การทดสอบใน src/test/java
)
สร้างไฟล์
ปฏิบัติตามหลักเกณฑ์ต่อไปนี้เมื่อสร้างไฟล์ BUILD
ใช้ไฟล์
BUILD
1 ไฟล์ต่อไดเรกทอรีที่มีแหล่งที่มาของ Java เพราะจะช่วยปรับปรุงประสิทธิภาพของบิลด์ไฟล์
BUILD
ทุกไฟล์ควรมีกฎjava_library
1 ข้อที่มีลักษณะเช่นนี้java_library( name = "directory-name", srcs = glob(["*.java"]), deps = [...], )
ชื่อไลบรารีควรเป็นชื่อของไดเรกทอรีที่มีไฟล์
BUILD
ทําให้ป้ายกำกับของไลบรารีสั้นลง ซึ่งใช้"//package"
แทน"//package:package"
แหล่งที่มาควรเป็น
glob
แบบไม่เกิดซ้ำของไฟล์ Java ทั้งหมดในไดเรกทอรีการทดสอบควรอยู่ในไดเรกทอรีที่ตรงกันใน
src/test
และขึ้นอยู่กับไลบรารีนี้
การสร้างกฎใหม่สำหรับบิลด์ Java ขั้นสูง
หมายเหตุ: การสร้างกฎใหม่มีไว้สําหรับสถานการณ์บิลด์และทดสอบขั้นสูง คุณไม่จำเป็น เมื่อเริ่มต้นใช้งาน Bazel
โมดูล ส่วนย่อยของการกำหนดค่า และผู้ให้บริการต่อไปนี้จะช่วยคุณขยายความสามารถของ Bazel เมื่อสร้างโปรเจ็กต์ Java
- ผู้ให้บริการ Java หลัก:
java_common
- โมดูล Java หลัก:
JavaInfo
- ส่วนย่อยการกำหนดค่า:
java
โมดูลอื่นๆ:
การกำหนดค่า Java Toolchain
Bazel ใช้ Toolchain ของ Java 2 ประเภท ได้แก่
- การดำเนินการ, ใช้เพื่อดำเนินการและทดสอบไบนารีของ Java, ควบคุมด้วย
Flag --java_runtime_version
- การคอมไพล์ ซึ่งใช้เพื่อคอมไพล์ต้นทางของ Java ควบคุมด้วย --java_language_version
Flag
การกำหนดค่า Toolchain สำหรับการดำเนินการเพิ่มเติม
เครื่องมือเชนการดำเนินการคือ JVM ทั้งในเครื่องหรือจากที่เก็บ ซึ่งมีข้อมูลเพิ่มเติมบางส่วนเกี่ยวกับเวอร์ชัน ระบบปฏิบัติการ และสถาปัตยกรรม CPU
อาจเพิ่ม Toolchain สำหรับการดำเนินการของ Java โดยใช้กฎ local_java_repository
หรือ remote_java_repository
ในไฟล์ WORKSPACE
การเพิ่มกฎทำให้ JVM
พร้อมใช้งานโดยใช้แฟล็ก เมื่อมีการระบุคำจำกัดความหลายรายการสำหรับระบบปฏิบัติการและสถาปัตยกรรม CPU เดียวกัน ระบบจะใช้คำจำกัดความแรก
ตัวอย่างการกำหนดค่าของ JVM ในพื้นที่
load("@bazel_tools//tools/jdk:local_java_repository.bzl", "local_java_repository")
local_java_repository(
name = "additionaljdk", # Can be used with --java_runtime_version=additionaljdk, --java_runtime_version=11 or --java_runtime_version=additionaljdk_11
version = 11, # Optional, if not set it is autodetected
java_home = "/usr/lib/jdk-15/", # Path to directory containing bin/java
)
ตัวอย่างการกำหนดค่าของ JVM ระยะไกล
load("@bazel_tools//tools/jdk:remote_java_repository.bzl", "remote_java_repository")
remote_java_repository(
name = "openjdk_canary_linux_arm",
prefix = "openjdk_canary", # Can be used with --java_runtime_version=openjdk_canary_11
version = "11", # or --java_runtime_version=11
target_compatible_with = [ # Specifies constraints this JVM is compatible with "@platforms//cpu:arm",
"@platforms//os:linux",
],
urls = ..., # Other parameters are from http_repository rule.
sha256 = ...,
strip_prefix = ...
)
การกำหนดค่า Toolchain การคอมไพล์เพิ่มเติม
เครื่องมือการคอมไพล์ประกอบด้วย JDK และเครื่องมือมากมายที่ Bazel ใช้ในระหว่างการคอมไพล์และมีฟีเจอร์เพิ่มเติม เช่น ข้อผิดพลาด "ข้อผิดพลาดได้ง่าย" การพึ่งพา Java ที่เข้มงวด การคอมไพล์ส่วนหัว การนำน้ำตาลออกของ Android การใช้เครื่องมือที่ครอบคลุม และการจัดการ Genclass สำหรับ IDE
JavaBuilder เป็นเครื่องมือที่มาพร้อมกับ Bazel ที่ทำการคอมไพล์และให้บริการคุณลักษณะที่กล่าวถึงข้างต้น การคอมไพล์จริงดำเนินการโดยใช้คอมไพเลอร์ภายในโดย JDK JDK ที่ใช้สำหรับการคอมไพล์จะระบุโดยแอตทริบิวต์ java_runtime
ของ Toolchain
Bazel จะลบล้างภายในของ JDK บางส่วน ในกรณีของ JDK เวอร์ชัน > 9 ระบบจะแพตช์โมดูล java.compiler
และ jdk.compiler
โดยใช้แฟล็กของ JDK --patch_module
ในกรณีของ JDK เวอร์ชัน 8 ระบบจะแพตช์คอมไพเลอร์ Java โดยใช้ Flag -Xbootclasspath
VanillaJavaBuilder เป็นการใช้งาน JavaBuilder ครั้งที่ 2 ซึ่งไม่ได้ปรับเปลี่ยนคอมไพเลอร์ภายในของ JDK และไม่มีฟีเจอร์เพิ่มเติม เครื่องมือเชนในตัวไม่ได้ใช้ VanillaJavaBuilder
นอกเหนือจาก JavaBuilder แล้ว Bazel ยังใช้เครื่องมืออื่นๆ อีกหลายอย่างในระหว่างการคอมไพล์
เครื่องมือ ijar
จะประมวลผลไฟล์ jar
รายการเพื่อนำทุกอย่างออก ยกเว้นลายเซ็นการโทร โหลที่ได้จะเรียกว่าไจส่วนหัว ซึ่งใช้เพื่อปรับปรุงส่วนเพิ่มของการคอมไพล์โดยการรวบรวมการอ้างอิงดาวน์สตรีมอีกครั้งเมื่อเนื้อหาของฟังก์ชันมีการเปลี่ยนแปลงเท่านั้น
เครื่องมือ singlejar
จะรวมไฟล์ jar
หลายไฟล์เข้าด้วยกันเป็นไฟล์เดียว
เครื่องมือ genclass
จะประมวลผลเอาต์พุตของการคอมไพล์ Java ในภายหลัง และสร้าง jar
ที่มีเฉพาะไฟล์คลาสสำหรับแหล่งที่มาที่สร้างโดยตัวประมวลผลคำอธิบายประกอบ
เครื่องมือ JacocoRunner
จะเรียกใช้ Jacoco กับไฟล์ที่มีเครื่องมือและเอาต์พุตผลลัพธ์ในรูปแบบ LCOV
เครื่องมือ TestRunner
จะทดสอบ JUnit 4 ในสภาพแวดล้อมที่มีการควบคุม
คุณกำหนดค่าการคอมไพล์อีกครั้งได้โดยเพิ่มมาโคร default_java_toolchain
ลงในไฟล์ BUILD
และลงทะเบียนไฟล์ดังกล่าวโดยการเพิ่มกฎ register_toolchains
ลงในไฟล์ WORKSPACE
หรือใช้แฟล็ก --extra_toolchains
จะใช้ Toolchain ได้ก็ต่อเมื่อแอตทริบิวต์ source_version
ตรงกับค่าที่ระบุโดย Flag --java_language_version
ตัวอย่างการกำหนดค่า Toolchain
load(
"@bazel_tools//tools/jdk:default_java_toolchain.bzl",
"default_java_toolchain", "DEFAULT_TOOLCHAIN_CONFIGURATION", "BASE_JDK9_JVM_OPTS", "DEFAULT_JAVACOPTS"
)
default_java_toolchain(
name = "repository_default_toolchain",
configuration = DEFAULT_TOOLCHAIN_CONFIGURATION, # One of predefined configurations
# Other parameters are from java_toolchain rule:
java_runtime = "@bazel_tools//tools/jdk:remote_jdk11", # JDK to use for compilation and toolchain's tools execution
jvm_opts = BASE_JDK9_JVM_OPTS + ["--enable_preview"], # Additional JDK options
javacopts = DEFAULT_JAVACOPTS + ["--enable_preview"], # Additional javac options
source_version = "9",
)
ซึ่งจะใช้ด้วย --extra_toolchains=//:repository_default_toolchain_definition
หรือโดยการเพิ่ม register_toolchains("//:repository_default_toolchain_definition")
ลงในพื้นที่ทำงาน
การกำหนดค่าที่กำหนดไว้ล่วงหน้า
DEFAULT_TOOLCHAIN_CONFIGURATION
: ฟีเจอร์ทั้งหมด รองรับ JDK เวอร์ชัน >= 9VANILLA_TOOLCHAIN_CONFIGURATION
: ไม่มีฟีเจอร์เพิ่มเติม รองรับ JDK ของผู้ให้บริการที่กำหนดเองPREBUILT_TOOLCHAIN_CONFIGURATION
: เหมือนกับค่าเริ่มต้น แต่ใช้เฉพาะเครื่องมือที่สร้างไว้ล่วงหน้าเท่านั้น (ijar
,singlejar
)NONPREBUILT_TOOLCHAIN_CONFIGURATION
: เหมือนกับค่าเริ่มต้น แต่เครื่องมือทั้งหมดสร้างขึ้นจากแหล่งที่มา (ซึ่งอาจเป็นประโยชน์ในระบบปฏิบัติการที่มี libc ต่างกัน)
การกำหนดค่าแฟล็ก JVM และ Java คอมไพเลอร์
คุณกำหนดค่า Flag JVM และ Javac ด้วยแฟล็กหรือแอตทริบิวต์ default_java_toolchain
ได้
แฟล็กที่เกี่ยวข้องคือ --jvmopt
, --host_jvmopt
, --javacopt
และ
--host_javacopt
แอตทริบิวต์ default_java_toolchain
ที่เกี่ยวข้อง ได้แก่ javacopts
, jvm_opts
,
javabuilder_jvm_opts
และ turbine_jvm_opts
การกำหนดค่าแฟล็ก Java คอมไพเลอร์เฉพาะแพ็กเกจ
คุณกำหนดค่าแฟล็ก Java คอมไพเลอร์ที่แตกต่างกันสำหรับไฟล์ต้นทางที่เจาะจงได้โดยใช้แอตทริบิวต์ package_configuration
ของ default_java_toolchain
โปรดดูตัวอย่างด้านล่าง
load("@bazel_tools//tools/jdk:default_java_toolchain.bzl", "default_java_toolchain")
# This is a convenience macro that inherits values from Bazel's default java_toolchain
default_java_toolchain(
name = "toolchain",
package_configuration = [
":error_prone",
],
visibility = ["//visibility:public"],
)
# This associates a set of javac flags with a set of packages
java_package_configuration(
name = "error_prone",
javacopts = [
"-Xep:MissingOverride:ERROR",
],
packages = ["error_prone_packages"],
)
# This is a regular package_group, which is used to specify a set of packages to apply flags to
package_group(
name = "error_prone_packages",
packages = [
"//foo/...",
"-//foo/bar/...", # this is an exclusion
],
)
ซอร์สโค้ด Java หลายเวอร์ชันในที่เก็บเดียว
Bazel รองรับการคอมไพล์แหล่งที่มาของ Java เวอร์ชันเดียวในบิลด์เท่านั้น ซึ่งหมายความว่าเมื่อสร้างการทดสอบ Java หรือแอปพลิเคชัน ระบบจะสร้างทรัพยากร Dependency ทั้งหมดโดยเทียบกับ Java เวอร์ชันเดียวกัน
อย่างไรก็ตาม บิลด์ที่แยกกันอาจดำเนินการโดยใช้ Flag ที่แตกต่างกัน
เพื่อให้ใช้งานแฟล็กต่างๆ ได้ง่ายขึ้น เราอาจจัดกลุ่มชุดของแฟล็กสำหรับเวอร์ชันที่เจาะจงโดยใช้การกำหนดค่า .bazelrc
"
build:java8 --java_language_version=8
build:java8 --java_runtime_version=localjdk_8
build:java11 --java_language_version=11
build:java11 --java_runtime_version=remotejdk_11
การกำหนดค่าเหล่านี้ใช้ร่วมกับแฟล็ก --config
ได้ เช่น bazel test --config=java11 //:java11_test