Java और Bazel

किसी समस्या की शिकायत करें सोर्स देखें रात · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

इस पेज में ऐसे संसाधन हैं जो आपको Java प्रोजेक्ट के साथ Baज़ल का इस्तेमाल करने में मदद करते हैं. यह किसी ट्यूटोरियल, बिल्ड रूल, और अन्य जानकारी के लिए लिंक Basel के साथ Java प्रोजेक्ट.

Bazel का इस्तेमाल करना

नीचे दिए गए संसाधन, Java प्रोजेक्ट पर Baज़र के साथ काम करने में आपकी मदद करेंगे:

बेज़ल पर माइग्रेट किया जा रहा है

अगर आपने फ़िलहाल Maven की मदद से अपने Java प्रोजेक्ट बनाए हैं, तो यहां दिया गया तरीका अपनाएं Basel के साथ Maven प्रोजेक्ट बनाना शुरू करने के लिए, माइग्रेशन गाइड:

Java वर्शन

कॉन्फ़िगरेशन फ़्लैग के साथ सेट किए गए Java के दो सही वर्शन हैं:

  • डेटा स्टोर करने की जगह में सोर्स फ़ाइलों का वर्शन
  • Java रनटाइम का वर्शन, जिसका इस्तेमाल कोड को लागू करने और उसकी जांच करने के लिए किया जाता है

डेटा स्टोर करने की जगह में सोर्स कोड का वर्शन कॉन्फ़िगर करना

अतिरिक्त कॉन्फ़िगरेशन के बिना, Bazel यह मानता है कि रिपॉज़िटरी में मौजूद सभी Java सोर्स फ़ाइलें, एक ही Java वर्शन में लिखी गई हैं. इसका वर्शन तय करने के लिए रिपॉज़िटरी में मौजूद सोर्स में build --java_language_version={ver} को जोड़ें .bazelrc फ़ाइल, जहां {ver} है, उदाहरण के लिए 11. Bazel रिपॉज़िटरी के मालिकों को यह फ़्लैग सेट करना चाहिए, ताकि Bazel और उसके उपयोगकर्ता, सोर्स कोड के Java वर्शन नंबर का रेफ़रंस दे सकें. ज़्यादा जानकारी के लिए, यह देखें Java की भाषा के लिए वर्शन फ़्लैग.

कोड को एक्ज़ीक्यूट करने और उसकी जांच करने के लिए इस्तेमाल की जाने वाली जेवीएम को कॉन्फ़िगर करना

Basel, कंपाइलेशन के लिए एक JDK और दूसरे JVM का इस्तेमाल करके, कोड को एक्ज़ीक्यूट और टेस्ट करता है.

डिफ़ॉल्ट रूप से Basel एक JDK का इस्तेमाल करके कोड को कंपाइल करता है, वह डाउनलोड होता है, और एक्ज़ीक्यूट करता है और यह लोकल मशीन पर इंस्टॉल किए गए JVM की मदद से, कोड की जाँच करता है. बेज़ेल ने खोजा JAVA_HOME या पाथ का इस्तेमाल करके JVM.

इससे बनने वाली बाइनरी, सिस्टम में लोकल लेवल पर इंस्टॉल की गई JVM के साथ काम करती हैं लाइब्रेरी हैं, जिसका मतलब है कि बनने वाली बाइनरी इस बात पर निर्भर करती हैं कि लाइब्रेरी में क्या इंस्टॉल किया गया है मशीन.

एक्ज़ीक्यूशन और टेस्ट के लिए इस्तेमाल किए जाने वाले JVM को कॉन्फ़िगर करने के लिए, --java_runtime_version का इस्तेमाल करें फ़्लैग करें. डिफ़ॉल्ट वैल्यू local_jdk है.

हर्मेटिक टेस्टिंग और कंपाइलेशन

हर्मेटिक कंपाइल बनाने के लिए, कमांड लाइन फ़्लैग का इस्तेमाल करें --java_runtime_version=remotejdk_11. कोड को किसी रिमोट रिपॉज़िटरी से डाउनलोड किए गए जेवीएम के लिए, कॉम्पाइल किया जाता है, चलाया जाता है, और उसका परीक्षण किया जाता है. ज़्यादा जानकारी के लिए, यह देखें Java रनटाइम वर्शन फ़्लैग.

Java में बिल्ड टूल को कंपाइल करने और उसे एक्ज़ीक्यूट करने के लिए कॉन्फ़िगर करना

JDK और JVM की दूसरी जोड़ी का इस्तेमाल, टूल बनाने और उन्हें लागू करने के लिए किया जाता है. ये का इस्तेमाल बिल्ड प्रोसेस में किया गया है, लेकिन इनका इस्तेमाल बिल्ड के नतीजों में नहीं किया गया है. JDK और JVM को --tool_java_language_version और --tool_java_runtime_version का इस्तेमाल करके कंट्रोल किया जाता है. इनकी डिफ़ॉल्ट वैल्यू 11 और remotejdk_11 होती हैं.

स्थानीय तौर पर इंस्टॉल किए गए JDK का इस्तेमाल करके कंपाइल किया जा रहा है

Bazel, डिफ़ॉल्ट रूप से रिमोट JDK का इस्तेमाल करके कॉम्पाइल करता है, क्योंकि यह JDK के अंदरूनी हिस्सों को बदल रहा है. स्थानीय तौर पर इंस्टॉल किए गए JDK का इस्तेमाल करने वाले कंपाइलेशन टूलचेन को कॉन्फ़िगर किया गया है, हालाँकि, उसका इस्तेमाल नहीं किया जाता.

स्थानीय तौर पर इंस्टॉल किए गए JDK का इस्तेमाल करके, कॉम्पाइल करने के लिए, --extra_toolchains=@local_jdk//:all फ़्लैग का इस्तेमाल करें. इसका मतलब है कि स्थानीय JDK के लिए, कॉम्पाइलेशन टूलचेन का इस्तेमाल करें. हालांकि, ध्यान रखें कि यह किसी भी वेंडर के JDK पर काम नहीं कर सकता.

ज़्यादा जानकारी के लिए, यह देखें Java टूलचेन कॉन्फ़िगर करना ज़रूरी है.

सबसे सही तरीके

बेज़ल से जुड़े सबसे सही सामान्य तरीकों के अलावा, यहां दिए गए हैं Java प्रोजेक्ट के लिए सबसे सही तरीके.

डायरेक्ट्री स्ट्रक्चर

Maven के स्टैंडर्ड डायरेक्ट्री लेआउट को प्राथमिकता दें (src/main/java में मौजूद सोर्स, जांच करें) src/test/java से कम).

फ़ाइलें बनाएं

BUILD फ़ाइलें बनाते समय इन दिशा-निर्देशों का पालन करें:

  • Java सोर्स वाली हर डायरेक्ट्री के लिए एक BUILD फ़ाइल का इस्तेमाल करें, क्योंकि इससे बाइल्ड की परफ़ॉर्मेंस बेहतर होती है.

  • हर BUILD फ़ाइल में एक java_library नियम होना चाहिए, जो इस तरह दिखता है:

    java_library(
    name = "directory-name",
    srcs = glob(["*.java"]),
    deps = [...],
)

  • लाइब्रेरी का नाम उस डायरेक्ट्री का नाम होना चाहिए जिसमें BUILD फ़ाइल. इससे लाइब्रेरी का लेबल छोटा हो जाता है, "//package:package" के बजाय "//package".

  • सोर्स ऐसा होना चाहिए जो बार-बार न आए glob सभी Java फ़ाइलें शामिल होनी चाहिए.

  • टेस्ट, src/test से मिलती-जुलती डायरेक्ट्री में होने चाहिए और इस पर निर्भर होने चाहिए लाइब्रेरी.

बेहतर Java बिल्ड के लिए नए नियम बनाना

ध्यान दें: नए नियम, बेहतर बिल्ड और टेस्ट स्थितियों के लिए हैं. आप करें बेज़ल के साथ शुरू करते समय इसकी ज़रूरत नहीं है.

Java प्रोजेक्ट बनाते समय, नीचे दिए गए मॉड्यूल, कॉन्फ़िगरेशन फ़्रैगमेंट, और प्रोवाइडर की मदद से, Bazel की सुविधाओं को बढ़ाया जा सकता है:

Java टूलचेन कॉन्फ़िगर करना

Baज़र, दो तरह के Java टूलचेन का इस्तेमाल करता है: - निष्पादन, जावा बाइनरी को निष्पादित और परीक्षण करने के लिए उपयोग किया जाता है, --java_runtime_version फ़्लैग - कंपाइलेशन, जिसका इस्तेमाल Java सोर्स को कंपाइल करने में किया जाता है. साथ ही, इसे --java_language_version फ़्लैग

अतिरिक्त प्रोग्राम चलाने के टूलचेन कॉन्फ़िगर करना

एक्सीक्यूशन टूलचेन, JVM होता है. यह स्थानीय या किसी रिपॉज़िटरी से हो सकता है. इसमें इसके वर्शन, ऑपरेटिंग सिस्टम, और सीपीयू आर्किटेक्चर के बारे में कुछ अतिरिक्त जानकारी होती है.

मॉड्यूल एक्सटेंशन में local_java_repository या remote_java_repository रेपो नियमों का इस्तेमाल करके, Java एक्सीक्यूशन टूलचेन जोड़े जा सकते हैं. नियम जोड़ने पर, एक फ़्लैग का इस्तेमाल करके JVM उपलब्ध हो जाता है. जब एक ही ऑपरेटिंग के लिए कई परिभाषाएं सिस्टम और सीपीयू आर्किटेक्चर दिए गए हैं, पहले वाले का इस्तेमाल किया गया है.

लोकल 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 और ऐसे कई टूल से मिलकर बना है जिन्हें Basel ने इस्तेमाल किया है कंपाइलेशन के दौरान ऐसा किया गया हो और अतिरिक्त सुविधाएं दी गई हों, जैसे: प्रोन, सख्त Java डिपेंडेंसी, हेडर कंपाइलेशन, Android डिसुगरिंग, कवरेज इंस्ट्रुमेंटेशन, और IDEs के लिए genclass की हैंडलिंग.

JavaBuilder, Basel से जुड़ा एक टूल है. यह कंपाइलेशन लागू करता है, और सुविधाओं के बारे में जानकारी मिलेगी. असल कंपाइलेशन, JDK के इंटरनल कंपाइलर का इस्तेमाल करके किया जाता है. कंपाइलेशन के लिए इस्तेमाल किए जाने वाले JDK की जानकारी java_runtime ने दी है एट्रिब्यूट की वैल्यू शामिल होती है.

Basel ने JDK के कुछ इंंटरनल को बदल दिया. JDK के 9 से ज़्यादा वर्शन के मामले में, java.compiler और jdk.compiler मॉड्यूल को JDK के फ़्लैग --patch_module का इस्तेमाल करके पैच किया जाता है. JDK वर्शन 8 के मामले में, -Xbootclasspath फ़्लैग का इस्तेमाल करके Java कंपाइलर को पैच किया जाता है.

VenillaJavaBuilder, Javaबिल्डर को लागू करने की दूसरी प्रोसेस है. जो JDK के इंटरनल कंपाइलर में बदलाव नहीं करता और न ही इसमें अतिरिक्त सुविधाएं. वनिलाJava बिल्डर का इस्तेमाल किसी भी बिल्ट-इन सुविधा के लिए नहीं किया गया है से जुड़े हुए हैं.

JavaBuilder के अलावा, Basel, कंपाइलेशन के दौरान कई अन्य टूल का इस्तेमाल करता है.

ijar टूल, कॉल को छोड़कर बाकी सब कुछ हटाने के लिए jar फ़ाइलों को प्रोसेस करता है हस्ताक्षर. इस प्रोसेस के बाद बनने वाले कंटेनर को हेडर कंटेनर कहा जाता है. इनका इस्तेमाल, किसी फ़ंक्शन के मुख्य हिस्से में बदलाव होने पर, सिर्फ़ डाउनस्ट्रीम डिपेंडेंट को फिर से कंपाइल करके, कंपाइलेशन इंक्रीमेंटलिटी को बेहतर बनाने के लिए किया जाता है.

singlejar टूल, कई jar फ़ाइलों को एक ही फ़ाइल में पैक करता है.

genclass टूल, Java कंपाइलेशन के आउटपुट को प्रोसेस करने के बाद प्रोसेस करता है और एक jar जिसमें सिर्फ़ उन सोर्स की क्लास फ़ाइलें हैं जिन्हें इसके ज़रिए जनरेट किया गया था एनोटेशन प्रोसेसर.

JacocoRunner टूल, Jacoco को इंस्ट्रुमेंट की गई फ़ाइलों पर रन करता है और आउटपुट के नतीजे दिखाता है LCOV फ़ॉर्मैट में डालें.

TestRunner टूल, कंट्रोल किए गए एनवायरमेंट में JUnit 4 टेस्ट चलाता है.

BUILD फ़ाइल में default_java_toolchain मैक्रो जोड़कर और MODULE.bazel फ़ाइल में register_toolchains नियम जोड़कर या --extra_toolchains फ़्लैग का इस्तेमाल करके, कंपाइलेशन को फिर से कॉन्फ़िगर किया जा सकता है.

टूलचेन का इस्तेमाल सिर्फ़ तब किया जाता है, जब source_version एट्रिब्यूट --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 कंपाइलर फ़्लैग कॉन्फ़िगर करना

JVM और javac फ़्लैग को फ़्लैग या default_java_toolchain एट्रिब्यूट की मदद से कॉन्फ़िगर किया जा सकता है.

सही फ़्लैग ये हैं: --jvmopt, --host_jvmopt, --javacopt, और --host_javacopt.

काम के default_java_toolchain एट्रिब्यूट ये हैं: javacopts, jvm_opts, javabuilder_jvm_opts और turbine_jvm_opts.

पैकेज के हिसाब से Java कंपाइलर फ़्लैग कॉन्फ़िगरेशन

default_java_toolchain के package_configuration एट्रिब्यूट का इस्तेमाल करके, चुनिंदा सोर्स फ़ाइलों के लिए अलग-अलग Java कंपाइलर फ़्लैग कॉन्फ़िगर किए जा सकते हैं. कृपया नीचे दिया गया उदाहरण देखें.

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 सोर्स के सिर्फ़ एक वर्शन को कंपाइल करने की सुविधा देता है. build. इसका मतलब है कि Java टेस्ट या ऐप्लिकेशन बनाते समय, सभी डिपेंडेंसी एक ही Java वर्शन के हिसाब से बनाई जाती हैं.

हालांकि, अलग-अलग फ़्लैग का इस्तेमाल करके अलग-अलग बिल्ड चलाए जा सकते हैं.

अलग-अलग फ़्लैग के इस्तेमाल को आसान बनाने के लिए, फ़्लैग के सेट वर्शन को .bazelrc कॉन्फ़िगरेशन के साथ ग्रुप किया जा सकता है:

build:java8 --java_language_version=8
build:java8 --java_runtime_version=local_jdk_8
build:java11 --java_language_version=11
build:java11 --java_runtime_version=remotejdk_11

इन कॉन्फ़िगरेशन का इस्तेमाल, --config फ़्लैग के साथ किया जा सकता है, उदाहरण के लिए bazel test --config=java11 //:java11_test.