ชวาและบาเซล

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

หน้านี้มีทรัพยากรที่ช่วยให้คุณใช้ Bazel กับโปรเจ็กต์ Java ซึ่งลิงก์ไปยังบทแนะนำ กฎการสร้าง และข้อมูลอื่นๆ สำหรับการสร้างโปรเจ็กต์ Java ด้วย Bazel โดยเฉพาะ

การทำงานกับ Bazel

แหล่งข้อมูลต่อไปนี้จะช่วยคุณใช้งาน Bazel ในโปรเจ็กต์ Java

การย้ายข้อมูลไปยัง Bazel

หากปัจจุบันคุณสร้างโปรเจ็กต์ Java ด้วย Maven ให้ทำตามขั้นตอนในคำแนะนำการย้ายข้อมูลเพื่อเริ่มสร้างโปรเจ็กต์ Maven ด้วย Bazel

เวอร์ชัน Java

Java เวอร์ชันที่เกี่ยวข้องซึ่งตั้งค่าด้วย Flag การกําหนดค่ามี 2 เวอร์ชัน ได้แก่

  • เวอร์ชันของไฟล์ต้นฉบับในที่เก็บ
  • เวอร์ชันรันไทม์ Java ที่ใช้ในการเรียกใช้โค้ดและทดสอบ

การกำหนดค่าเวอร์ชันของซอร์สโค้ดในที่เก็บของคุณ

หากไม่มีการกําหนดค่าเพิ่มเติม Bazel จะถือว่าไฟล์ซอร์สโค้ด Java ทั้งหมดในที่เก็บข้อมูลเขียนด้วย Java เวอร์ชันเดียว หากต้องการระบุเวอร์ชันของแหล่งที่มาในที่เก็บ ให้เพิ่ม build --java_language_version={ver} ลงในไฟล์ .bazelrc โดยที่ {ver} จะเป็นค่าอย่างเช่น 11 เจ้าของที่เก็บ Bazel ควรตั้งค่า Flag นี้เพื่อให้ Bazel และผู้ใช้อ้างอิงหมายเลขเวอร์ชัน Java ของซอร์สโค้ดได้ ดูรายละเอียดเพิ่มเติมได้ที่Flag เวอร์ชันภาษา Java

การกำหนดค่า JVM ที่ใช้เรียกใช้และทดสอบโค้ด

Bazel ใช้ JDK 1 ตัวสําหรับการคอมไพล์และ JVM อีก 1 ตัวเพื่อเรียกใช้และทดสอบโค้ด

โดยค่าเริ่มต้น Bazel จะคอมไพล์โค้ดโดยใช้ JDK ที่ดาวน์โหลดมา จากนั้นจะเรียกใช้และทดสอบโค้ดด้วย JVM ที่ติดตั้งในเครื่อง Bazel จะค้นหา JVM โดยใช้ JAVA_HOME หรือเส้นทาง

ไบนารีที่ได้จะเข้ากันได้กับ JVM ที่ติดตั้งในเครื่องในไลบรารีของระบบ ซึ่งหมายความว่าไบนารีที่ได้จะขึ้นอยู่กับสิ่งที่ติดตั้งบนเครื่อง

หากต้องการกำหนดค่า JVM ที่ใช้สำหรับการดำเนินการและการทดสอบ ให้ใช้--java_runtime_version flag ค่าเริ่มต้นคือ local_jdk

การทดสอบและการรวบรวมเนื้อหาแบบสัญชาตญาณ

หากต้องการสร้างการคอมไพล์แบบปิดผนึก คุณสามารถใช้ Flag บรรทัดคำสั่ง --java_runtime_version=remotejdk_11 ระบบจะคอมไพล์ เรียกใช้ และทดสอบโค้ดใน JVM ที่ดาวน์โหลดมาจากที่เก็บระยะไกล ดูรายละเอียดเพิ่มเติมได้ที่Flag เวอร์ชันรันไทม์ของ Java

การกําหนดค่าการคอมไพล์และการดำเนินการของเครื่องมือสร้างใน Java

มี JDK และ JVM คู่ที่ 2 ที่ใช้สร้างและเรียกใช้เครื่องมือ ซึ่งใช้ในกระบวนการสร้าง แต่ไม่อยู่ในผลลัพธ์การสร้าง JDK และ JVM ดังกล่าวจะควบคุมโดยใช้ --tool_java_language_version และ --tool_java_runtime_version ค่าเริ่มต้นคือ 11 และ remotejdk_11 ตามลำดับ

การคอมไพล์โดยใช้ JDK ที่ติดตั้งในเครื่อง

โดยค่าเริ่มต้น Bazel จะคอมไพล์โดยใช้ JDK ระยะไกล เนื่องจากมีการลบล้างข้อมูลภายในของ JDK ระบบจะกำหนดค่า Toolchain สำหรับการคอมไพล์โดยใช้ JDK ที่ติดตั้งไว้ในเครื่อง แต่ไม่มีการใช้งาน

หากต้องการคอมไพล์โดยใช้ JDK ที่ติดตั้งในเครื่อง ซึ่งใช้เครื่องมือการคอมไพล์สำหรับ JDK ในเครื่อง ให้ใช้ Flag --extra_toolchains=@local_jdk//:all เพิ่มเติม แต่โปรดทราบว่าการดำเนินการนี้อาจใช้ไม่ได้กับ JDK ของผู้ให้บริการที่กำหนดเอง

ดูรายละเอียดเพิ่มเติมได้ที่การกำหนดค่าชุดเครื่องมือ Java

แนวทางปฏิบัติแนะนำ

นอกจากแนวทางปฏิบัติแนะนำทั่วไปของ Bazel แล้ว ด้านล่างนี้คือแนวทางปฏิบัติแนะนำสำหรับโปรเจ็กต์ Java โดยเฉพาะ

โครงสร้างไดเรกทอรี

โปรดใช้เลย์เอาต์ไดเรกทอรีมาตรฐานของ Maven (sources อยู่ภายใต้ src/main/java, tests อยู่ภายใต้ 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 Toolchain

Bazel ใช้เครื่องมือทางภาษา Java 2 ประเภท ได้แก่ - การดำเนินการ ซึ่งใช้เพื่อเรียกใช้และทดสอบไบนารี Java โดยควบคุมด้วยตัวเลือก --java_runtime_version - การคอมไพล์ ซึ่งใช้เพื่อคอมไพล์ซอร์สโค้ด Java โดยควบคุมด้วยตัวเลือก --java_language_version

การกําหนดค่าเครื่องมือทางเทคนิคการดําเนินการเพิ่มเติม

เครื่องมือเชนการดำเนินการคือ JVM ทั้งในเครื่องหรือจากที่เก็บ ซึ่งมีข้อมูลเพิ่มเติมบางส่วนเกี่ยวกับเวอร์ชัน ระบบปฏิบัติการ และสถาปัตยกรรม CPU

คุณเพิ่มเครื่องมือทางเทคนิคสำหรับการเรียกใช้ Java ได้โดยใช้กฎ local_java_repository หรือ remote_java_repository ในไฟล์ WORKSPACE การเพิ่มกฎจะทำให้ JVM พร้อมใช้งานโดยใช้ Flag เมื่อมีการระบุคำจำกัดความหลายรายการสำหรับระบบปฏิบัติการและสถาปัตยกรรม 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 = ...
)

การกำหนดค่าเครื่องมือรวบรวมเพิ่มเติม

เครื่องมือรวบรวมประกอบด้วย JDK และเครื่องมือหลายรายการที่ Bazel ใช้ระหว่างการคอมไพล์ รวมถึงมีฟีเจอร์เพิ่มเติม เช่น การตรวจหาข้อผิดพลาด Dependency ของ Java ที่เข้มงวด การคอมไพล์ส่วนหัว การถอด Sugar ของ Android เครื่องมือวัดการครอบคลุม และการจัดการ genclass สำหรับ IDE

JavaBuilder เป็นเครื่องมือที่มาพร้อมกับ Bazel ซึ่งจะดำเนินการคอมไพล์และให้ฟีเจอร์ที่กล่าวถึงข้างต้น JDK จะดำเนินการคอมไพล์จริงโดยใช้คอมไพเลอร์ภายใน JDK ที่ใช้คอมไพล์จะระบุโดยjava_runtime แอตทริบิวต์ของเครื่องมือทํางาน

Bazel จะลบล้างข้อมูลภายในของ JDK บางรายการ ในกรณีที่ JDK เป็นเวอร์ชันที่มากกว่า 9 ระบบจะแพตช์โมดูล java.compiler และ jdk.compiler โดยใช้ Flag ของ JDK --patch_module ในกรณีของ JDK เวอร์ชัน 8 ระบบจะแพตช์คอมไพเลอร์ Java โดยใช้ Flag -Xbootclasspath

VanillaJavaBuilder เป็นการใช้งาน JavaBuilder ครั้งที่สอง ซึ่งจะไม่แก้ไขคอมไพเลอร์ภายในของ JDK และไม่มีฟีเจอร์เพิ่มเติมใดๆ ไม่มีเครื่องมือทํางานใดๆ ในตัวที่ใช้ VanillaJavaBuilder

นอกจาก JavaBuilder แล้ว Bazel ยังใช้เครื่องมืออื่นๆ อีกหลายอย่างในระหว่างการคอมไพล์

เครื่องมือ ijar จะประมวลผลไฟล์ jar รายการเพื่อนำทุกอย่างออก ยกเว้นลายเซ็นการโทร ไฟล์ jar ที่เป็นผลลัพธ์เรียกว่าไฟล์ jar ส่วนหัว ซึ่งใช้เพื่อปรับปรุงส่วนเพิ่มของการคอมไพล์โดยการรวบรวมการอ้างอิงดาวน์สตรีมอีกครั้งเมื่อเนื้อหาของฟังก์ชันมีการเปลี่ยนแปลงเท่านั้น

เครื่องมือ singlejar จะรวมไฟล์ jar หลายไฟล์เข้าด้วยกันเป็นไฟล์เดียว

เครื่องมือ genclass จะประมวลผลผลลัพธ์ของการคอมไพล์ Java ในขั้นตอนหลัง และสร้าง jar ที่มีเฉพาะไฟล์คลาสสำหรับแหล่งที่มาที่คอมไพล์โดยโปรแกรมประมวลผลคำอธิบายประกอบ

เครื่องมือ JacocoRunner จะเรียกใช้ Jacoco ในไฟล์ที่มีเครื่องมือวัดผลและแสดงผลลัพธ์ในรูปแบบ LCOV

เครื่องมือ TestRunner จะทำการทดสอบ JUnit 4 ในสภาพแวดล้อมที่มีการควบคุม

คุณกำหนดค่าการคอมไพล์อีกครั้งได้โดยเพิ่มมาโคร default_java_toolchain ลงในไฟล์ BUILD และลงทะเบียนไฟล์ดังกล่าวโดยการเพิ่มกฎ register_toolchains ลงในไฟล์ WORKSPACE หรือใช้แฟล็ก --extra_toolchains

ระบบจะใช้ชุดเครื่องมือนี้เฉพาะเมื่อแอตทริบิวต์ source_version ตรงกับค่าที่ระบุโดย Flag --java_language_version

ตัวอย่างการกำหนดค่าเครื่องมือมีดังนี้

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 เวอร์ชัน >= 9
  • VANILLA_TOOLCHAIN_CONFIGURATION: ไม่มีฟีเจอร์เพิ่มเติม รองรับ JDK ของผู้ให้บริการตามต้องการ
  • PREBUILT_TOOLCHAIN_CONFIGURATION: เหมือนกับค่าเริ่มต้น แต่ใช้เฉพาะเครื่องมือที่สร้างไว้ล่วงหน้าเท่านั้น (ijar, singlejar)
  • NONPREBUILT_TOOLCHAIN_CONFIGURATION: เหมือนกับค่าเริ่มต้น แต่เครื่องมือทั้งหมดสร้างขึ้นจากแหล่งที่มา (ซึ่งอาจเป็นประโยชน์ในระบบปฏิบัติการที่มี libc ต่างกัน)

การกำหนดค่าแฟล็ก JVM และคอมไพเลอร์ Java

คุณสามารถกำหนดค่า Flag ของ JVM และ javac โดยใช้ Flag หรือแอตทริบิวต์ default_java_toolchain

Flag ที่เกี่ยวข้องคือ --jvmopt, --host_jvmopt, --javacopt และ --host_javacopt

แอตทริบิวต์ default_java_toolchain ที่เกี่ยวข้องคือ javacopts, jvm_opts, javabuilder_jvm_opts และ turbine_jvm_opts

การกําหนดค่า Flag คอมไพเลอร์ Java สําหรับแพ็กเกจที่เฉพาะเจาะจง

คุณสามารถกําหนดค่า Flag ต่างๆ ของคอมไพเลอร์ 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 ระบบจะสร้างข้อกําหนดทั้งหมดกับ Java เวอร์ชันเดียวกัน

อย่างไรก็ตาม บิลด์ที่แยกกันอาจดำเนินการโดยใช้ Flag ที่แตกต่างกัน

ชุด Flag สําหรับเวอร์ชันที่เฉพาะเจาะจงอาจจัดกลุ่มกับ.bazelrcการกําหนดค่า" เพื่อให้ใช้งาน Flag ต่างๆ ได้ง่ายขึ้น

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

การกำหนดค่าเหล่านี้สามารถใช้กับ Flag --config ได้ เช่น bazel test --config=java11 //:java11_test