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

รายงานปัญหา ดูแหล่งที่มา Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

หน้านี้จะอธิบายวิธีย้ายข้อมูลจาก Maven ไปยัง Bazel ซึ่งรวมถึง ข้อกำหนดเบื้องต้นและขั้นตอนการติดตั้ง โดยจะอธิบายความแตกต่าง ระหว่าง Maven กับ Bazel และแสดงตัวอย่างการย้ายข้อมูลโดยใช้ โปรเจ็กต์ Guava

เมื่อย้ายข้อมูลจากเครื่องมือบิลด์ใดๆ ไปยัง Bazel คุณควรเรียกใช้เครื่องมือบิลด์ทั้ง 2 รายการแบบคู่ขนานจนกว่าจะย้ายข้อมูลทีมพัฒนา ระบบ CI และระบบอื่นๆ ที่เกี่ยวข้องทั้งหมดเรียบร้อยแล้ว คุณเรียกใช้ Maven และ Bazel ในที่เก็บเดียวกันได้

ก่อนเริ่มต้น

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

ความแตกต่างระหว่าง Maven กับ Bazel

Maven ใช้ไฟล์ pom.xml ระดับบนสุด Bazel รองรับไฟล์บิลด์หลายไฟล์และเป้าหมายหลายรายการต่อไฟล์ BUILD ซึ่งช่วยให้บิลด์เพิ่มขึ้นได้มากกว่าของ Maven
Maven จะดูแลขั้นตอนสำหรับกระบวนการติดตั้งใช้งาน Bazel ไม่ได้ทำให้การติดตั้งใช้งานเป็นไปโดยอัตโนมัติ
Bazel ช่วยให้คุณแสดงการอ้างอิงระหว่างภาษาต่างๆ ได้
เมื่อเพิ่มส่วนใหม่ลงในโปรเจ็กต์ คุณอาจต้องเพิ่มBUILDไฟล์ใหม่ด้วย Bazel แนวทางปฏิบัติแนะนำคือการเพิ่มไฟล์ BUILD ลงในแพ็กเกจ Java ใหม่แต่ละแพ็กเกจ

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

ขั้นตอนด้านล่างจะอธิบายวิธีย้ายข้อมูลโปรเจ็กต์ไปยัง Bazel

สร้างไฟล์ WORKSPACE
สร้างไฟล์ BUILD 1 ไฟล์
สร้างไฟล์ BUILD เพิ่มเติม
สร้างโดยใช้ 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 ที่รูทของโปรเจ็กต์ หากโปรเจ็กต์ไม่มีการอ้างอิงภายนอก ไฟล์พื้นที่ทำงานจะว่างเปล่าได้

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

ตัวอย่างโปรเจ็กต์ Guava: การอ้างอิงภายนอก

คุณสามารถแสดงรายการการอ้างอิงภายนอกของโปรเจ็กต์ Guava ด้วยชุดกฎ rules_jvm_external

เพิ่มข้อมูลโค้ดต่อไปนี้ลงในไฟล์ 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

เมื่อกำหนดพื้นที่ทำงานและแสดงทรัพยากร Dependency ภายนอก (หากมี) แล้ว คุณต้องสร้างไฟล์ BUILD เพื่ออธิบายวิธีสร้างโปรเจ็กต์ Bazel ใช้ไฟล์ BUILD หลายไฟล์เพื่อสร้างโปรเจ็กต์ได้ ซึ่งต่างจาก Maven ที่มีไฟล์ pom.xml เพียงไฟล์เดียว ไฟล์เหล่านี้ระบุเป้าหมายการบิลด์หลายรายการ ซึ่งช่วยให้ Bazel สร้างบิลด์ที่เพิ่มขึ้นได้

เพิ่มไฟล์ BUILD เป็นระยะๆ เริ่มต้นด้วยการเพิ่มไฟล์ BUILD ที่รูทของโปรเจ็กต์และใช้ไฟล์ดังกล่าวเพื่อทำการบิลด์เริ่มต้นโดยใช้ Bazel จากนั้นปรับแต่งบิลด์โดยเพิ่มBUILDไฟล์ที่มีเป้าหมายที่ละเอียดยิ่งขึ้น

สร้างไฟล์ข้อความในไดเรกทอรีเดียวกับไฟล์ WORKSPACE แล้วตั้งชื่อว่า BUILD
ในไฟล์ 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: ใช้ Globbing เพื่อแสดงทรัพยากรทั้งหมดในโปรเจ็กต์
  - deps: คุณต้องพิจารณาว่าโปรเจ็กต์ของคุณต้องพึ่งพาอะไรจากภายนอก เช่น หากคุณสร้างรายการทรัพยากร Dependency ภายนอก โดยใช้เครื่องมือ generate_workspace ทรัพยากร Dependency สำหรับ java_library คือไลบรารีที่แสดงใน มาโคร generated_java_libraries
- ดูตัวอย่างไฟล์ BUILD ระดับบนสุดนี้ด้านล่างจากการย้ายข้อมูลโปรเจ็กต์ Guava
ตอนนี้คุณมีไฟล์ BUILD ที่รูทของโปรเจ็กต์แล้ว ให้สร้าง โปรเจ็กต์เพื่อให้แน่ใจว่าโปรเจ็กต์ทำงานได้ ในบรรทัดคำสั่ง ให้ใช้ bazel build //:everything เพื่อสร้างโปรเจ็กต์ด้วย Bazel จากไดเรกทอรีพื้นที่ทำงาน

ตอนนี้สร้างโปรเจ็กต์ด้วย Bazel เรียบร้อยแล้ว คุณจะต้อง เพิ่มไฟล์ BUILD เพื่ออนุญาตให้สร้างโปรเจ็กต์แบบเพิ่มทีละรายการ

ตัวอย่างโปรเจ็กต์ Guava: เริ่มต้นด้วยไฟล์ BUILD ไฟล์เดียว

เมื่อย้ายข้อมูลโปรเจ็กต์ Guava ไปยัง Bazel ในตอนแรกจะใช้ไฟล์ 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 หลายไฟล์ที่มีเป้าหมายหลายรายการจะช่วยเพิ่มความละเอียดในการบิลด์ ซึ่งจะช่วยให้ทำสิ่งต่อไปนี้ได้

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

เคล็ดลับในการเพิ่มไฟล์ BUILD เพิ่มเติม

คุณเริ่มต้นได้โดยการเพิ่มไฟล์ BUILD ลงในแต่ละแพ็กเกจ Java เริ่มจาก แพ็กเกจ Java ที่มีการอ้างอิงน้อยที่สุด แล้วค่อยๆ ไปยังแพ็กเกจที่มีการอ้างอิงมากที่สุด
เมื่อเพิ่มไฟล์ BUILD และระบุเป้าหมาย ให้เพิ่มเป้าหมายใหม่เหล่านี้ลงในส่วน depsของเป้าหมายที่ขึ้นอยู่กับเป้าหมายใหม่ โปรดทราบว่าglob() ฟังก์ชันจะไม่ข้ามขอบเขตของแพ็กเกจ ดังนั้นเมื่อจำนวน แพ็กเกจเพิ่มขึ้น ไฟล์ที่ glob() จับคู่จะลดลง
เมื่อใดก็ตามที่คุณเพิ่มไฟล์ BUILD ลงในไดเรกทอรี main โปรดตรวจสอบว่าคุณได้เพิ่มไฟล์ BUILD ลงในไดเรกทอรี test ที่เกี่ยวข้อง
โปรดระมัดระวังในการจำกัดระดับการเข้าถึงระหว่างแพ็กเกจอย่างเหมาะสม
หากต้องการให้การแก้ปัญหาข้อผิดพลาดในการตั้งค่าไฟล์ BUILD เป็นเรื่องง่าย โปรดตรวจสอบ ว่าโปรเจ็กต์ยังคงสร้างด้วย Bazel ต่อไปเมื่อคุณเพิ่มไฟล์ บิลด์แต่ละไฟล์ เรียกใช้ bazel build //... เพื่อให้แน่ใจว่าเป้าหมายทั้งหมดของคุณยังคงสร้างได้

4. สร้างโดยใช้ Bazel

คุณสร้างโดยใช้ Bazel ขณะเพิ่มไฟล์ BUILD เพื่อตรวจสอบการตั้งค่า ของการสร้าง

เมื่อมีBUILDไฟล์ที่ระดับความละเอียดที่ต้องการ คุณจะใช้ Bazel เพื่อสร้างบิลด์ทั้งหมดได้