Aturan
- java_binary
- java_import
- java_library
- java_test
- java_package_configuration
- java_plugin
- java_runtime
- java_single_jar
- java_toolchain
java_binary
Melihat sumber aturanjava_binary(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, 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, neverlink, output_licenses, plugins, resource_strip_prefix, restricted_to, runtime_deps, stamp, tags, target_compatible_with, testonly, toolchains, use_launcher, use_testrunner, visibility)
Mem-build arsip Java ("file jar"), serta skrip shell wrapper dengan nama yang sama dengan aturan.
Skrip shell wrapper menggunakan classpath yang mencakup, antara lain, file jar untuk setiap
library tempat biner bergantung. Saat menjalankan skrip shell wrapper, variabel lingkungan JAVABIN
yang tidak kosong akan diprioritaskan 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 flag yang dapat dikonfigurasi dan variabel lingkungan yang diterima oleh wrapper.
Target output implisit
name.jar
: Arsip Java, yang berisi file class dan resource lainnya yang sesuai dengan dependensi langsung biner.name-src.jar
: Arsip yang berisi sumber ("jar sumber").name_deploy.jar
: Arsip Java yang sesuai untuk deployment (hanya di-build jika diminta secara eksplisit).Mem-build target
<name>_deploy.jar
untuk aturan Anda akan membuat file jar mandiri dengan manifes yang memungkinkannya dijalankan dengan perintahjava -jar
atau dengan opsi--singlejar
skrip wrapper. Menggunakan skrip wrapper lebih disukai daripadajava -jar
karena juga meneruskan flag JVM dan opsi untuk memuat library native.Jar deployment berisi semua class yang akan ditemukan oleh classloader yang menelusuri classpath dari skrip wrapper biner dari awal hingga akhir. Direktori ini juga berisi library native yang diperlukan untuk dependensi. Class ini otomatis dimuat ke JVM saat runtime.
Jika target Anda menentukan atribut launcher, _deploy.jar akan menjadi biner native, bukan file JAR normal. File ini akan berisi peluncur serta dependensi native (C++) dari aturan Anda, yang semuanya ditautkan ke biner statis. Byte file jar yang sebenarnya akan ditambahkan ke biner native tersebut, sehingga membuat satu blob biner yang berisi kode yang dapat dieksekusi dan kode Java. Anda dapat mengeksekusi file jar yang dihasilkan secara langsung seperti Anda mengeksekusi biner native.
name_deploy-src.jar
: Arsip yang berisi sumber yang dikumpulkan dari penutupan transitif target. Class ini akan cocok dengan class dideploy.jar
kecuali jika jar tidak memiliki jar sumber yang cocok.
Sebaiknya gunakan nama file sumber yang merupakan titik entri utama
aplikasi (tanpa ekstensi). Misalnya, jika titik entri Anda disebut
Main.java
, nama Anda dapat berupa Main
.
Atribut deps
tidak diizinkan dalam aturan java_binary
tanpa
srcs
; aturan tersebut 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
)
Sebagai gantinya, lakukan hal berikut:
java_binary(
name = "DoThisInstead",
srcs = [
...,
":generating_rule",
],
)
Argumen
Atribut | |
---|---|
name |
Nama; wajib Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah deps di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
|
srcs
|
Daftar label; default-nya adalah
File sumber jenis
File sumber jenis
Aturan: jika aturan (biasanya
Argumen ini hampir selalu diperlukan, kecuali jika
atribut |
data
|
Daftar label; default-nya adalah data
di Atribut umum yang ditentukan oleh
sebagian besar aturan build.
|
resources
|
Daftar label; default-nya adalah Resource dapat berupa file sumber atau file yang dihasilkan.
Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file
|
add_exports
|
Daftar string; default-nya adalah module atau package yang diberikan.
Ini sesuai dengan flag javac dan JVM --add-exports=. |
add_opens
|
Daftar string; default-nya adalah module atau
package yang diberikan secara reflektif.
Ini sesuai dengan flag javac dan JVM --add-opens=. |
bootclasspath
|
Label; default-nya adalah |
classpath_resources
|
Daftar label; default-nya adalah
Daftar resource yang harus berada di root hierarki java. Satu-satunya tujuan
atribut ini adalah untuk mendukung library pihak ketiga yang mewajibkan resource-nya
ditemukan di classpath persis seperti |
create_executable
|
Boolean; default-nya adalah java_single_jar sebagai gantinya.
|
deploy_env
|
Daftar label; default-nya adalah java_binary lainnya 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 deployment) dari biner ini yang dibagikan antara biner ini dan target yang ditentukan di deploy_env .
|
deploy_manifest_lines
|
Daftar string; default-nya adalah META-INF/manifest.mf yang dihasilkan untuk
target *_deploy.jar . Konten atribut ini tidak tunduk
pada penggantian "Buat variabel".
|
javacopts
|
Daftar string; default-nya adalah Opsi compiler ini diteruskan ke javac setelah opsi compiler global. |
jvm_flags
|
Daftar string; default-nya adalah 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 yang diikuti dengan Perhatikan bahwa atribut ini tidak berpengaruh pada output
|
launcher
|
Label; default-nya adalah bin/java normal yang disertakan dengan JDK.
Target harus berupa cc_binary . Setiap cc_binary yang menerapkan
Java Invocation API dapat ditentukan sebagai nilai untuk atribut ini.
Secara default, Bazel akan menggunakan peluncur JDK normal (bin/java atau java.exe). Flag Bazel Perhatikan bahwa dependensi native (C++, SWIG, JNI) Anda akan di-build secara berbeda bergantung pada apakah Anda menggunakan peluncur JDK atau peluncur lain:
Saat menggunakan peluncur selain peluncur JDK default, format
output |
main_class
|
String; default-nya adalah main() yang akan digunakan sebagai titik entri.
Jika menggunakan opsi ini, aturan tidak memerlukan daftar srcs=[...] .
Dengan demikian, 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 |
neverlink
|
Boolean; default-nya adalah |
plugins
|
Daftar label; default-nya adalah java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini
di-build. Library juga dapat mewarisi plugin dari dependensi yang menggunakan
exported_plugins . Resource
yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan dari aturan ini.
|
resource_strip_prefix
|
String; default-nya adalah
Jika ditentukan, awalan jalur ini akan dihapus dari setiap file dalam atribut
|
runtime_deps
|
Daftar label; default-nya adalah deps biasa, class ini akan muncul di classpath runtime, tetapi tidak seperti
deps biasa, tidak muncul di 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; default-nya adalah
Biner yang dicap tidak akan di-build ulang kecuali jika dependensinya berubah. |
use_launcher
|
Boolean; default-nya adalah Jika atribut ini disetel ke salah (false),
atribut launcher dan flag
|
use_testrunner
|
Boolean; default-nya adalah com.google.testing.junit.runner.BazelTestRunner
secara default) sebagai
titik entri utama untuk program Java, dan berikan class pengujian
ke 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 mungkin tidak ingin melakukannya. Salah satu penggunaannya adalah untuk aturan AllTest
yang dipanggil oleh aturan lain (misalnya, untuk menyiapkan database
sebelum menjalankan pengujian). Aturan AllTest
harus dideklarasikan sebagai java_binary , tetapi harus
tetap menggunakan runner pengujian sebagai titik entri utamanya.
Nama class runner pengujian dapat diganti dengan atribut main_class .
|
java_import
Melihat sumber aturanjava_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 memungkinkan penggunaan file .jar
yang telah dikompilasi sebelumnya 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 Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah |
data
|
Daftar label; default-nya adalah |
add_exports
|
Daftar string; default-nya adalah module atau package yang diberikan.
Ini sesuai dengan flag javac dan JVM --add-exports=. |
add_opens
|
Daftar string; default-nya adalah module atau
package yang diberikan secara reflektif.
Ini sesuai dengan flag javac dan JVM --add-opens=. |
constraints
|
Daftar string; default-nya adalah |
exports
|
Daftar label; default-nya adalah |
jars
|
Daftar label; wajib diisi Daftar file JAR yang disediakan ke target Java yang bergantung pada target ini. |
neverlink
|
Boolean; default-nya adalah tools.jar untuk apa pun yang berjalan di
JDK standar.
|
proguard_specs
|
Daftar label; default-nya adalah android_binary apa pun yang bergantung pada library ini.
File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarn,
assumenosideeffects, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di
proguard_specs android_binary , untuk memastikan penggabungan non-tautologis.
|
runtime_deps
|
Daftar label; default-nya adalah |
srcjar
|
Label; default-nya adalah |
java_library
Melihat sumber aturanjava_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 Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah deps di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
Jar yang dibuat oleh aturan
Sebaliknya, target dalam atribut |
srcs
|
Daftar label; default-nya adalah
File sumber jenis
File sumber jenis
Aturan: jika aturan (biasanya
File sumber jenis Semua file lainnya akan diabaikan, selama ada setidaknya satu file dari jenis file yang dijelaskan di atas. Jika tidak, error akan ditampilkan.
Argumen ini hampir selalu diperlukan, kecuali jika Anda menentukan argumen |
data
|
Daftar label; default-nya adalah data di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
Saat mem-build |
resources
|
Daftar label; default-nya adalah Resource dapat berupa file sumber atau file yang dihasilkan.
Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file
|
add_exports
|
Daftar string; default-nya adalah module atau package yang diberikan.
Ini sesuai dengan flag javac dan JVM --add-exports=. |
add_opens
|
Daftar string; default-nya adalah module atau
package yang diberikan secara reflektif.
Ini sesuai dengan flag javac dan JVM --add-opens=. |
bootclasspath
|
Label; default-nya adalah |
exported_plugins
|
Daftar label; default-nya adalah java_plugin (misalnya, pemroses
anotasi) untuk diekspor ke library yang secara langsung bergantung pada library ini.
Daftar |
exports
|
Daftar label; default-nya adalah
Mencantumkan aturan di sini akan membuatnya tersedia untuk aturan induk, seolah-olah induk secara eksplisit
bergantung pada aturan ini. Hal ini tidak berlaku untuk
Ringkasan: aturan X dapat mengakses kode di Y jika ada jalur dependensi
di antara keduanya yang dimulai dengan tepi
Asumsikan A bergantung pada B dan B bergantung pada C. Dalam hal ini,
C adalah dependensi transitif dari A, sehingga mengubah sumber C dan mem-build ulang A akan
mem-build ulang semuanya dengan benar. Namun, A tidak akan dapat menggunakan class di C. Untuk mengizinkan
hal itu, A harus mendeklarasikan C dalam 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, dan juga mengekspor C, tetapi tidak mengekspor D. Sekarang A memiliki akses ke C, tetapi tidak ke D. Sekarang, jika C dan D mengekspor beberapa library, yaitu C' dan D', A hanya dapat mengakses C', tetapi tidak dapat mengakses D'.
Penting: aturan yang diekspor bukan merupakan dependensi reguler. Sesuai dengan contoh sebelumnya,
jika B mengekspor C dan juga ingin menggunakan C, B harus mencantumkannya dalam
|
javabuilder_jvm_flags
|
Daftar string; default-nya adalah |
javacopts
|
Daftar string; default-nya adalah Opsi compiler ini diteruskan ke javac setelah opsi compiler global. |
neverlink
|
Boolean; default-nya adalah tools.jar untuk apa pun
yang berjalan di JDK standar.
Perhatikan bahwa Jika library runtime berbeda dengan library kompilasi, Anda harus memastikan bahwa library tersebut hanya berbeda di tempat JLS melarang compiler untuk melakukan inline (dan hal ini harus berlaku untuk semua versi JLS mendatang). |
plugins
|
Daftar label; default-nya adalah java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini
di-build. Library juga dapat mewarisi plugin dari dependensi yang menggunakan
exported_plugins . Resource
yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan dari aturan ini.
|
proguard_specs
|
Daftar label; default-nya adalah android_binary apa pun yang bergantung pada library ini.
File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarn,
assumenosideeffects, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di
proguard_specs android_binary , untuk memastikan penggabungan non-tautologis.
|
resource_strip_prefix
|
String; default-nya adalah
Jika ditentukan, awalan jalur ini akan dihapus dari setiap file dalam atribut
|
runtime_deps
|
Daftar label; default-nya adalah deps biasa, class ini akan muncul di classpath runtime, tetapi tidak seperti
deps biasa, tidak muncul di 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_test
Melihat sumber aturanjava_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 di-build jika diminta secara eksplisit.) Lihat deskripsi outputname_deploy.jar
dari java_binary untuk mengetahui detail selengkapnya.
Lihat bagian tentang argumen java_binary()
. Aturan ini juga
mendukung semua atribut yang 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 Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah deps di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
|
srcs
|
Daftar label; default-nya adalah
File sumber jenis
File sumber jenis
Aturan: jika aturan (biasanya
Argumen ini hampir selalu diperlukan, kecuali jika
atribut |
data
|
Daftar label; default-nya adalah data
di Atribut umum yang ditentukan oleh
sebagian besar aturan build.
|
resources
|
Daftar label; default-nya adalah Resource dapat berupa file sumber atau file yang dihasilkan.
Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file
|
add_exports
|
Daftar string; default-nya adalah module atau package yang diberikan.
Ini sesuai dengan flag javac dan JVM --add-exports=. |
add_opens
|
Daftar string; default-nya adalah module atau
package yang diberikan secara reflektif.
Ini sesuai dengan flag javac dan JVM --add-opens=. |
bootclasspath
|
Label; default-nya adalah |
classpath_resources
|
Daftar label; default-nya adalah
Daftar resource yang harus berada di root hierarki java. Satu-satunya tujuan
atribut ini adalah untuk mendukung library pihak ketiga yang mewajibkan resource-nya
ditemukan di classpath persis seperti |
create_executable
|
Boolean; default-nya adalah java_single_jar .
|
deploy_manifest_lines
|
Daftar string; default-nya adalah META-INF/manifest.mf yang dihasilkan untuk
target *_deploy.jar . Konten atribut ini tidak tunduk
pada penggantian "Buat variabel".
|
javacopts
|
Daftar string; default-nya adalah Opsi compiler ini diteruskan ke javac setelah opsi compiler global. |
jvm_flags
|
Daftar string; default-nya adalah 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 yang diikuti dengan Perhatikan bahwa atribut ini tidak berpengaruh pada output
|
launcher
|
Label; default-nya adalah bin/java normal yang disertakan dengan JDK.
Target harus berupa cc_binary . Setiap cc_binary yang menerapkan
Java Invocation API dapat ditentukan sebagai nilai untuk atribut ini.
Secara default, Bazel akan menggunakan peluncur JDK normal (bin/java atau java.exe). Flag Bazel Perhatikan bahwa dependensi native (C++, SWIG, JNI) Anda akan di-build secara berbeda bergantung pada apakah Anda menggunakan peluncur JDK atau peluncur lain:
Saat menggunakan peluncur selain peluncur JDK default, format
output |
main_class
|
String; default-nya adalah main() yang akan digunakan sebagai titik entri.
Jika menggunakan opsi ini, aturan tidak memerlukan daftar srcs=[...] .
Dengan demikian, 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 |
neverlink
|
Boolean; default-nya adalah |
plugins
|
Daftar label; default-nya adalah java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini
di-build. Library juga dapat mewarisi plugin dari dependensi yang menggunakan
exported_plugins . Resource
yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan dari aturan ini.
|
resource_strip_prefix
|
String; default-nya adalah
Jika ditentukan, awalan jalur ini akan dihapus dari setiap file dalam atribut
|
runtime_deps
|
Daftar label; default-nya adalah deps biasa, class ini akan muncul di classpath runtime, tetapi tidak seperti
deps biasa, tidak muncul di 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; default-nya adalah
Biner yang dicap tidak akan di-build ulang kecuali jika dependensinya berubah. |
test_class
|
String; default-nya adalah
Secara default, jika argumen ini tidak ditentukan, mode lama akan digunakan dan argumen pengujian akan digunakan. Tetapkan tanda
Atribut ini menentukan nama class Java yang akan dijalankan oleh
pengujian ini. Anda jarang perlu menetapkannya. Jika dihilangkan,
argumen ini akan disimpulkan menggunakan
Untuk JUnit3, class pengujian harus berupa subclass dari
Atribut ini memungkinkan beberapa aturan |
use_launcher
|
Boolean; default-nya adalah Jika atribut ini disetel ke salah (false),
atribut launcher dan flag
|
use_testrunner
|
Boolean; default-nya adalah com.google.testing.junit.runner.BazelTestRunner
secara default) sebagai
titik entri utama untuk program Java, dan berikan class pengujian
ke 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 mungkin tidak ingin melakukannya. Salah satu penggunaannya adalah untuk aturan AllTest
yang dipanggil oleh aturan lain (misalnya, untuk menyiapkan database
sebelum menjalankan pengujian). Aturan AllTest
harus dideklarasikan sebagai java_binary , tetapi harus
tetap menggunakan runner pengujian sebagai titik entri utamanya.
Nama class runner pengujian dapat diganti dengan atribut main_class .
|
java_package_configuration
Melihat sumber aturanjava_package_configuration(name, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, javacopts, output_licenses, packages, restricted_to, system, 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 Nama unik untuk target ini. |
data
|
Daftar label; default-nya adalah |
javacopts
|
Daftar string; default-nya adalah |
output_licenses
|
Daftar string; default-nya adalah |
packages
|
Daftar label; default-nya adalah package_group yang akan menjadi tempat penerapan konfigurasi.
|
system
|
Label; default-nya adalah |
java_plugin
Melihat sumber aturanjava_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. Jenis plugin
yang didukung hanyalah pemroses anotasi. Aturan java_library
atau java_binary
dapat menjalankan plugin dengan bergantung pada plugin tersebut melalui atribut plugins
. java_library
juga dapat otomatis mengekspor plugin ke library yang
secara langsung bergantung padanya menggunakan
exported_plugins
.
Target output implisit
libname.jar
: Arsip Java.
Argumen identik dengan java_library
, kecuali
penambahan argumen processor_class
.
Argumen
Atribut | |
---|---|
name |
Nama; wajib Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah deps di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
Jar yang dibuat oleh aturan
Sebaliknya, target dalam atribut |
srcs
|
Daftar label; default-nya adalah
File sumber jenis
File sumber jenis
Aturan: jika aturan (biasanya
File sumber jenis Semua file lainnya akan diabaikan, selama ada setidaknya satu file dari jenis file yang dijelaskan di atas. Jika tidak, error akan ditampilkan.
Argumen ini hampir selalu diperlukan, kecuali jika Anda menentukan argumen |
data
|
Daftar label; default-nya adalah data di
Atribut umum yang ditentukan oleh
sebagian besar aturan build.
Saat mem-build |
resources
|
Daftar label; default-nya adalah Resource dapat berupa file sumber atau file yang dihasilkan.
Jika ditentukan, resource akan dipaketkan dalam jar bersama dengan file
|
add_exports
|
Daftar string; default-nya adalah module atau package yang diberikan.
Ini sesuai dengan flag javac dan JVM --add-exports=. |
add_opens
|
Daftar string; default-nya adalah module atau
package yang diberikan secara reflektif.
Ini sesuai dengan flag javac dan JVM --add-opens=. |
bootclasspath
|
Label; default-nya adalah |
generates_api
|
Boolean; default-nya adalah Jika aturan menggunakan pemroses anotasi pembuat API, aturan lain yang bergantung padanya hanya dapat merujuk ke kode yang dihasilkan jika tindakan kompilasi dijadwalkan setelah aturan pembuat. Atribut ini menginstruksikan Bazel untuk memperkenalkan batasan penjadwalan saat --java_header_compilation diaktifkan. PERINGATAN: Atribut ini memengaruhi performa build, gunakan hanya jika diperlukan. |
javabuilder_jvm_flags
|
Daftar string; default-nya adalah |
javacopts
|
Daftar string; default-nya adalah Opsi compiler ini diteruskan ke javac setelah opsi compiler global. |
neverlink
|
Boolean; default-nya adalah tools.jar untuk apa pun
yang berjalan di JDK standar.
Perhatikan bahwa Jika library runtime berbeda dengan library kompilasi, Anda harus memastikan bahwa library tersebut hanya berbeda di tempat JLS melarang compiler untuk melakukan inline (dan hal ini harus berlaku untuk semua versi JLS mendatang). |
output_licenses
|
Daftar string; default-nya adalah |
plugins
|
Daftar label; default-nya adalah java_plugin yang ditentukan dalam atribut ini akan dijalankan setiap kali aturan ini
di-build. Library juga dapat mewarisi plugin dari dependensi yang menggunakan
exported_plugins . Resource
yang dihasilkan oleh plugin akan disertakan dalam jar yang dihasilkan dari aturan ini.
|
processor_class
|
String; default-nya adalah |
proguard_specs
|
Daftar label; default-nya adalah android_binary apa pun yang bergantung pada library ini.
File yang disertakan di sini hanya boleh memiliki aturan idempoten, yaitu -dontnote, -dontwarn,
assumenosideeffects, dan aturan yang dimulai dengan -keep. Opsi lain hanya dapat muncul di
proguard_specs android_binary , untuk memastikan penggabungan non-tautologis.
|
resource_strip_prefix
|
String; default-nya adalah
Jika ditentukan, awalan jalur ini akan dihapus dari setiap file dalam atribut
|
java_runtime
Melihat sumber aturanjava_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 Nama unik untuk target ini. |
srcs
|
Daftar label; default-nya adalah |
default_cds
|
Label; default-nya adalah java_runtime hermetis. Jika hermetis
diaktifkan untuk target java_binary , CDS default
java_runtime akan dikemas dalam JAR deployment hermetis.
|
hermetic_srcs
|
Daftar label; default-nya adalah |
hermetic_static_libs
|
Daftar label; default-nya adalah |
java
|
Label; default-nya adalah |
java_home
|
String; default-nya adalah srcs dan java harus kosong.
|
lib_ct_sym
|
Label; default-nya adalah --release . Jika tidak ditentukan dan
hanya ada satu file di srcs yang jalurnya berakhir dengan
/lib/ct.sym , file tersebut akan digunakan.
|
lib_modules
|
Label; default-nya adalah |
output_licenses
|
Daftar string; default-nya adalah |
version
|
Bilangan bulat; default-nya adalah Runtime.version().feature() .
|
java_single_jar
Melihat sumber aturanjava_single_jar(name, deps, compatible_with, compress, deploy_env, deploy_manifest_lines, deprecation, distribs, exclude_build_data, exec_compatible_with, exec_properties, features, multi_release, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
Argumen
Atribut | |
---|---|
name |
Nama; wajib Nama unik untuk target ini. |
deps
|
Daftar label; default-nya adalah |
compress
|
String; default-nya adalah |
deploy_env
|
Daftar label; default-nya adalah |
deploy_manifest_lines
|
Daftar string; default-nya adalah META-INF/manifest.mf .
|
exclude_build_data
|
Boolean; default-nya adalah |
multi_release
|
Boolean; default-nya adalah |
java_toolchain
Melihat sumber aturanjava_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, 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 boleh menulis aturan semacam itu kecuali jika ingin menyesuaikan 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 Nama unik untuk target ini. |
android_lint_data
|
Daftar label; default-nya adalah |
android_lint_jvm_opts
|
Daftar string; default-nya adalah |
android_lint_opts
|
Daftar string; default-nya adalah |
android_lint_package_configuration
|
Daftar label; default-nya adalah |
android_lint_runner
|
Label; default-nya adalah |
bootclasspath
|
Daftar label; default-nya adalah |
compatible_javacopts
|
null; default-nya adalah |
deps_checker
|
Label; default-nya adalah |
forcibly_disable_header_compilation
|
Boolean; default-nya adalah |
genclass
|
Label; default-nya adalah |
header_compiler
|
Label; default-nya adalah |
header_compiler_builtin_processors
|
Daftar string; default-nya adalah |
header_compiler_direct
|
Label; default-nya adalah Alat ini tidak mendukung pemrosesan anotasi. |
ijar
|
Label; default-nya adalah |
jacocorunner
|
Label; default-nya adalah |
java_runtime
|
Label; default-nya adalah |
javabuilder
|
Label; default-nya adalah |
javabuilder_data
|
Daftar label; default-nya adalah |
javabuilder_jvm_opts
|
Daftar string; default-nya adalah |
javac_supports_multiplex_workers
|
Boolean; default-nya adalah |
javac_supports_worker_cancellation
|
Boolean; default-nya adalah |
javac_supports_worker_multiplex_sandboxing
|
Boolean; default-nya adalah |
javac_supports_workers
|
Boolean; default-nya adalah |
javacopts
|
Daftar string; default-nya adalah |
jspecify_implicit_deps
|
Label; default-nya adalah |
jspecify_javacopts
|
Daftar string; default-nya adalah |
jspecify_packages
|
Daftar label; default-nya adalah |
jspecify_processor
|
Label; default-nya adalah |
jspecify_processor_class
|
String; default-nya adalah |
jspecify_stubs
|
Daftar label; default-nya adalah |
jvm_opts
|
Daftar string; default-nya adalah |
misc
|
Daftar string; default-nya adalah |
oneversion
|
Label; default-nya adalah |
oneversion_allowlist
|
Label; default-nya adalah |
oneversion_allowlist_for_tests
|
Label; default-nya adalah |
oneversion_whitelist
|
Label; default-nya adalah |
package_configuration
|
Daftar label; default-nya adalah |
proguard_allowlister
|
Label; default-nya adalah |
reduced_classpath_incompatible_processors
|
Daftar string; default-nya adalah |
singlejar
|
Label; default-nya adalah |
source_version
|
String; default-nya adalah |
target_version
|
String; default-nya adalah |
timezone_data
|
Label; default-nya adalah |
tools
|
Daftar label; default-nya adalah |
turbine_data
|
Daftar label; default-nya adalah |
turbine_jvm_opts
|
Daftar string; default-nya adalah |
xlint
|
Daftar string; default-nya adalah |