Aturan Java

Laporkan masalah Lihat sumber

Aturan

java_binary

Lihat sumber aturan
java_binary(name, deps, srcs, data, resources, args, classpath_resources, compatible_with, create_executable, deploy_env, deploy_manifest_lines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, javacopts, jvm_flags, launcher, licenses, main_class, output_licenses, plugins, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, stamp, tags, target_compatible_with, testonly, toolchains, use_launcher, use_testrunner, visibility)

Membangun arsip Java ("file jar"), plus skrip shell wrapper dengan nama yang sama seperti aturan. Skrip shell wrapper menggunakan classpath yang menyertakan, antara lain, file jar untuk setiap library tempat biner bergantung. Saat menjalankan skrip shell wrapper, variabel lingkungan JAVABIN yang tidak kosong akan lebih diutamakan daripada versi yang ditentukan melalui flag --java_runtime_version Bazel.

Skrip wrapper menerima beberapa flag unik. Lihat //src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt untuk mengetahui daftar variabel lingkungan dan flag yang dapat dikonfigurasi yang diterima oleh wrapper.

Target output implisit

  • name.jar: Arsip Java, yang berisi file class dan resource lain yang terkait dengan dependensi langsung biner.
  • name-src.jar: Arsip yang berisi sumber ("jar sumber").
  • name_deploy.jar: Arsip Java yang cocok untuk deployment (hanya dibangun jika diminta secara eksplisit).

    Membuat target <name>_deploy.jar untuk aturan Anda akan membuat file jar mandiri dengan manifes yang memungkinkannya dijalankan dengan perintah java -jar atau dengan opsi --singlejar skrip wrapper. Penggunaan skrip wrapper lebih disukai daripada java -jar karena juga meneruskan flag JVM dan opsi untuk memuat library native.

    Jar deploy berisi semua class yang akan ditemukan oleh classloader yang menelusuri classpath dari skrip wrapper biner dari awal hingga akhir. Library ini juga berisi library native yang diperlukan untuk dependensi. Link ini akan otomatis dimuat ke JVM saat runtime.

    Jika target Anda menentukan atribut peluncur, _deploy.jar akan menjadi biner native, bukan file JAR normal. Objek ini akan berisi peluncur dan dependensi native (C++) dari aturan Anda, yang semuanya ditautkan ke biner statis. Byte file jar yang sebenarnya akan ditambahkan ke biner native tersebut, sehingga menghasilkan satu blob biner yang berisi kode yang dapat dieksekusi dan kode Java. Anda dapat langsung mengeksekusi file jar yang dihasilkan seperti mengeksekusi biner native.

  • name_deploy-src.jar: Arsip yang berisi sumber yang dikumpulkan dari penutupan transitif target. Ini akan cocok dengan class di deploy.jar kecuali jika jar tidak memiliki jar sumber yang cocok.

Atribut deps tidak diizinkan dalam aturan java_binary tanpa srcs; aturan seperti itu memerlukan main_class yang disediakan oleh runtime_deps.

Cuplikan kode berikut mengilustrasikan kesalahan umum:

java_binary(
    name = "DontDoThis",
    srcs = [
        ...,
        "GeneratedJavaFile.java",  # a generated .java file
    ],
    deps = [":generating_rule"],  # rule that generates that file
)

Lakukan hal berikut:

java_binary(
    name = "DoThisInstead",
    srcs = [
        ...,
        ":generating_rule",
    ],
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.


Sebaiknya gunakan nama file sumber yang merupakan titik entri utama aplikasi (tanpa ekstensi). Misalnya, jika titik entri Anda diberi nama Main.java, nama Anda dapat berupa Main.
deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target. Lihat komentar umum tentang deps di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.
srcs

Daftar label; default-nya adalah []

Daftar file sumber yang diproses untuk membuat target. Atribut ini hampir selalu diperlukan; lihat pengecualian di bawah.

File sumber jenis .java dikompilasi. Untuk file .java yang dihasilkan, sebaiknya masukkan nama aturan pembuatan di sini, bukan nama file itu sendiri. Hal ini tidak hanya meningkatkan keterbacaan, tetapi juga membuat aturan lebih tahan terhadap perubahan mendatang: jika aturan pembuatan menghasilkan file yang berbeda di masa mendatang, Anda hanya perlu memperbaiki satu tempat: outs dari aturan yang dihasilkan. Anda tidak boleh mencantumkan aturan yang menghasilkan di deps karena aturan tersebut tidak dioperasikan.

File sumber jenis .srcjar akan diekstrak dan dikompilasi. (Ini berguna jika Anda perlu membuat kumpulan file .java dengan genrule.)

Aturan: jika aturan (biasanya genrule atau filegroup) menghasilkan salah satu file yang tercantum di atas, aturan tersebut akan digunakan dengan cara yang sama seperti yang dijelaskan untuk file sumber.

Argumen ini hampir selalu diperlukan, kecuali jika atribut main_class menentukan class pada classpath runtime atau Anda menentukan argumen runtime_deps.

resources

Daftar label; default-nya adalah []

Daftar file data yang akan disertakan dalam jar Java.

Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file .class biasa yang dihasilkan oleh kompilasi. Lokasi resource di dalam file jar ditentukan oleh struktur project. Pertama-tama Bazel akan mencari tata letak direktori standar Maven, (direktori "src" diikuti dengan turunan direktori "resources"). Jika tidak ditemukan, Bazel akan mencari direktori paling atas dengan nama "java" atau "javatests" (jadi, misalnya, jika resource berada di <workspace root>/x/java/y/java/z, jalur resource-nya adalah y/java/z. Heuristik ini tidak dapat diganti, tetapi atribut resource_strip_prefix dapat digunakan untuk menentukan direktori alternatif tertentu bagi file resource.

Resource dapat berupa file sumber atau file buatan.

classpath_resources

Daftar label; default-nya adalah []

JANGAN GUNAKAN OPSI INI KECUALI TIDAK ADA CARA LAIN)

Daftar resource yang harus ditempatkan di root pohon java. Tujuan satu-satunya atribut ini adalah untuk mendukung library pihak ketiga yang mengharuskan agar resource-nya ditemukan di classpath sama persis dengan "myconfig.xml". Library ini hanya diizinkan pada biner, bukan library, karena bahaya konflik namespace.

create_executable

Boolean; tidak dapat dikonfigurasi; defaultnya adalah True

Tidak digunakan lagi, sebagai gantinya gunakan java_single_jar.
deploy_env

Daftar label; default-nya adalah []

Daftar target java_binary lain yang mewakili lingkungan deployment untuk biner ini. Tetapkan atribut ini saat mem-build plugin yang akan dimuat oleh java_binary lain.
Menetapkan atribut ini akan mengecualikan semua dependensi dari classpath runtime (dan jar deploy) biner ini yang digunakan bersama biner ini dan target yang ditentukan dalam deploy_env.
deploy_manifest_lines

Daftar string; default-nya adalah []

Daftar baris yang akan ditambahkan ke file META-INF/manifest.mf yang dihasilkan untuk target *_deploy.jar. Konten atribut ini tidak tunduk pada substitusi "Buat variabel".
javacopts

Daftar string; default-nya adalah []

Opsi compiler tambahan untuk library ini. Tunduk pada penggantian "Buat variabel" dan tokenisasi Bourne shell.

Opsi compiler ini diteruskan ke javac setelah opsi compiler global.

jvm_flags

Daftar string; default-nya adalah []

Daftar tanda yang akan disematkan ke dalam skrip wrapper yang dihasilkan untuk menjalankan biner ini. Tunduk pada substitusi $(location) dan "Make variabel", serta tokenisasi Bourne shell.

Skrip wrapper untuk biner Java menyertakan definisi CLASSPATH (untuk menemukan semua jar dependen) dan memanggil penafsir Java yang tepat. Command line yang dihasilkan oleh skrip wrapper menyertakan nama class utama, diikuti dengan "$@", sehingga Anda dapat meneruskan argumen lain setelah classname tersebut. Namun, argumen yang ditujukan untuk penguraian oleh JVM harus ditentukan sebelum classname pada command line. Konten jvm_flags ditambahkan ke skrip wrapper sebelum classname dicantumkan.

Perhatikan bahwa atribut ini tidak berpengaruh pada output *_deploy.jar.

launcher

Label; default-nya adalah None

Tentukan biner yang akan digunakan untuk menjalankan program Java, bukan program bin/java normal yang disertakan dengan JDK. Target harus berupa cc_binary. Setiap cc_binary yang mengimplementasikan Java Invocation API dapat ditentukan sebagai nilai untuk atribut ini.

Secara default, Bazel akan menggunakan peluncur JDK normal (bin/java atau java.exe).

Flag --java_launcher Bazel yang terkait hanya memengaruhi target java_binary dan java_test yang belum menentukan atribut launcher.

Perlu diperhatikan bahwa dependensi native (C++, SWIG, JNI) akan dibuat secara berbeda bergantung pada apakah Anda menggunakan peluncur JDK atau peluncur lain:

  • Jika Anda menggunakan peluncur JDK normal (default), dependensi native dibuat sebagai library bersama dengan nama {name}_nativedeps.so, dengan {name} adalah atribut name dari aturan java_binary ini. Kode yang tidak digunakan tidak dihapus oleh linker dalam konfigurasi ini.
  • Jika Anda menggunakan peluncur lainnya, dependensi native (C++) akan ditautkan secara statis ke biner bernama {name}_nativedeps, dengan {name} sebagai atribut name dari aturan java_binary ini. Dalam hal ini, linker akan menghapus kode apa pun yang dianggap tidak digunakan dari biner yang dihasilkan, yang berarti kode C++ yang hanya diakses melalui JNI mungkin tidak akan ditautkan kecuali jika target cc_library tersebut menentukan alwayslink = 1.

Saat menggunakan peluncur selain peluncur JDK default, format output *_deploy.jar akan berubah. Lihat dokumen java_binary utama untuk informasi selengkapnya.

main_class

String; defaultnya adalah ""

Nama class dengan metode main() untuk digunakan sebagai titik entri. Aturan tidak memerlukan daftar srcs=[...] jika menggunakan opsi ini. Jadi, dengan atribut ini, seseorang dapat membuat file yang dapat dieksekusi dari library Java yang sudah berisi satu atau beberapa metode main().

Nilai atribut ini adalah nama class, bukan file sumber. Class harus tersedia saat runtime: class dapat dikompilasi oleh aturan ini (dari srcs) atau disediakan oleh dependensi langsung atau transitif (melalui runtime_deps atau deps). Jika class tidak tersedia, biner akan gagal saat runtime; tidak ada pemeriksaan waktu build.

plugins

Daftar label; default-nya adalah []

Plugin compiler Java untuk dijalankan pada waktu kompilasi. Setiap java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini dibuat. Library juga dapat mewarisi plugin dari dependensi yang menggunakan exported_plugins. Resource yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan aturan ini.
resource_jars

Daftar label; default-nya adalah []

Tidak digunakan lagi: Gunakan java_import dan deps atau runtime_deps sebagai gantinya.
resource_strip_prefix

String; defaultnya adalah ""

Awalan jalur untuk dihapus dari resource Java.

Jika ditentukan, awalan jalur ini akan dihilangkan dari setiap file dalam atribut resources. Ini adalah error jika file resource tidak berada dalam direktori ini. Jika tidak ditentukan (default), jalur file resource akan ditentukan sesuai dengan logika yang sama seperti paket file sumber Java. Misalnya, file sumber di stuff/java/foo/bar/a.txt akan ditempatkan di foo/bar/a.txt.

runtime_deps

Daftar label; default-nya adalah []

Library yang akan disediakan untuk biner akhir atau diuji hanya pada saat runtime. Seperti deps biasa, library ini akan muncul di classpath runtime, tetapi tidak seperti class tersebut, bukan pada classpath waktu kompilasi. Dependensi yang hanya diperlukan saat runtime harus tercantum di sini. Alat analisis dependensi harus mengabaikan target yang muncul di runtime_deps dan deps.
stamp

Bilangan bulat; defaultnya adalah -1

Apakah akan mengenkode informasi build ke dalam biner. Nilai yang memungkinkan:
  • stamp = 1: Selalu stempelkan informasi build ke dalam biner, bahkan dalam build --nostamp. Setelan ini harus dihindari, karena berpotensi menghentikan caching jarak jauh untuk biner dan tindakan downstream apa pun yang bergantung pada setelan tersebut.
  • stamp = 0: Selalu ganti informasi build dengan nilai konstanta. Tindakan ini akan meng-cache hasil build yang baik.
  • stamp = -1: Penyematan informasi build dikontrol oleh flag --[no]stamp.

Biner berstempel tidak dibangun ulang kecuali jika dependensinya berubah.

use_launcher

Boolean; defaultnya adalah True

Apakah biner harus menggunakan peluncur kustom.

Jika atribut ini ditetapkan ke false, atribut launcher dan flag --java_launcher terkait akan diabaikan untuk target ini.

use_testrunner

Boolean; defaultnya adalah False

Gunakan class runner pengujian (secara default com.google.testing.junit.runner.BazelTestRunner) sebagai titik entri utama untuk program Java, dan berikan class pengujian tersebut kepada runner pengujian sebagai nilai properti sistem bazel.test_suite. Anda dapat menggunakannya untuk mengganti perilaku default, yaitu menggunakan runner pengujian untuk aturan java_test, dan tidak menggunakannya untuk aturan java_binary. Anda tidak mungkin ingin melakukan hal ini. Salah satunya adalah untuk aturan AllTest yang dipanggil oleh aturan lain (misalnya untuk menyiapkan database sebelum menjalankan pengujian). Aturan AllTest harus dideklarasikan sebagai java_binary, tetapi tetap harus menggunakan runner pengujian sebagai titik entri utamanya. Nama class runner pengujian dapat diganti dengan atribut main_class.

java_import

Lihat sumber aturan
java_import(name, deps, data, add_exports, add_opens, compatible_with, constraints, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, jars, licenses, neverlink, proguard_specs, restricted_to, runtime_deps, srcjar, tags, target_compatible_with, testonly, toolchains, visibility)

Aturan ini mengizinkan penggunaan file .jar yang telah dikompilasi sebagai library untuk aturan java_library dan java_binary.

Contoh


    java_import(
        name = "maven_model",
        jars = [
            "maven_model/maven-aether-provider-3.2.3.jar",
            "maven_model/maven-model-3.2.3.jar",
            "maven_model/maven-model-builder-3.2.3.jar",
        ],
    )

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target. Lihat java_library.deps.
data

Daftar label; default-nya adalah []

Daftar file yang dibutuhkan oleh aturan ini pada runtime.
add_exports

Daftar string; default-nya adalah []

Mengizinkan library ini mengakses module atau package yang ditentukan.

Ini sesuai dengan flag --add-exports= javac dan JVM.

add_opens

Daftar string; default-nya adalah []

Mengizinkan library ini untuk mengakses module atau package yang diberikan secara reflektif.

Ini berkaitan dengan flag --add-opens= javac dan JVM.

constraints

Daftar string; default-nya adalah []

Batasan tambahan diberlakukan pada aturan ini sebagai library Java.
exports

Daftar label; default-nya adalah []

Target yang akan tersedia bagi pengguna aturan ini. Lihat java_library.exports.
jars

Daftar label; wajib diisi

Daftar file JAR yang diberikan ke target Java yang bergantung pada target ini.

Boolean; defaultnya adalah False

Hanya gunakan library ini untuk kompilasi dan bukan pada runtime. Berguna jika library akan disediakan oleh lingkungan runtime selama eksekusi. Contoh library seperti ini adalah IDE API untuk plugin IDE atau tools.jar untuk apa pun yang berjalan di JDK standar.
proguard_specs

Daftar label; default-nya adalah []

File yang akan digunakan sebagai spesifikasi Proguard. Ini akan menjelaskan kumpulan spesifikasi yang akan digunakan oleh Proguard. Jika ditentukan, elemen akan ditambahkan ke target android_binary apa pun bergantung pada library ini. File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarning, assumenosideimpact, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di proguard_specs android_binary, untuk memastikan penggabungan non-tautological.
runtime_deps

Daftar label; default-nya adalah []

Library yang akan disediakan untuk biner akhir atau diuji hanya pada saat runtime. Lihat java_library.runtime_deps.
srcjar

Label; default-nya adalah None

File JAR yang berisi kode sumber untuk file JAR yang dikompilasi.

java_library

Lihat sumber aturan
java_library(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exported_plugins, exports, features, javabuilder_jvm_flags, javacopts, licenses, neverlink, plugins, proguard_specs, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, toolchains, visibility)

Aturan ini mengompilasi dan menautkan sumber ke dalam file .jar.

Output implisit

  • libname.jar: Arsip Java yang berisi file class.
  • libname-src.jar: Arsip yang berisi sumber ("jar sumber").

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library yang akan ditautkan ke library ini. Lihat komentar umum tentang deps di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.

Jar yang dibuat oleh aturan java_library yang tercantum dalam deps akan berada di classpath waktu kompilasi aturan ini. Selain itu, penutupan transitif deps, runtime_deps, dan exports-nya akan berada pada classpath runtime.

Sebaliknya, target dalam atribut data disertakan dalam runfile, tetapi tidak pada classpath waktu kompilasi maupun classpath runtime.

srcs

Daftar label; default-nya adalah []

Daftar file sumber yang diproses untuk membuat target. Atribut ini hampir selalu diperlukan; lihat pengecualian di bawah.

File sumber jenis .java dikompilasi. Untuk file .java yang dihasilkan, sebaiknya masukkan nama aturan pembuatan di sini, bukan nama file itu sendiri. Hal ini tidak hanya meningkatkan keterbacaan, tetapi membuat aturan lebih tahan terhadap perubahan di masa mendatang: jika aturan pembuatan menghasilkan file yang berbeda di masa mendatang, Anda hanya perlu memperbaiki satu tempat: outs aturan pembuatan. Anda tidak boleh mencantumkan aturan yang menghasilkan di deps karena aturan tersebut tanpa pengoperasian.

File sumber jenis .srcjar akan diekstrak dan dikompilasi. (Ini berguna jika Anda perlu membuat kumpulan file .java dengan genrule.)

Aturan: jika aturan (biasanya genrule atau filegroup) menghasilkan salah satu file yang tercantum di atas, aturan tersebut akan digunakan dengan cara yang sama seperti yang dijelaskan untuk file sumber.

File sumber jenis .properties diperlakukan sebagai resource.

Semua file lain akan diabaikan, selama ada setidaknya satu file dari jenis file yang dijelaskan di atas. Jika tidak, error akan muncul.

Argumen ini hampir selalu diperlukan, kecuali jika Anda menentukan argumen runtime_deps.

data

Daftar label; default-nya adalah []

Daftar file yang dibutuhkan oleh library ini pada runtime. Lihat komentar umum tentang data di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.

Saat mem-build java_library, Bazel tidak akan menempatkan file ini di mana pun; jika file data dihasilkan, Bazel akan membuatnya. Saat mem-build pengujian yang bergantung pada java_library Bazel ini, akan menyalin atau menautkan file data ke area runfile.

resources

Daftar label; default-nya adalah []

Daftar file data yang akan disertakan dalam jar Java.

Resource dapat berupa file sumber atau file buatan.

Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file .class biasa yang dihasilkan oleh kompilasi. Lokasi resource di dalam file jar ditentukan oleh struktur project. Pertama-tama, Bazel akan mencari tata letak direktori standar Maven, (direktori "src" diikuti dengan turunan direktori "resources"). Jika tidak ditemukan, Bazel akan mencari direktori paling atas bernama "java" atau "javatests" (jadi, misalnya, jika resource berada di <workspace root>/x/java/y/java/z, jalur resource akan menjadi y/java/z. Heuristik ini tidak dapat diganti, tetapi atribut resource_strip_prefix dapat digunakan untuk menentukan direktori alternatif tertentu untuk file resource.

add_exports

Daftar string; default-nya adalah []

Mengizinkan library ini mengakses module atau package yang ditentukan.

Ini sesuai dengan flag --add-exports= javac dan JVM.

add_opens

Daftar string; default-nya adalah []

Mengizinkan library ini untuk mengakses module atau package yang diberikan secara reflektif.

Ini berkaitan dengan flag --add-opens= javac dan JVM.

bootclasspath

Label; default-nya adalah None

API yang Dibatasi, jangan digunakan.
exported_plugins

Daftar label; default-nya adalah []

Daftar java_plugin (mis. pemroses anotasi) yang akan diekspor ke library yang secara langsung bergantung pada library ini.

Daftar java_plugin yang ditentukan akan diterapkan ke library apa pun yang secara langsung bergantung pada library ini, seolah-olah library tersebut telah secara eksplisit mendeklarasikan label ini di plugins.

exports

Daftar label; default-nya adalah []

Library yang diekspor.

Mencantumkan aturan di sini akan membuatnya tersedia untuk aturan induk, seolah-olah induk secara eksplisit bergantung pada aturan ini. Hal ini tidak berlaku untuk deps reguler (tidak diekspor).

Ringkasan: aturan X dapat mengakses kode dalam Y jika ada jalur dependensi di antaranya yang dimulai dengan edge deps yang diikuti oleh nol atau beberapa tepi exports. Mari kita lihat beberapa contoh untuk menggambarkan hal ini.

Asumsikan A bergantung pada B dan B bergantung pada C. Dalam hal ini, C adalah dependensi transitif dari A. Oleh karena itu, mengubah sumber C dan mem-build ulang A akan membangun ulang semuanya dengan benar. Namun, A tidak akan dapat menggunakan class di C. Untuk mengizinkannya, A harus mendeklarasikan C dalam deps-nya, atau B dapat memudahkan A (dan apa pun yang mungkin bergantung pada A) dengan mendeklarasikan C dalam atribut exports (B).

Penutupan library yang diekspor tersedia untuk semua aturan induk langsung. Ambil contoh yang sedikit berbeda: A bergantung pada B, B bergantung pada C dan D, serta mengekspor C tetapi tidak D. Sekarang A memiliki akses ke C tetapi tidak ke D. Sekarang, jika C dan D mengekspor beberapa library, C' dan D', A hanya dapat mengakses C', tetapi tidak dapat mengakses D'.

Penting: aturan yang diekspor bukan dependensi reguler. Tetap berpegang pada contoh sebelumnya, jika B mengekspor C dan ingin menggunakan C juga, B harus mencantumkannya dalam deps-nya sendiri.

javabuilder_jvm_flags

Daftar string; default-nya adalah []

API yang Dibatasi, jangan digunakan.
javacopts

Daftar string; default-nya adalah []

Opsi compiler tambahan untuk library ini. Tunduk pada penggantian "Buat variabel" dan tokenisasi Bourne shell.

Opsi compiler ini diteruskan ke javac setelah opsi compiler global.

Boolean; defaultnya adalah False

Apakah library ini hanya boleh digunakan untuk kompilasi dan bukan saat runtime. Berguna jika library akan disediakan oleh lingkungan runtime selama eksekusi. Contoh library tersebut adalah IDE API untuk plugin IDE atau tools.jar untuk apa pun yang berjalan di JDK standar.

Perlu diperhatikan bahwa neverlink = 1 tidak mencegah compiler menyisipkan materi dari library ini ke target kompilasi yang bergantung padanya, seperti yang diizinkan oleh Spesifikasi Bahasa Java (misalnya, static final dari String atau berjenis primitif). Oleh karena itu, kasus penggunaan yang disukai adalah saat library runtime identik dengan library kompilasi.

Jika library runtime berbeda dengan library kompilasi, Anda harus memastikan bahwa library tersebut hanya berbeda di tempat-tempat yang dilarang oleh JLS untuk compiler inline (dan yang harus berlaku untuk semua versi JLS di masa mendatang).

plugins

Daftar label; default-nya adalah []

Plugin compiler Java untuk dijalankan pada waktu kompilasi. Setiap java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini dibuat. Library juga dapat mewarisi plugin dari dependensi yang menggunakan exported_plugins. Resource yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan aturan ini.
proguard_specs

Daftar label; default-nya adalah []

File yang akan digunakan sebagai spesifikasi Proguard. Ini akan menjelaskan kumpulan spesifikasi yang akan digunakan oleh Proguard. Jika ditentukan, elemen akan ditambahkan ke target android_binary apa pun bergantung pada library ini. File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarning, assumenosideimpact, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di proguard_specs android_binary, untuk memastikan penggabungan non-tautological.
resource_strip_prefix

String; defaultnya adalah ""

Awalan jalur untuk dihapus dari resource Java.

Jika ditentukan, awalan jalur ini akan dihilangkan dari setiap file dalam atribut resources. Ini adalah error jika file resource tidak berada dalam direktori ini. Jika tidak ditentukan (default), jalur file resource akan ditentukan sesuai dengan logika yang sama dengan paket Java file sumber. Misalnya, file sumber di stuff/java/foo/bar/a.txt akan ditempatkan di foo/bar/a.txt.

runtime_deps

Daftar label; default-nya adalah []

Library yang akan disediakan untuk biner akhir atau diuji hanya pada saat runtime. Seperti deps biasa, library ini akan muncul di classpath runtime, tetapi tidak seperti classpath tersebut, bukan pada classpath waktu kompilasi. Dependensi yang hanya diperlukan saat runtime harus tercantum di sini. Alat analisis dependensi harus mengabaikan target yang muncul di runtime_deps dan deps.

java_lite_proto_library

Lihat sumber aturan
java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library menghasilkan kode Java dari file .proto.

deps harus mengarah ke aturan proto_library .

Contoh:


java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar aturan proto_library yang digunakan untuk membuat kode Java.

java_proto_library

Lihat sumber aturan
java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library menghasilkan kode Java dari file .proto.

deps harus mengarah ke aturan proto_library .

Contoh:


java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar aturan proto_library yang digunakan untuk membuat kode Java.

java_test

Lihat sumber aturan
java_test(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_manifest_lines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, launcher, licenses, local, main_class, neverlink, plugins, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, use_testrunner, visibility)

Aturan java_test() mengompilasi pengujian Java. Pengujian adalah wrapper biner di sekitar kode pengujian Anda. Metode utama runner pengujian dipanggil, bukan class utama yang dikompilasi.

Target output implisit

  • name.jar: Arsip Java.
  • name_deploy.jar: Arsip Java yang cocok untuk deployment. (Hanya dibuat jika diminta secara eksplisit.) Lihat deskripsi output name_deploy.jar dari java_binary untuk detail selengkapnya.

Lihat bagian argumen java_binary(). Aturan ini juga mendukung semua atribut umum untuk semua aturan pengujian (*_test).

Contoh



java_library(
    name = "tests",
    srcs = glob(["*.java"]),
    deps = [
        "//java/com/foo/base:testResources",
        "//java/com/foo/testing/util",
    ],
)

java_test(
    name = "AllTests",
    size = "small",
    runtime_deps = [
        ":tests",
        "//util/mysql",
    ],
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target. Lihat komentar umum tentang deps di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.
srcs

Daftar label; default-nya adalah []

Daftar file sumber yang diproses untuk membuat target. Atribut ini hampir selalu diperlukan; lihat pengecualian di bawah.

File sumber jenis .java dikompilasi. Untuk file .java yang dihasilkan, sebaiknya masukkan nama aturan pembuatan di sini, bukan nama file itu sendiri. Hal ini tidak hanya meningkatkan keterbacaan, tetapi membuat aturan lebih tahan terhadap perubahan di masa mendatang: jika aturan pembuatan menghasilkan file yang berbeda di masa mendatang, Anda hanya perlu memperbaiki satu tempat: outs aturan pembuatan. Anda tidak boleh mencantumkan aturan yang menghasilkan di deps karena aturan tersebut tanpa pengoperasian.

File sumber jenis .srcjar akan diekstrak dan dikompilasi. (Ini berguna jika Anda perlu membuat kumpulan file .java dengan genrule.)

Aturan: jika aturan (biasanya genrule atau filegroup) menghasilkan salah satu file yang tercantum di atas, aturan tersebut akan digunakan dengan cara yang sama seperti yang dijelaskan untuk file sumber.

Argumen ini hampir selalu diperlukan, kecuali jika atribut main_class menentukan class pada classpath runtime atau Anda menentukan argumen runtime_deps.

data

Daftar label; default-nya adalah []

Daftar file yang dibutuhkan oleh library ini pada runtime. Lihat komentar umum tentang data di Atribut umum yang ditentukan oleh sebagian besar aturan build.
resources

Daftar label; default-nya adalah []

Daftar file data yang akan disertakan dalam jar Java.

Resource dapat berupa file sumber atau file buatan.

Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file .class biasa yang dihasilkan oleh kompilasi. Lokasi resource di dalam file jar ditentukan oleh struktur project. Pertama-tama, Bazel akan mencari tata letak direktori standar Maven, (direktori "src" diikuti dengan turunan direktori "resources"). Jika tidak ditemukan, Bazel akan mencari direktori paling atas bernama "java" atau "javatests" (jadi, misalnya, jika resource berada di <workspace root>/x/java/y/java/z, jalur resource akan menjadi y/java/z. Heuristik ini tidak dapat diganti, tetapi atribut resource_strip_prefix dapat digunakan untuk menentukan direktori alternatif tertentu untuk file resource.

add_exports

Daftar string; default-nya adalah []

Mengizinkan library ini mengakses module atau package yang ditentukan.

Ini sesuai dengan flag --add-exports= javac dan JVM.

add_opens

Daftar string; default-nya adalah []

Mengizinkan library ini untuk mengakses module atau package yang diberikan secara reflektif.

Ini berkaitan dengan flag --add-opens= javac dan JVM.

bootclasspath

Label; default-nya adalah None

API yang Dibatasi, jangan digunakan.
classpath_resources

Daftar label; default-nya adalah []

JANGAN GUNAKAN OPSI INI KECUALI TIDAK ADA CARA LAIN)

Daftar resource yang harus ditempatkan di root pohon java. Tujuan satu-satunya atribut ini adalah untuk mendukung library pihak ketiga yang mengharuskan resource-nya ditemukan di classpath sama persis dengan "myconfig.xml". Opsi ini hanya diizinkan pada biner, bukan library, karena bahaya konflik namespace.

create_executable

Boolean; defaultnya adalah True

Tidak digunakan lagi, sebagai gantinya gunakan java_single_jar.
deploy_manifest_lines

Daftar string; default-nya adalah []

Daftar baris yang akan ditambahkan ke file META-INF/manifest.mf yang dihasilkan untuk target *_deploy.jar. Konten atribut ini tidak dapat substitusi "Buat variabel".
javacopts

Daftar string; default-nya adalah []

Opsi compiler tambahan untuk biner ini. Tunduk pada penggantian "Buat variabel" dan tokenisasi Bourne shell.

Opsi compiler ini diteruskan ke javac setelah opsi compiler global.

jvm_flags

Daftar string; default-nya adalah []

Daftar tanda yang akan disematkan ke dalam skrip wrapper yang dihasilkan untuk menjalankan biner ini. Tunduk pada penggantian $(location) dan "Make variabel", serta tokenisasi Bourne shell.

Skrip wrapper untuk biner Java menyertakan definisi CLASSPATH (untuk menemukan semua jar dependen) dan memanggil penafsir Java yang tepat. Command line yang dihasilkan oleh skrip wrapper menyertakan nama class utama, diikuti dengan "$@", sehingga Anda dapat meneruskan argumen lain setelah classname tersebut. Namun, argumen yang ditujukan untuk penguraian oleh JVM harus ditentukan sebelum classname pada command line. Konten jvm_flags ditambahkan ke skrip wrapper sebelum classname dicantumkan.

Perhatikan bahwa atribut ini tidak berpengaruh pada output *_deploy.jar.

launcher

Label; default-nya adalah None

Tentukan biner yang akan digunakan untuk menjalankan program Java, bukan program bin/java normal yang disertakan dengan JDK. Target harus berupa cc_binary. Setiap cc_binary yang mengimplementasikan Java Invocation API dapat ditentukan sebagai nilai untuk atribut ini.

Secara default, Bazel akan menggunakan peluncur JDK normal (bin/java atau java.exe).

Flag --java_launcher Bazel terkait hanya memengaruhi target java_binary dan java_test yang belum menentukan atribut launcher.

Perlu diperhatikan bahwa dependensi native (C++, SWIG, JNI) akan dibuat secara berbeda bergantung pada apakah Anda menggunakan peluncur JDK atau peluncur lain:

  • Jika Anda menggunakan peluncur JDK normal (default), dependensi native dibuat sebagai library bersama dengan nama {name}_nativedeps.so, dengan {name} adalah atribut name dari aturan java_binary ini. Kode yang tidak digunakan tidak dihapus oleh linker dalam konfigurasi ini.
  • Jika Anda menggunakan peluncur lainnya, dependensi native (C++) akan ditautkan secara statis ke biner bernama {name}_nativedeps, dengan {name} adalah atribut name dari aturan java_binary ini. Dalam hal ini, linker akan menghapus kode apa pun yang dianggap tidak digunakan dari biner yang dihasilkan, sehingga kode C++ yang hanya diakses melalui JNI tidak akan ditautkan kecuali jika target cc_library tersebut menentukan alwayslink = 1.

Saat menggunakan peluncur selain peluncur JDK default, format output *_deploy.jar akan berubah. Lihat dokumen java_binary utama untuk mengetahui detailnya.

main_class

String; defaultnya adalah ""

Nama class dengan metode main() untuk digunakan sebagai titik entri. Aturan tidak memerlukan daftar srcs=[...] jika menggunakan opsi ini. Jadi, dengan atribut ini, seseorang dapat membuat file yang dapat dieksekusi dari library Java yang sudah berisi satu atau beberapa metode main().

Nilai atribut ini adalah nama class, bukan file sumber. Class harus tersedia saat runtime: class dapat dikompilasi oleh aturan ini (dari srcs) atau disediakan oleh dependensi langsung atau transitif (melalui runtime_deps atau deps). Jika class tidak tersedia, biner akan gagal saat runtime; tidak ada pemeriksaan waktu build.

Boolean; defaultnya adalah False

plugins

Daftar label; default-nya adalah []

Plugin compiler Java untuk dijalankan pada waktu kompilasi. Setiap java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini dibuat. Library juga dapat mewarisi plugin dari dependensi yang menggunakan exported_plugins. Resource yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan aturan ini.
resource_strip_prefix

String; defaultnya adalah ""

Awalan jalur untuk dihapus dari resource Java.

Jika ditentukan, awalan jalur ini akan dihilangkan dari setiap file dalam atribut resources. Ini adalah error jika file resource tidak berada dalam direktori ini. Jika tidak ditentukan (default), jalur file resource akan ditentukan sesuai dengan logika yang sama dengan paket Java file sumber. Misalnya, file sumber di stuff/java/foo/bar/a.txt akan ditempatkan di foo/bar/a.txt.

runtime_deps

Daftar label; default-nya adalah []

Library yang akan disediakan untuk biner akhir atau diuji hanya pada saat runtime. Seperti deps biasa, library ini akan muncul di classpath runtime, tetapi tidak seperti classpath tersebut, bukan pada classpath waktu kompilasi. Dependensi yang hanya diperlukan saat runtime harus tercantum di sini. Alat analisis dependensi harus mengabaikan target yang muncul di runtime_deps dan deps.
stamp

Bilangan bulat; defaultnya adalah 0

Apakah akan mengenkode informasi build ke dalam biner. Nilai yang memungkinkan:
  • stamp = 1: Selalu stempelkan informasi build ke dalam biner, bahkan dalam build --nostamp. Setelan ini harus dihindari, karena berpotensi menghentikan caching jarak jauh untuk biner dan tindakan downstream apa pun yang bergantung pada setelan tersebut.
  • stamp = 0: Selalu ganti informasi build dengan nilai konstanta. Tindakan ini akan meng-cache hasil build yang baik.
  • stamp = -1: Penyematan informasi build dikontrol oleh flag --[no]stamp.

Biner berstempel tidak dibangun ulang kecuali jika dependensinya berubah.

test_class

String; defaultnya adalah ""

Class Java yang akan dimuat oleh runner pengujian.

Secara default, jika argumen ini tidak ditentukan, mode lama akan digunakan dan argumen pengujian akan digunakan. Tetapkan flag --nolegacy_bazel_java_test agar tidak melakukan penggantian pada argumen pertama.

Atribut ini menentukan nama class Java yang akan dijalankan oleh pengujian ini. Pengaturan ini jarang dilakukan. Jika dihilangkan, argumen ini akan disimpulkan menggunakan name target dan jalur relatif sumber-root-nya. Jika pengujian terletak di luar root sumber yang diketahui, Bazel akan melaporkan error jika test_class tidak disetel.

Untuk JUnit3, class pengujian harus berupa subclass junit.framework.TestCase atau harus memiliki metode suite() statis publik yang menampilkan junit.framework.Test (atau subclass Test). Untuk JUnit4, class harus dianotasi dengan org.junit.runner.RunWith.

Atribut ini memungkinkan beberapa aturan java_test menggunakan Test yang sama (TestCase, TestSuite, ...). Biasanya informasi tambahan diteruskan ke atribut tersebut (misalnya, melalui jvm_flags=['-Dkey=value']) sehingga perilakunya berbeda dalam setiap kasus, misalnya menjalankan subset pengujian yang berbeda. Atribut ini juga memungkinkan penggunaan pengujian Java di luar hierarki javatests.

use_launcher

Boolean; defaultnya adalah True

Apakah biner harus menggunakan peluncur kustom.

Jika atribut ini ditetapkan ke false, atribut peluncur dan tanda --java_launcher terkait akan diabaikan untuk target ini.

use_testrunner

Boolean; defaultnya adalah True

Gunakan class runner pengujian (secara default com.google.testing.junit.runner.BazelTestRunner) sebagai titik entri utama untuk program Java, dan berikan class pengujian kepada runner pengujian sebagai nilai properti sistem bazel.test_suite.
Anda dapat menggunakan ini untuk mengganti perilaku default, yaitu menggunakan runner pengujian untuk aturan java_test, dan tidak menggunakannya untuk aturan java_binary. Anda tidak mungkin ingin melakukan ini. Salah satu kegunaannya adalah untuk aturan AllTest yang dipanggil oleh aturan lain (misalnya untuk menyiapkan database sebelum menjalankan pengujian). Aturan AllTest harus dideklarasikan sebagai java_binary, tetapi tetap harus menggunakan runner pengujian sebagai titik entri utamanya. Nama class runner pengujian dapat diganti dengan atribut main_class.

java_package_configuration

Lihat sumber aturan
java_package_configuration(name, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, javacopts, output_licenses, packages, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Konfigurasi yang akan diterapkan ke kumpulan paket. Konfigurasi dapat ditambahkan ke java_toolchain.javacopts.

Contoh:



java_package_configuration(
    name = "my_configuration",
    packages = [":my_packages"],
    javacopts = ["-Werror"],
)

package_group(
    name = "my_packages",
    packages = [
        "//com/my/project/...",
        "-//com/my/project/testing/...",
    ],
)

java_toolchain(
    ...,
    package_configuration = [
        ":my_configuration",
    ]
)


Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

data

Daftar label; default-nya adalah []

Daftar file yang dibutuhkan oleh konfigurasi ini pada runtime.
javacopts

Daftar string; default-nya adalah []

flag compiler Java.
output_licenses

Daftar string; default-nya adalah []

packages

Daftar label; default-nya adalah []

Kumpulan package_group tempat konfigurasi akan diterapkan.

java_plugin

Lihat sumber aturan
java_plugin(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, generates_api, javabuilder_jvm_flags, javacopts, licenses, neverlink, output_licenses, plugins, processor_class, proguard_specs, resource_strip_prefix, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_plugin menentukan plugin untuk compiler Java yang dijalankan oleh Bazel. Saat ini, satu-satunya jenis plugin yang didukung adalah pemroses anotasi. Aturan java_library atau java_binary dapat menjalankan plugin dengan bergantung padanya melalui atribut plugins. java_library juga dapat otomatis mengekspor plugin ke library yang bergantung langsung padanya menggunakan exported_plugins.

Target output implisit

  • libname.jar: Arsip Java.

Argumen identik dengan java_library, kecuali untuk penambahan argumen processor_class.

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library yang akan ditautkan ke library ini. Lihat komentar umum tentang deps di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.

Jar yang dibuat oleh aturan java_library yang tercantum dalam deps akan berada di classpath waktu kompilasi aturan ini. Selain itu, penutupan transitif deps, runtime_deps, dan exports-nya akan berada pada classpath runtime.

Sebaliknya, target dalam atribut data disertakan dalam runfile, tetapi tidak pada classpath waktu kompilasi maupun classpath runtime.

srcs

Daftar label; default-nya adalah []

Daftar file sumber yang diproses untuk membuat target. Atribut ini hampir selalu diperlukan; lihat pengecualian di bawah.

File sumber jenis .java dikompilasi. Untuk file .java yang dihasilkan, sebaiknya masukkan nama aturan pembuatan di sini, bukan nama file itu sendiri. Hal ini tidak hanya meningkatkan keterbacaan, tetapi membuat aturan lebih tahan terhadap perubahan di masa mendatang: jika aturan pembuatan menghasilkan file yang berbeda di masa mendatang, Anda hanya perlu memperbaiki satu tempat: outs aturan pembuatan. Anda tidak boleh mencantumkan aturan yang menghasilkan di deps karena aturan tersebut tanpa pengoperasian.

File sumber jenis .srcjar akan diekstrak dan dikompilasi. (Ini berguna jika Anda perlu membuat kumpulan file .java dengan genrule.)

Aturan: jika aturan (biasanya genrule atau filegroup) menghasilkan salah satu file yang tercantum di atas, aturan tersebut akan digunakan dengan cara yang sama seperti yang dijelaskan untuk file sumber.

File sumber jenis .properties diperlakukan sebagai resource.

Semua file lain akan diabaikan, selama ada setidaknya satu file dari jenis file yang dijelaskan di atas. Jika tidak, error akan muncul.

Argumen ini hampir selalu diperlukan, kecuali jika Anda menentukan argumen runtime_deps.

data

Daftar label; default-nya adalah []

Daftar file yang dibutuhkan oleh library ini pada runtime. Lihat komentar umum tentang data di bagian Atribut umum yang ditentukan oleh sebagian besar aturan build.

Saat mem-build java_library, Bazel tidak akan menempatkan file ini di mana pun; jika file data dihasilkan, Bazel akan membuatnya. Saat mem-build pengujian yang bergantung pada java_library Bazel ini, akan menyalin atau menautkan file data ke area runfile.

resources

Daftar label; default-nya adalah []

Daftar file data yang akan disertakan dalam jar Java.

Resource dapat berupa file sumber atau file buatan.

Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file .class biasa yang dihasilkan oleh kompilasi. Lokasi resource di dalam file jar ditentukan oleh struktur project. Pertama-tama, Bazel akan mencari tata letak direktori standar Maven, (direktori "src" diikuti dengan turunan direktori "resources"). Jika tidak ditemukan, Bazel akan mencari direktori paling atas bernama "java" atau "javatests" (jadi, misalnya, jika resource berada di <workspace root>/x/java/y/java/z, jalur resource akan menjadi y/java/z. Heuristik ini tidak dapat diganti, tetapi atribut resource_strip_prefix dapat digunakan untuk menentukan direktori alternatif tertentu untuk file resource.

add_exports

Daftar string; default-nya adalah []

Mengizinkan library ini mengakses module atau package yang ditentukan.

Ini sesuai dengan flag --add-exports= javac dan JVM.

add_opens

Daftar string; default-nya adalah []

Mengizinkan library ini untuk mengakses module atau package yang diberikan secara reflektif.

Ini berkaitan dengan flag --add-opens= javac dan JVM.

bootclasspath

Label; default-nya adalah None

API yang Dibatasi, jangan digunakan.
generates_api

Boolean; defaultnya adalah False

Atribut ini menandai pemroses anotasi yang menghasilkan kode API.

Jika aturan menggunakan pemroses anotasi yang membuat API, aturan lain yang bergantung pada aturan tersebut dapat merujuk ke kode yang dihasilkan hanya jika tindakan kompilasinya dijadwalkan setelah aturan yang dibuat. Atribut ini menginstruksikan Bazel untuk menerapkan batasan penjadwalan saat --java_header_compilation diaktifkan.

PERINGATAN: Atribut ini memengaruhi performa build. Gunakan atribut ini hanya jika diperlukan.

javabuilder_jvm_flags

Daftar string; default-nya adalah []

API yang Dibatasi, jangan digunakan.
javacopts

Daftar string; default-nya adalah []

Opsi compiler tambahan untuk library ini. Tunduk pada penggantian "Buat variabel" dan tokenisasi Bourne shell.

Opsi compiler ini diteruskan ke javac setelah opsi compiler global.

Boolean; defaultnya adalah False

Apakah library ini hanya boleh digunakan untuk kompilasi dan bukan saat runtime. Berguna jika library akan disediakan oleh lingkungan runtime selama eksekusi. Contoh library tersebut adalah IDE API untuk plugin IDE atau tools.jar untuk apa pun yang berjalan di JDK standar.

Perlu diperhatikan bahwa neverlink = 1 tidak mencegah compiler menyisipkan materi dari library ini ke target kompilasi yang bergantung padanya, seperti yang diizinkan oleh Spesifikasi Bahasa Java (misalnya, static final dari String atau berjenis primitif). Oleh karena itu, kasus penggunaan yang disukai adalah saat library runtime identik dengan library kompilasi.

Jika library runtime berbeda dengan library kompilasi, Anda harus memastikan bahwa library tersebut hanya berbeda di tempat-tempat yang dilarang oleh JLS untuk compiler inline (dan yang harus berlaku untuk semua versi JLS di masa mendatang).

output_licenses

Daftar string; default-nya adalah []

plugins

Daftar label; default-nya adalah []

Plugin compiler Java untuk dijalankan pada waktu kompilasi. Setiap java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini dibuat. Library juga dapat mewarisi plugin dari dependensi yang menggunakan exported_plugins. Resource yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan aturan ini.
processor_class

String; defaultnya adalah ""

Class pemroses adalah jenis class yang sepenuhnya memenuhi syarat dan harus digunakan oleh compiler Java sebagai titik entri ke pemroses anotasi. Jika tidak ditentukan, aturan ini tidak akan mengontribusi pemroses anotasi ke pemrosesan anotasi compiler Java, tetapi classpath runtime-nya akan tetap disertakan di jalur pemroses anotasi compiler. (Khususnya dimaksudkan untuk digunakan oleh plugin Error Prone, yang dimuat dari jalur pemroses anotasi menggunakan java.util.ServiceLoader.)
proguard_specs

Daftar label; default-nya adalah []

File yang akan digunakan sebagai spesifikasi Proguard. Ini akan menjelaskan kumpulan spesifikasi yang akan digunakan oleh Proguard. Jika ditentukan, elemen akan ditambahkan ke target android_binary apa pun bergantung pada library ini. File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarning, assumenosideimpact, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di proguard_specs android_binary, untuk memastikan penggabungan non-tautological.
resource_strip_prefix

String; defaultnya adalah ""

Awalan jalur untuk dihapus dari resource Java.

Jika ditentukan, awalan jalur ini akan dihilangkan dari setiap file dalam atribut resources. Ini adalah error jika file resource tidak berada dalam direktori ini. Jika tidak ditentukan (default), jalur file resource akan ditentukan sesuai dengan logika yang sama dengan paket Java file sumber. Misalnya, file sumber di stuff/java/foo/bar/a.txt akan ditempatkan di foo/bar/a.txt.

java_runtime

Lihat sumber aturan
java_runtime(name, srcs, compatible_with, default_cds, deprecation, distribs, exec_compatible_with, exec_properties, features, hermetic_srcs, hermetic_static_libs, java, java_home, lib_ct_sym, lib_modules, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, version, visibility)

Menentukan konfigurasi untuk runtime Java.

Contoh:



java_runtime(
    name = "jdk-9-ea+153",
    srcs = glob(["jdk9-ea+153/**"]),
    java_home = "jdk9-ea+153",
)


Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

srcs

Daftar label; default-nya adalah []

Semua file dalam runtime.
default_cds

Label; default-nya adalah None

Arsip CDS default untuk java_runtime hermetic. Saat hermetic diaktifkan untuk target java_binary dan jika target tidak menyediakan arsip CDS-nya sendiri dengan menentukan atribut classlist, CDS default java_runtime akan dikemas dalam JAR deploy hermetis.
hermetic_srcs

Daftar label; default-nya adalah []

File dalam runtime yang diperlukan untuk deployment hermetic.
hermetic_static_libs

Daftar label; default-nya adalah []

Library yang secara statis tertaut dengan peluncur untuk deployment hermetic
java

Label; default-nya adalah None

Jalur ke file java yang dapat dieksekusi.
java_home

String; defaultnya adalah ""

Jalur ke root runtime. Tunduk pada penggantian variabel"Buat". Jika jalur ini bersifat absolut, aturan akan menunjukkan runtime Java non-hermetic dengan jalur yang dikenal. Dalam hal ini, atribut srcs dan java harus kosong.
lib_ct_sym

Label; default-nya adalah None

File lib/ct.sym yang diperlukan untuk kompilasi dengan --release. Jika tidak ditentukan dan tepat ada satu file di srcs yang jalurnya diakhiri dengan /lib/ct.sym, file tersebut akan digunakan.
lib_modules

Label; default-nya adalah None

File lib/modules yang diperlukan untuk deployment hermetic.
output_licenses

Daftar string; default-nya adalah []

version

Bilangan bulat; defaultnya adalah 0

Versi fitur runtime Java. Artinya, bilangan bulat yang ditampilkan oleh Runtime.version().feature().

java_toolchain

Lihat sumber aturan
java_toolchain(name, android_lint_data, android_lint_jvm_opts, android_lint_opts, android_lint_package_configuration, android_lint_runner, bootclasspath, compatible_javacopts, compatible_with, deprecation, deps_checker, distribs, exec_compatible_with, exec_properties, features, forcibly_disable_header_compilation, genclass, header_compiler, header_compiler_builtin_processors, header_compiler_direct, ijar, jacocorunner, java_runtime, javabuilder, javabuilder_data, javabuilder_jvm_opts, javac_supports_multiplex_workers, javac_supports_worker_cancellation, javac_supports_worker_multiplex_sandboxing, javac_supports_workers, javacopts, jspecify_implicit_deps, jspecify_javacopts, jspecify_packages, jspecify_processor, jspecify_processor_class, jspecify_stubs, jvm_opts, licenses, misc, oneversion, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, proguard_allowlister, reduced_classpath_incompatible_processors, restricted_to, singlejar, source_version, tags, target_compatible_with, target_version, testonly, timezone_data, toolchains, tools, turbine_data, turbine_jvm_opts, visibility, xlint)

Menentukan konfigurasi untuk compiler Java. Toolchain yang akan digunakan dapat diubah melalui argumen --java_ toolchain. Biasanya, Anda tidak perlu menulis aturan semacam itu kecuali jika Anda ingin men-tuning compiler Java.

Contoh

Contoh sederhananya adalah:



java_toolchain(
    name = "toolchain",
    source_version = "7",
    target_version = "7",
    bootclasspath = ["//tools/jdk:bootclasspath"],
    xlint = [ "classfile", "divzero", "empty", "options", "path" ],
    javacopts = [ "-g" ],
    javabuilder = ":JavaBuilder_deploy.jar",
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.

android_lint_data

Daftar label; default-nya adalah []

Label alat yang tersedia untuk perluasan label di android_lint_jvm_opts.
android_lint_jvm_opts

Daftar string; default-nya adalah []

Daftar argumen untuk JVM saat memanggil Android Lint.
android_lint_opts

Daftar string; default-nya adalah []

Daftar argumen Android Lint.
android_lint_package_configuration

Daftar label; default-nya adalah []

Konfigurasi Android Lint yang harus diterapkan ke grup paket yang ditentukan.
android_lint_runner

Label; default-nya adalah None

Label runner Lint Android, jika ada.
bootclasspath

Daftar label; default-nya adalah []

Entri bootclasspath target Java. Sesuai dengan flag -bootclasspath javac.
compatible_javacopts

null; default is {}

API Internal, jangan digunakan.
deps_checker

Label; default-nya adalah None

Label jar deploy ImportDepsChecker.
forcibly_disable_header_compilation

Boolean; defaultnya adalah False

Mengganti --java_header_compilation untuk menonaktifkan kompilasi header pada platform yang tidak mendukungnya, misalnya JDK 7 Bazel.
genclass

Label; default-nya adalah None

Label jar deploy GenClass.
header_compiler

Label; default-nya adalah None

Label compiler header. Wajib jika --java_header_compilation diaktifkan.
header_compiler_builtin_processors

Daftar string; default-nya adalah []

API Internal, jangan digunakan.
header_compiler_direct

Label; default-nya adalah None

Label opsional compiler header yang akan digunakan untuk tindakan classpath langsung yang tidak menyertakan pemroses anotasi pembuatan API.

Alat ini tidak mendukung pemrosesan anotasi.

ijar

Label; default-nya adalah None

Label ijar yang dapat dieksekusi.
jacocorunner

Label; default-nya adalah None

Label jar deploy JacocoCoverageRunner.
java_runtime

Label; default-nya adalah None

java_runtime yang akan digunakan dengan toolchain ini. Defaultnya adalah java_runtime dalam konfigurasi eksekusi.
javabuilder

Label; default-nya adalah None

Label jar deploy JavaBuilder.
javabuilder_data

Daftar label; default-nya adalah []

Label data tersedia untuk ekspansi label di javabuilder_jvm_opts.
javabuilder_jvm_opts

Daftar string; default-nya adalah []

Daftar argumen untuk JVM saat memanggil JavaBuilder.
javac_supports_multiplex_workers

Boolean; defaultnya adalah True

Benar jika JavaBuilder mendukung berjalan sebagai pekerja persisten multipleks, salah jika tidak.
javac_supports_worker_cancellation

Boolean; defaultnya adalah True

Benar jika JavaBuilder mendukung pembatalan pekerja persisten, salah jika tidak mendukungnya.
javac_supports_worker_multiplex_sandboxing

Boolean; defaultnya adalah False

Benar jika JavaBuilder mendukung berjalan sebagai pekerja persisten multipleks dengan sandbox, salah jika tidak.
javac_supports_workers

Boolean; defaultnya adalah True

Benar jika JavaBuilder mendukung berjalan sebagai pekerja persisten, salah jika tidak.
javacopts

Daftar string; default-nya adalah []

Daftar argumen tambahan untuk compiler Java. Lihat dokumentasi compiler Java untuk mengetahui daftar lengkap kemungkinan flag compiler Java.
jspecify_implicit_deps

Label; default-nya adalah None

Eksperimental, jangan digunakan!
jspecify_javacopts

Daftar string; default-nya adalah []

Eksperimental, jangan digunakan!
jspecify_packages

Daftar label; default-nya adalah []

Eksperimental, jangan digunakan!
jspecify_processor

Label; default-nya adalah None

Eksperimental, jangan digunakan!
jspecify_processor_class

String; defaultnya adalah ""

Eksperimental, jangan digunakan!
jspecify_stubs

Daftar label; default-nya adalah []

Eksperimental, jangan digunakan!
jvm_opts

Daftar string; default-nya adalah []

Daftar argumen untuk JVM saat memanggil compiler Java. Lihat dokumentasi virtual machine Java untuk mengetahui daftar lengkap kemungkinan flag untuk opsi ini.
misc

Daftar string; default-nya adalah []

Tidak digunakan lagi: gunakan javacopts sebagai gantinya
oneversion

Label; default-nya adalah None

Label biner penerapan satu versi.
oneversion_allowlist_for_tests

Label; default-nya adalah None

Label daftar yang diizinkan satu versi untuk pengujian.
oneversion_whitelist

Label; default-nya adalah None

Label daftar yang diizinkan satu versi.
package_configuration

Daftar label; default-nya adalah []

Konfigurasi yang harus diterapkan ke grup paket yang ditentukan.
proguard_allowlister

Label; default-nya adalah "@bazel_tools//tools/jdk:proguard_whitelister"

Label daftar yang diizinkan Proguard.
reduced_classpath_incompatible_processors

Daftar string; default-nya adalah []

API Internal, jangan digunakan.
singlejar

Label; default-nya adalah None

Label jar deploy SingleJar.
source_version

String; defaultnya adalah ""

Versi sumber Java (mis., '6' atau '7'). Kode ini menentukan kumpulan struktur kode yang diizinkan dalam kode sumber Java.
target_version

String; defaultnya adalah ""

Versi target Java (mis., '6' atau '7'). Class ini menentukan runtime Java mana yang harus dibangun.
timezone_data

Label; default-nya adalah None

Label jar resource yang berisi data zona waktu. Jika ditetapkan, data zona waktu akan ditambahkan sebagai dependensi runtime secara implisit dari semua aturan java_binary.
tools

Daftar label; default-nya adalah []

Label alat yang tersedia untuk perluasan label di jvm_opts.
turbine_data

Daftar label; default-nya adalah []

Label data tersedia untuk label-expansion di turbine_jvm_opts.
turbine_jvm_opts

Daftar string; default-nya adalah []

Daftar argumen untuk JVM saat memanggil turbin.
xlint

Daftar string; default-nya adalah []

Daftar peringatan yang akan ditambahkan atau dihapus dari daftar default. Didahului dengan tanda hubung untuk menghapusnya. Lihat dokumentasi Javac tentang opsi -Xlint untuk informasi selengkapnya.