मेवन से बेज़ेल पर माइग्रेट करना

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

इस पेज पर, Maven से Baze तक माइग्रेट करने का तरीका बताया गया है. इसमें, इसे इंस्टॉल करने से जुड़ी ज़रूरी शर्तों और तरीकों की जानकारी भी दी गई है. इसमें Maven और Bazel के बीच के अंतर के बारे में बताया गया है. साथ ही, Guava प्रोजेक्ट का इस्तेमाल करके माइग्रेशन का उदाहरण दिया गया है.

किसी भी बिल्ड टूल से Basel पर माइग्रेट करते समय, दोनों बिल्ड टूल को साथ-साथ चलाना चाहिए. ऐसा तब तक करना चाहिए, जब तक कि आप अपनी डेवलपमेंट टीम, सीआई सिस्टम, और दूसरे ज़रूरी सिस्टम को पूरी तरह से माइग्रेट न कर लें. एक ही रिपॉज़िटरी में Maven और Bazel को चलाया जा सकता है.

ध्यान दें: हालांकि, Basel की Maven आर्टफ़ैक्ट को rules_jvm_external के साथ डाउनलोड और पब्लिश करने की सुविधा है, लेकिन यह सीधे तौर पर Maven-आधारित प्लगिन के साथ काम नहीं करती है. Maven प्लग इन को सीधे तौर पर Bazel से नहीं चलाया जा सकता, क्योंकि Maven के साथ काम करने वाली कोई लेयर मौजूद नहीं है.

शुरू करने से पहले

• अगर Bazel इंस्टॉल नहीं है, तो उसे इंस्टॉल करें.
• अगर आपने पहले कभी Bazel का इस्तेमाल नहीं किया है, तो माइग्रेट करने से पहले Bazel के बारे में जानकारी: Java को बिल्ड करना ट्यूटोरियल पढ़ें. इस ट्यूटोरियल में, Bazel के कॉन्सेप्ट, स्ट्रक्चर, और लेबल के सिंटैक्स के बारे में बताया गया है.

Maven और Baज़ल के बीच अंतर

• Maven, टॉप लेवल की pom.xml फ़ाइल(फ़ाइलों) का इस्तेमाल करता है. Bazel, एक से ज़्यादा बिल्ड फ़ाइलों और हर BUILD फ़ाइल के लिए कई टारगेट के साथ काम करता है. इससे, Maven की तुलना में ज़्यादा इंक्रीमेंटल बिल्ड बनाने में मदद मिलती है.
• Maven, डिप्लॉयमेंट प्रोसेस के चरणों को मैनेज करता है. Basel, डिप्लॉयमेंट को ऑटोमेट नहीं करता है.
• Bazel की मदद से, भाषाओं के बीच डिपेंडेंसी को दिखाया जा सकता है.
• प्रोजेक्ट में नए सेक्शन जोड़ने पर, Basel की मदद से आपको नई BUILD फ़ाइलें जोड़नी पड़ सकती हैं. हर नए Java पैकेज में BUILD फ़ाइल जोड़ना सबसे सही तरीका है.

Maven से Bazel पर माइग्रेट करना

अपने प्रोजेक्ट को Basel में माइग्रेट करने का तरीका नीचे बताया गया है:

1. Workspace फ़ाइल बनाएं
2. एक BUILD फ़ाइल बनाना
3. ज़्यादा BUILD फ़ाइलें बनाना
4. Bazel का इस्तेमाल करके बिल्ड करना

यहां दिए गए उदाहरण, Guava प्रोजेक्ट को Maven से Bazel में माइग्रेट करने से जुड़े हैं. इस्तेमाल किए गए Guava प्रोजेक्ट का रिलीज़ वर्शन v31.1 है. Guava के इस्तेमाल करने वाले उदाहरण, माइग्रेशन के हर चरण के बारे में नहीं बताते. हालांकि, वे फ़ाइलें और कॉन्टेंट दिखाते हैं जो माइग्रेशन के लिए मैन्युअल तरीके से जनरेट या जोड़े जाते हैं.

$ git clone https://github.com/google/guava.git && cd guava
$ git checkout v31.1

1. Workspace फ़ाइल बनाएं

अपने प्रोजेक्ट के रूट में WORKSPACE नाम की फ़ाइल बनाएं. अगर आपके प्रोजेक्ट में कोई बाहरी डिपेंडेंसी नहीं है, तो वर्कस्पेस फ़ाइल खाली हो सकती है.

अगर आपका प्रोजेक्ट ऐसी फ़ाइलों या पैकेज पर निर्भर करता है जो प्रोजेक्ट की किसी डायरेक्ट्री में मौजूद नहीं हैं, तो Workspace फ़ाइल में इन बाहरी डिपेंडेंसी के बारे में बताएं. वर्कस्पेस की फ़ाइल के लिए, बाहरी डिपेंडेंसी की लिस्टिंग को ऑटोमेट करने के लिए, rules_jvm_external का इस्तेमाल करें. इस नियमों के सेट का इस्तेमाल करने के बारे में निर्देशों के लिए, README देखें.

ध्यान दें: पहले सुझाए गए टूल, generate_workspace को अब Bazel टीम मैनेज नहीं करती.

Guava प्रोजेक्ट का उदाहरण: बाहरी डिपेंडेंसी

rules_jvm_external नियमों के सेट की मदद से, Guava प्रोजेक्ट की बाहरी डिपेंडेंसी की सूची बनाई जा सकती है.

WORKSPACE फ़ाइल में यह स्निपेट जोड़ें:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

RULES_JVM_EXTERNAL_TAG = "4.3"
RULES_JVM_EXTERNAL_SHA = "6274687f6fc5783b589f56a2f1ed60de3ce1f99bc4e8f9edef3de43bdf7c6e74"

http_archive(
    name = "rules_jvm_external",
    sha256 = RULES_JVM_EXTERNAL_SHA,
    strip_prefix = "rules_jvm_external-%s" % RULES_JVM_EXTERNAL_TAG,
    url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % RULES_JVM_EXTERNAL_TAG,
)

load("@rules_jvm_external//:defs.bzl", "maven_install")

maven_install(
    artifacts = [
        "com.google.code.findbugs:jsr305:3.0.2",
        "com.google.errorprone:error_prone_annotations:2.11.0",
        "com.google.j2objc:j2objc-annotations:1.3",
        "org.codehaus.mojo:animal-sniffer-annotations:1.20",
        "org.checkerframework:checker-qual:3.12.0",
    ],
    repositories = [
        "https://repo1.maven.org/maven2",
    ],
)

2. एक BUILD फ़ाइल बनाना

आपने फ़ाइल फ़ोल्डर तय कर लिया है और बाहरी डिपेंडेंसी (अगर लागू हो) की सूची तैयार कर ली है, तो आपको BUILD फ़ाइलें बनानी होंगी. इससे, यह बताया जा सकेगा कि आपका प्रोजेक्ट कैसे बनाया जाना चाहिए. Maven में एक pom.xml फ़ाइल होती है, जबकि Bazel में प्रोजेक्ट बनाने के लिए कई BUILD फ़ाइलों का इस्तेमाल किया जा सकता है. इन फ़ाइलों में कई बिल्ड टारगेट तय किए जाते हैं, जिनकी मदद से Bazel, इंक्रीमेंटल बिल्ड बनाता है.

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

1. WORKSPACE फ़ाइल की डायरेक्ट्री में, एक टेक्स्ट फ़ाइल बनाएं और उसका नाम BUILD रखें.

2. इस BUILD फ़ाइल में, अपना प्रोजेक्ट बनाने के लिए एक टारगेट बनाने के लिए, सही नियम का इस्तेमाल करें. इसके लिए, यहां कुछ सुझाव दिए गए हैं:

   • सही नियम का इस्तेमाल करें:

     • एक Maven मॉड्यूल वाले प्रोजेक्ट बनाने के लिए, java_library नियम का इस्तेमाल इस तरह करें:

       java_library(
           name = "everything",
           srcs = glob(["src/main/java/**/*.java"]),
           resources = glob(["src/main/resources/**"]),
           deps = ["//:all-external-targets"],
       )
       

     • एक से ज़्यादा Maven मॉड्यूल वाले प्रोजेक्ट बनाने के लिए, java_library नियम का इस्तेमाल इस तरह करें:

       java_library(
           name = "everything",
           srcs = glob([
               "Module1/src/main/java/**/*.java",
               "Module2/src/main/java/**/*.java",
               ...
           ]),
           resources = glob([
               "Module1/src/main/resources/**",
               "Module2/src/main/resources/**",
               ...
           ]),
           deps = ["//:all-external-targets"],
       )
       

     • बाइनरी बनाने के लिए, java_binary नियम का इस्तेमाल करें:

       java_binary(
           name = "everything",
           srcs = glob(["src/main/java/**/*.java"]),
           resources = glob(["src/main/resources/**"]),
           deps = ["//:all-external-targets"],
           main_class = "com.example.Main"
       )
       

   • एट्रिब्यूट की जानकारी दें:

     • name: टारगेट को कोई ऐसा नाम दें जो काम का हो. ऊपर दिए गए उदाहरण में, टारगेट को "सब कुछ" कहा गया है.
     • srcs: अपने प्रोजेक्ट की सभी .java फ़ाइलों की सूची बनाने के लिए ग्लोबिंग का इस्तेमाल करें.
     • resources: अपने प्रोजेक्ट के सभी संसाधनों की सूची बनाने के लिए, ग्लोबिंग का इस्तेमाल करें.
     • deps: आपको यह तय करना होगा कि आपके प्रोजेक्ट को किन बाहरी डिपेंडेंसी की ज़रूरत है. उदाहरण के लिए, अगर आपने generate_workspace टूल का इस्तेमाल करके, बाहरी डिपेंडेंसी की सूची जनरेट की है, तो java_library के लिए डिपेंडेंसी, generated_java_libraries मैक्रो में दी गई लाइब्रेरी हैं.

   • Guava प्रोजेक्ट के माइग्रेशन के दौरान, टॉप-लेवल BUILD फ़ाइल का यह उदाहरण देखें.

3. अब आपके प्रोजेक्ट के रूट में एक BUILD फ़ाइल है, तो अपना प्रोजेक्ट बनाएं, ताकि यह पक्का किया जा सके कि वह काम करे. कमांड लाइन पर, अपनी वर्कस्पेस डायरेक्ट्री में जाकर, Bazel की मदद से प्रोजेक्ट बनाने के लिए bazel build //:everything का इस्तेमाल करें.

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

Guava प्रोजेक्ट का उदाहरण: एक BUILD फ़ाइल से शुरू करना

Guava प्रोजेक्ट को Basel में माइग्रेट करते समय, शुरुआत में एक BUILD फ़ाइल का इस्तेमाल करके, पूरा प्रोजेक्ट बनाया जाता है. वर्कस्पेस डायरेक्ट्री में, इस शुरुआती BUILD फ़ाइल का कॉन्टेंट यहां दिया गया है:

java_library(
    name = "everything",
    srcs = glob([
        "guava/src/**/*.java",
        "futures/failureaccess/src/**/*.java",
    ]),
    deps = [
        "@maven//:com_google_code_findbugs_jsr305",
        "@maven//:com_google_errorprone_error_prone_annotations",
        "@maven//:com_google_j2objc_j2objc_annotations",
        "@maven//:org_checkerframework_checker_qual",
        "@maven//:org_codehaus_mojo_animal_sniffer_annotations",
    ],
)

3. और BUILD फ़ाइलें बनाएं (वैकल्पिक)

Bazel सिर्फ़ एक BUILD file के साथ काम करता है, जैसा कि आपको अपना पहला बिलट पूरा करने के बाद पता चला था. आपको अब भी ज़्यादा जानकारी वाले टारगेट के साथ ज़्यादा BUILD फ़ाइलें जोड़कर, इस बिल्ड को छोटे-छोटे हिस्सों में बांटना चाहिए.

एक से ज़्यादा टारगेट वाली कई BUILD फ़ाइलों से, बंडल को ज़्यादा बेहतर बनाया जा सकता है. इससे ये काम किए जा सकते हैं:

• प्रोजेक्ट के इंक्रीमेंटल बिल्ड में बढ़ोतरी हुई,
• बिल्ड को पैरलल तरीके से चलाने की सुविधा को बेहतर बनाया गया है,
• आने वाले समय के उपयोगकर्ताओं के लिए बिल्ड का बेहतर रखरखाव, और
• पैकेज के बीच टारगेट की दिखने की सुविधा को कंट्रोल करना. इससे, लाइब्रेरी में लागू करने की जानकारी, सार्वजनिक एपीआई में लीक होने जैसी समस्याओं को रोका जा सकता है.

ज़्यादा BUILD फ़ाइलें जोड़ने के लिए सलाह:

• आप हर Java पैकेज में BUILD फ़ाइल जोड़कर शुरू कर सकते हैं. सबसे कम डिपेंडेंसी वाले Java पैकेज से शुरू करें और सबसे ज़्यादा डिपेंडेंसी वाले पैकेज पर जाएं.
• BUILD फ़ाइलें जोड़ते समय और टारगेट तय करते समय, इन नए टारगेट को उन टारगेट के deps सेक्शन में जोड़ दें जो इन पर निर्भर करते हैं. ध्यान दें कि glob() फ़ंक्शन, पैकेज की सीमाओं को पार नहीं करता. इसलिए, पैकेज की संख्या बढ़ने पर, glob() से मैच होने वाली फ़ाइलों की संख्या कम हो जाएगी.
• जब भी आप BUILD फ़ाइल को main डायरेक्ट्री में जोड़ें, तो पक्का करें कि आप उससे जुड़ी test डायरेक्ट्री में BUILD फ़ाइल जोड़ें.
• इस बात का ध्यान रखें कि अलग-अलग पैकेज को एक ही समय पर दिखाया जा सके.
• BUILD फ़ाइलों के सेटअप में गड़बड़ियों को हल करने के लिए, पक्का करें कि हर बिल्ड फ़ाइल जोड़ने पर, प्रोजेक्ट Bazel की मदद से बनता रहे. bazel build //... चलाकर पक्का करें कि आपके सभी टारगेट अब भी बने रहें.

4. Bazel का इस्तेमाल करके बिल्ड करना

आपने Bazel का इस्तेमाल करके बिल्ड किया है, क्योंकि आपने बिल्ड के सेटअप की पुष्टि करने के लिए BUILD फ़ाइलें जोड़ी हैं.

जब आपके पास ज़रूरत के हिसाब से BUILD फ़ाइलें हों, तो सभी बिल्ड बनाने के लिए Bazel का इस्तेमाल किया जा सकता है.