Quy tắc Java

Báo cáo vấn đề Xem nguồn Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Quy tắc

• java_binary
• java_import
• java_library
• java_test
• java_package_configuration
• java_plugin
• java_runtime
• java_toolchain

java_binary

Xem nguồn quy tắc

java_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)

Tạo một tệp lưu trữ Java ("tệp jar"), cùng với một tập lệnh shell trình bao bọc có cùng tên với quy tắc. Tập lệnh shell của trình bao bọc sử dụng một đường dẫn lớp bao gồm, trong số những thứ khác, một tệp jar cho mỗi thư viện mà tệp nhị phân phụ thuộc vào. Khi chạy tập lệnh shell trình bao bọc, mọi biến môi trường JAVABIN không trống sẽ được ưu tiên hơn phiên bản được chỉ định thông qua cờ --java_runtime_version của Bazel.

Tập lệnh trình bao bọc chấp nhận một số cờ duy nhất. Tham khảo //src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt để biết danh sách các cờ có thể định cấu hình và biến môi trường mà trình bao bọc chấp nhận.

Mục tiêu đầu ra ngầm ẩn

• name.jar: Tệp lưu trữ Java, chứa các tệp lớp và tài nguyên khác tương ứng với các phần phụ thuộc trực tiếp của tệp nhị phân.
• name-src.jar: Một tệp lưu trữ chứa các nguồn ("jar nguồn").
• name_deploy.jar: Tệp lưu trữ Java phù hợp để triển khai (chỉ được tạo nếu được yêu cầu rõ ràng).

  Việc tạo mục tiêu <name>_deploy.jar cho quy tắc của bạn sẽ tạo một tệp jar độc lập có tệp kê khai cho phép chạy tệp đó bằng lệnh java -jar hoặc bằng tuỳ chọn --singlejar của tập lệnh trình bao bọc. Bạn nên sử dụng tập lệnh trình bao bọc thay vì java -jar vì tập lệnh này cũng truyền cờ JVM và các tuỳ chọn để tải thư viện gốc.

  Tệp jar triển khai chứa tất cả các lớp mà trình tải lớp sẽ tìm thấy khi tìm kiếm đường dẫn lớp từ đầu đến cuối của tập lệnh trình bao bọc của tệp nhị phân. Tệp này cũng chứa các thư viện gốc cần thiết cho các phần phụ thuộc. Các tệp này được tự động tải vào JVM trong thời gian chạy.

  Nếu mục tiêu của bạn chỉ định thuộc tính trình chạy, thì thay vì là tệp JAR thông thường, _deploy.jar sẽ là tệp nhị phân gốc. Tệp này sẽ chứa trình chạy cùng với mọi phần phụ thuộc gốc (C++) của quy tắc, tất cả đều được liên kết thành một tệp nhị phân tĩnh. Các byte của tệp jar thực tế sẽ được thêm vào tệp nhị phân gốc đó, tạo ra một blob nhị phân duy nhất chứa cả tệp thực thi và mã Java. Bạn có thể trực tiếp thực thi tệp jar thu được như cách bạn thực thi bất kỳ tệp nhị phân gốc nào.

• name_deploy-src.jar: Một tệp lưu trữ chứa các nguồn được thu thập từ tập hợp đóng bắc cầu của mục tiêu. Các tệp này sẽ khớp với các lớp trong deploy.jar, ngoại trừ trường hợp các tệp jar không có tệp jar nguồn khớp.

Bạn nên sử dụng tên của tệp nguồn là điểm truy cập chính của ứng dụng (trừ phần đuôi). Ví dụ: nếu điểm truy cập của bạn có tên là Main.java, thì tên của bạn có thể là Main.

Không được phép sử dụng thuộc tính deps trong quy tắc java_binary mà không có srcs; quy tắc như vậy yêu cầu main_class do runtime_deps cung cấp.

Đoạn mã sau đây minh hoạ một lỗi thường gặp:

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

Thay vào đó, hãy làm như sau:

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

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách các thư viện khác cần được liên kết với mục tiêu. Xem các nhận xét chung về deps tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
srcs	Danh sách nhãn; mặc định là [] Danh sách các tệp nguồn được xử lý để tạo mục tiêu. Thuộc tính này hầu như luôn bắt buộc; hãy xem các trường hợp ngoại lệ bên dưới. Các tệp nguồn thuộc loại .java được biên dịch. Trong trường hợp tệp .java được tạo, bạn nên đặt tên của quy tắc tạo ở đây thay vì tên của chính tệp. Điều này không chỉ giúp cải thiện khả năng đọc mà còn giúp quy tắc linh hoạt hơn trước các thay đổi trong tương lai: nếu quy tắc tạo tạo ra nhiều tệp trong tương lai, bạn chỉ cần sửa một nơi: outs của quy tắc tạo. Bạn không nên liệt kê quy tắc tạo trong deps vì quy tắc này không có tác dụng. Các tệp nguồn thuộc loại .srcjar được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một tập hợp tệp .java bằng genrule.) Quy tắc: nếu quy tắc (thường là genrule hoặc filegroup) tạo bất kỳ tệp nào được liệt kê ở trên, thì các tệp đó sẽ được sử dụng theo cách tương tự như mô tả cho tệp nguồn. Đối số này gần như luôn bắt buộc, ngoại trừ trường hợp thuộc tính main_class chỉ định một lớp trên đường dẫn lớp thời gian chạy hoặc bạn chỉ định đối số runtime_deps.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà thư viện này cần trong thời gian chạy. Xem các nhận xét chung về data tại Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
resources	Danh sách nhãn; mặc định là [] Danh sách tệp dữ liệu cần đưa vào tệp jar Java. Tài nguyên có thể là tệp nguồn hoặc tệp được tạo. Nếu được chỉ định, các tài nguyên sẽ được đóng gói trong tệp jar cùng với các tệp .class thông thường do quá trình biên dịch tạo ra. Vị trí của tài nguyên bên trong tệp jar được xác định theo cấu trúc dự án. Trước tiên, Bazel tìm bố cục thư mục chuẩn của Maven (thư mục "src" theo sau là thư mục con "resources"). Nếu không tìm thấy thư mục đó, Bazel sẽ tìm thư mục trên cùng có tên "java" hoặc "javatests" (ví dụ: nếu một tài nguyên nằm ở <workspace root>/x/java/y/java/z, thì đường dẫn của tài nguyên đó sẽ là y/java/z. Bạn không thể ghi đè phương thức tìm kiếm phỏng đoán này, tuy nhiên, bạn có thể sử dụng thuộc tính resource_strip_prefix để chỉ định một thư mục thay thế cụ thể cho các tệp tài nguyên.
add_exports	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-exports=.
add_opens	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập phản chiếu vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-opens=.
bootclasspath	Nhãn; mặc định là None API bị hạn chế, không được sử dụng!
classpath_resources	Danh sách nhãn; mặc định là [] ĐỪNG SỬ DỤNG LỰA CHỌN NÀY TRỪ KHI KHÔNG CÓ CÁCH KHÁC) Danh sách các tài nguyên phải nằm ở gốc của cây java. Mục đích duy nhất của thuộc tính này là hỗ trợ các thư viện bên thứ ba yêu cầu tài nguyên của chúng phải được tìm thấy trên đường dẫn lớp chính xác là "myconfig.xml". Bạn chỉ được phép sử dụng trên các tệp nhị phân chứ không được phép sử dụng trên thư viện do nguy cơ xung đột không gian tên.
create_executable	Boolean; mặc định là True Không dùng nữa, hãy sử dụng java_single_jar.
deploy_env	Danh sách nhãn; mặc định là [] Danh sách các mục tiêu java_binary khác đại diện cho môi trường triển khai của tệp nhị phân này. Đặt thuộc tính này khi tạo trình bổ trợ sẽ được tải bằng một java_binary khác. Việc đặt thuộc tính này sẽ loại trừ tất cả phần phụ thuộc khỏi đường dẫn lớp thời gian chạy (và tệp jar triển khai) của tệp nhị phân này được chia sẻ giữa tệp nhị phân này và các mục tiêu được chỉ định trong deploy_env.
deploy_manifest_lines	Danh sách chuỗi; mặc định là [] Danh sách các dòng cần thêm vào tệp META-INF/manifest.mf được tạo cho mục tiêu *_deploy.jar. Nội dung của thuộc tính này không phải tuân theo quy tắc thay thế "Tạo biến".
javacopts	Danh sách chuỗi; mặc định là [] Các tuỳ chọn bổ sung của trình biên dịch cho tệp nhị phân này. Chịu sự thay thế "Tạo biến" và tạo mã thông báo shell Bourne. Các tuỳ chọn trình biên dịch này được truyền đến javac sau các tuỳ chọn trình biên dịch toàn cục.
jvm_flags	Danh sách chuỗi; mặc định là [] Danh sách cờ để nhúng vào tập lệnh trình bao bọc được tạo để chạy tệp nhị phân này. Chịu sự thay thế của $(location) và "Tạo biến", cũng như tạo mã thông báo shell Bourne. Tập lệnh trình bao bọc cho tệp nhị phân Java bao gồm định nghĩa CLASSPATH (để tìm tất cả các tệp jar phụ thuộc) và gọi trình thông dịch Java phù hợp. Dòng lệnh do tập lệnh trình bao bọc tạo ra bao gồm tên của lớp chính, theo sau là "$@" để bạn có thể truyền các đối số khác sau tên lớp. Tuy nhiên, các đối số dành cho việc phân tích cú pháp của JVM phải được chỉ định trước tên lớp trên dòng lệnh. Nội dung của jvm_flags được thêm vào tập lệnh trình bao bọc trước khi liệt kê tên lớp. Lưu ý rằng thuộc tính này không ảnh hưởng đến đầu ra *_deploy.jar.
launcher	Nhãn; mặc định là None Chỉ định một tệp nhị phân sẽ được dùng để chạy chương trình Java thay vì chương trình bin/java thông thường đi kèm với JDK. Mục tiêu phải là cc_binary. Bạn có thể chỉ định bất kỳ cc_binary nào triển khai Java Invocation API làm giá trị cho thuộc tính này. Theo mặc định, Bazel sẽ sử dụng trình chạy JDK thông thường (bin/java hoặc java.exe). Cờ Bazel --java_launcher có liên quan chỉ ảnh hưởng đến các mục tiêu java_binary và java_test chưa chỉ định thuộc tính launcher. Xin lưu ý rằng các phần phụ thuộc gốc (C++, SWIG, JNI) sẽ được tạo theo cách khác nhau tuỳ thuộc vào việc bạn đang sử dụng trình chạy JDK hay một trình chạy khác: Nếu bạn đang sử dụng trình chạy JDK thông thường (mặc định), các phần phụ thuộc gốc sẽ được tạo dưới dạng thư viện dùng chung có tên {name}_nativedeps.so, trong đó {name} là thuộc tính name của quy tắc java_binary này. Trình liên kết không xoá mã không sử dụng trong cấu hình này. Nếu bạn đang sử dụng trình chạy nào khác, các phần phụ thuộc gốc (C++) sẽ được liên kết tĩnh vào một tệp nhị phân có tên {name}_nativedeps, trong đó {name} là thuộc tính name của quy tắc java_binary này. Trong trường hợp này, trình liên kết sẽ xoá mọi mã mà trình liên kết cho là không sử dụng từ tệp nhị phân thu được, nghĩa là mọi mã C++ chỉ truy cập được qua JNI có thể không được liên kết trừ phi mục tiêu cc_library đó chỉ định alwayslink = True. Khi sử dụng trình chạy nào khác ngoài trình chạy JDK mặc định, định dạng của đầu ra *_deploy.jar sẽ thay đổi. Hãy xem tài liệu chính về java_binary để biết thông tin chi tiết.
main_class	Chuỗi; mặc định là "" Tên lớp có phương thức main() để sử dụng làm điểm truy cập. Nếu một quy tắc sử dụng tuỳ chọn này, thì quy tắc đó không cần danh sách srcs=[...]. Do đó, với thuộc tính này, bạn có thể tạo một tệp thực thi từ một thư viện Java đã chứa một hoặc nhiều phương thức main(). Giá trị của thuộc tính này là tên lớp, chứ không phải tệp nguồn. Lớp phải có sẵn trong thời gian chạy: lớp này có thể được biên dịch theo quy tắc này (từ srcs) hoặc do các phần phụ thuộc trực tiếp hoặc bắc cầu cung cấp (thông qua runtime_deps hoặc deps). Nếu lớp không có sẵn, tệp nhị phân sẽ không hoạt động trong thời gian chạy; không có quy trình kiểm tra thời gian xây dựng.
neverlink	Boolean; mặc định là False
plugins	Danh sách nhãn; mặc định là [] Trình bổ trợ trình biên dịch Java để chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính này sẽ được chạy bất cứ khi nào quy tắc này được tạo. Thư viện cũng có thể kế thừa các trình bổ trợ từ các phần phụ thuộc sử dụng exported_plugins. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar thu được của quy tắc này.
resource_strip_prefix	Chuỗi; mặc định là "" Tiền tố đường dẫn cần xoá khỏi tài nguyên Java. Nếu được chỉ định, tiền tố đường dẫn này sẽ bị xoá khỏi mọi tệp trong thuộc tính resources. Lỗi xảy ra khi tệp tài nguyên không nằm trong thư mục này. Nếu bạn không chỉ định (mặc định), đường dẫn của tệp tài nguyên sẽ được xác định theo logic giống như gói Java của các tệp nguồn. Ví dụ: tệp nguồn tại stuff/java/foo/bar/a.txt sẽ nằm tại foo/bar/a.txt.
runtime_deps	Danh sách nhãn; mặc định là [] Thư viện chỉ cung cấp cho tệp nhị phân hoặc kiểm thử cuối cùng trong thời gian chạy. Giống như deps thông thường, các tệp này sẽ xuất hiện trên đường dẫn lớp thời gian chạy, nhưng không giống như các tệp đó, không xuất hiện trên đường dẫn lớp thời gian biên dịch. Bạn chỉ nên liệt kê các phần phụ thuộc cần thiết tại thời gian chạy tại đây. Các công cụ phân tích phần phụ thuộc phải bỏ qua các mục tiêu xuất hiện trong cả runtime_deps và deps.
stamp	Số nguyên; mặc định là -1 Có mã hoá thông tin bản dựng vào tệp nhị phân hay không. Các giá trị có thể là: stamp = 1: Luôn đóng dấu thông tin bản dựng vào tệp nhị phân, ngay cả trong các bản dựng --nostamp. Bạn nên tránh chế độ cài đặt này vì chế độ này có thể huỷ kích hoạt tính năng lưu vào bộ nhớ đệm từ xa cho tệp nhị phân và mọi thao tác tiếp theo phụ thuộc vào tệp nhị phân đó. stamp = 0: Luôn thay thế thông tin bản dựng bằng các giá trị không đổi. Điều này giúp lưu kết quả bản dựng vào bộ nhớ đệm hiệu quả. stamp = -1: Việc nhúng thông tin bản dựng được kiểm soát bằng cờ --[no]stamp. Tệp nhị phân được đóng dấu không được tạo lại trừ khi các phần phụ thuộc của tệp đó thay đổi.
use_launcher	Boolean; mặc định là True Tệp nhị phân có nên sử dụng trình chạy tuỳ chỉnh hay không. Nếu bạn đặt thuộc tính này thành false, thuộc tính trình chạy và cờ --java_launcher liên quan sẽ bị bỏ qua cho mục tiêu này.
use_testrunner	Boolean; mặc định là False Sử dụng lớp trình chạy kiểm thử (theo mặc định là com.google.testing.junit.runner.BazelTestRunner) làm điểm truy cập chính cho chương trình Java và cung cấp lớp kiểm thử cho trình chạy kiểm thử dưới dạng giá trị của thuộc tính hệ thống bazel.test_suite. Bạn có thể sử dụng thuộc tính này để ghi đè hành vi mặc định, đó là sử dụng trình chạy kiểm thử cho các quy tắc java_test và không sử dụng cho các quy tắc java_binary. Bạn không nên làm việc này. Một cách sử dụng là dành cho các quy tắc AllTest được một quy tắc khác gọi (ví dụ: để thiết lập cơ sở dữ liệu trước khi chạy kiểm thử). Bạn phải khai báo quy tắc AllTest dưới dạng java_binary, nhưng vẫn phải sử dụng trình chạy kiểm thử làm điểm truy cập chính. Bạn có thể ghi đè tên của lớp trình chạy kiểm thử bằng thuộc tính main_class.

java_import

Xem nguồn quy tắc

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)

Quy tắc này cho phép sử dụng các tệp .jar được biên dịch trước làm thư viện cho các quy tắc java_library và java_binary.

Ví dụ

    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",
        ],
    )

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách các thư viện khác cần được liên kết với mục tiêu. Xem java_library.deps.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà quy tắc này cần trong thời gian chạy.
add_exports	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-exports=.
add_opens	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập phản chiếu vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-opens=.
constraints	Danh sách chuỗi; mặc định là [] Các quy tắc ràng buộc bổ sung được áp dụng cho quy tắc này dưới dạng thư viện Java.
exports	Danh sách nhãn; mặc định là [] Mục tiêu cung cấp cho người dùng của quy tắc này. Xem java_library.exports.
jars	Danh sách nhãn; bắt buộc Danh sách các tệp JAR được cung cấp cho các mục tiêu Java phụ thuộc vào mục tiêu này.
neverlink	Boolean; mặc định là False Chỉ sử dụng thư viện này để biên dịch chứ không phải trong thời gian chạy. Sẽ hữu ích nếu thư viện được môi trường thời gian chạy cung cấp trong quá trình thực thi. Ví dụ về các thư viện như vậy là API IDE cho trình bổ trợ IDE hoặc tools.jar cho mọi thứ chạy trên JDK tiêu chuẩn.
proguard_specs	Danh sách nhãn; mặc định là [] Các tệp sẽ được dùng làm thông số kỹ thuật của Proguard. Các tệp này sẽ mô tả tập hợp thông số kỹ thuật mà Proguard sẽ sử dụng. Nếu được chỉ định, các lớp này sẽ được thêm vào bất kỳ mục tiêu android_binary nào tuỳ thuộc vào thư viện này. Các tệp có trong đây chỉ được có các quy tắc idempotent, cụ thể là -dontnote, -dontwarn, assumenosideeffects và các quy tắc bắt đầu bằng -keep. Các tuỳ chọn khác chỉ có thể xuất hiện trong proguard_specs của android_binary để đảm bảo việc hợp nhất không phải là tự động trùng lặp.
runtime_deps	Danh sách nhãn; mặc định là [] Thư viện chỉ cung cấp cho tệp nhị phân hoặc kiểm thử cuối cùng trong thời gian chạy. Xem java_library.runtime_deps.
srcjar	Nhãn; mặc định là None Tệp JAR chứa mã nguồn cho các tệp JAR đã biên dịch.

java_library

Xem nguồn quy tắc

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)

Quy tắc này biên dịch và liên kết các nguồn vào một tệp .jar.

Đầu ra ngầm

• libname.jar: Tệp lưu trữ Java chứa các tệp lớp.
• libname-src.jar: Một tệp lưu trữ chứa các nguồn ("jar nguồn").

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách thư viện cần liên kết vào thư viện này. Xem các nhận xét chung về deps tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định. Các tệp jar được tạo bằng quy tắc java_library được liệt kê trong deps sẽ nằm trên đường dẫn lớp thời gian biên dịch của quy tắc này. Hơn nữa, tập hợp đóng bắc cầu của deps, runtime_deps và exports sẽ nằm trên đường dẫn lớp thời gian chạy. Ngược lại, các mục tiêu trong thuộc tính data được đưa vào tệp chạy nhưng không có trong đường dẫn lớp thời gian biên dịch hoặc thời gian chạy.
srcs	Danh sách nhãn; mặc định là [] Danh sách các tệp nguồn được xử lý để tạo mục tiêu. Thuộc tính này hầu như luôn bắt buộc; hãy xem các trường hợp ngoại lệ bên dưới. Các tệp nguồn thuộc loại .java được biên dịch. Trong trường hợp tệp .java được tạo, bạn nên đặt tên của quy tắc tạo ở đây thay vì tên của chính tệp. Điều này không chỉ giúp cải thiện khả năng đọc mà còn giúp quy tắc linh hoạt hơn trước các thay đổi trong tương lai: nếu quy tắc tạo tạo ra nhiều tệp trong tương lai, bạn chỉ cần sửa một nơi: outs của quy tắc tạo. Bạn không nên liệt kê quy tắc tạo trong deps vì quy tắc này không có tác dụng. Các tệp nguồn thuộc loại .srcjar được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một tập hợp tệp .java bằng genrule.) Quy tắc: nếu quy tắc (thường là genrule hoặc filegroup) tạo bất kỳ tệp nào được liệt kê ở trên, thì các tệp đó sẽ được sử dụng theo cách tương tự như mô tả cho tệp nguồn. Các tệp nguồn thuộc loại .properties được coi là tài nguyên. Tất cả các tệp khác đều bị bỏ qua, miễn là có ít nhất một tệp thuộc loại tệp được mô tả ở trên. Nếu không, lỗi sẽ được báo cáo. Đối số này hầu như luôn bắt buộc, ngoại trừ trường hợp bạn chỉ định đối số runtime_deps.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà thư viện này cần trong thời gian chạy. Xem các nhận xét chung về data tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định. Khi tạo java_library, Bazel không đặt các tệp này ở bất cứ đâu; nếu tệp data là tệp được tạo thì Bazel sẽ tạo các tệp đó. Khi tạo một chương trình kiểm thử phụ thuộc vào java_library này, Bazel sẽ sao chép hoặc liên kết các tệp data vào vùng runfiles.
resources	Danh sách nhãn; mặc định là [] Danh sách tệp dữ liệu cần đưa vào tệp jar Java. Tài nguyên có thể là tệp nguồn hoặc tệp được tạo. Nếu được chỉ định, các tài nguyên sẽ được đóng gói trong tệp jar cùng với các tệp .class thông thường do quá trình biên dịch tạo ra. Vị trí của tài nguyên bên trong tệp jar được xác định theo cấu trúc dự án. Trước tiên, Bazel tìm bố cục thư mục chuẩn của Maven (thư mục "src" theo sau là thư mục con "resources"). Nếu không tìm thấy thư mục đó, Bazel sẽ tìm thư mục trên cùng có tên "java" hoặc "javatests" (ví dụ: nếu một tài nguyên nằm ở <workspace root>/x/java/y/java/z, thì đường dẫn của tài nguyên đó sẽ là y/java/z. Bạn không thể ghi đè phương thức tìm kiếm phỏng đoán này, tuy nhiên, bạn có thể sử dụng thuộc tính resource_strip_prefix để chỉ định một thư mục thay thế cụ thể cho các tệp tài nguyên.
add_exports	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-exports=.
add_opens	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập phản chiếu vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-opens=.
bootclasspath	Nhãn; mặc định là None API bị hạn chế, không được sử dụng!
exported_plugins	Danh sách nhãn; mặc định là [] Danh sách java_plugin (ví dụ: trình xử lý chú thích) để xuất sang các thư viện trực tiếp phụ thuộc vào thư viện này. Danh sách java_plugin được chỉ định sẽ được áp dụng cho mọi thư viện trực tiếp phụ thuộc vào thư viện này, giống như thư viện đó đã khai báo rõ ràng các nhãn này trong plugins.
exports	Danh sách nhãn; mặc định là [] Thư viện đã xuất. Việc liệt kê các quy tắc ở đây sẽ cung cấp các quy tắc đó cho các quy tắc mẹ, như thể các quy tắc mẹ phụ thuộc rõ ràng vào các quy tắc này. Điều này không đúng với deps thông thường (không được xuất). Tóm tắt: quy tắc X có thể truy cập vào mã trong Y nếu có một đường dẫn phần phụ thuộc giữa chúng bắt đầu bằng một cạnh deps, theo sau là không có hoặc nhiều cạnh exports. Hãy xem một số ví dụ để minh hoạ điều này. Giả sử A phụ thuộc vào B và B phụ thuộc vào C. Trong trường hợp này, C là phần phụ thuộc bắc cầu của A, vì vậy, việc thay đổi nguồn của C và tạo lại A sẽ tạo lại mọi thứ một cách chính xác. Tuy nhiên, A sẽ không thể sử dụng các lớp trong C. Để cho phép điều đó, A phải khai báo C trong deps hoặc B có thể giúp A (và mọi thứ có thể phụ thuộc vào A) dễ dàng hơn bằng cách khai báo C trong thuộc tính exports (của B). Tất cả quy tắc mẹ trực tiếp đều có thể đóng thư viện đã xuất. Hãy xem xét một ví dụ khác một chút: A phụ thuộc vào B, B phụ thuộc vào C và D, đồng thời xuất C nhưng không xuất D. Giờ đây, A có quyền truy cập vào C nhưng không có quyền truy cập vào D. Bây giờ, nếu C và D xuất một số thư viện, C' và D' tương ứng, thì A chỉ có thể truy cập vào C' nhưng không thể truy cập vào D'. Lưu ý quan trọng: quy tắc đã xuất không phải là phần phụ thuộc thông thường. Tiếp tục với ví dụ trước, nếu B xuất C và muốn sử dụng C, thì B cũng phải liệt kê C trong deps của riêng mình.
javabuilder_jvm_flags	Danh sách chuỗi; mặc định là [] API bị hạn chế, không được sử dụng!
javacopts	Danh sách chuỗi; mặc định là [] Các tuỳ chọn trình biên dịch bổ sung cho thư viện này. Chịu sự thay thế "Tạo biến" và tạo mã thông báo shell Bourne. Các tuỳ chọn trình biên dịch này được truyền đến javac sau các tuỳ chọn trình biên dịch toàn cục.
neverlink	Boolean; mặc định là False Liệu thư viện này chỉ nên được dùng để biên dịch chứ không phải trong thời gian chạy. Hữu ích nếu thư viện được môi trường thời gian chạy cung cấp trong quá trình thực thi. Ví dụ về các thư viện như vậy là API IDE cho trình bổ trợ IDE hoặc tools.jar cho mọi thứ chạy trên JDK tiêu chuẩn. Xin lưu ý rằng neverlink = True không ngăn trình biên dịch đưa nội dung từ thư viện này vào các mục tiêu biên dịch phụ thuộc vào thư viện đó, theo quy định của Thông số kỹ thuật ngôn ngữ Java (ví dụ: Hằng số static final của String hoặc của các kiểu dữ liệu nguyên thuỷ). Do đó, trường hợp sử dụng ưu tiên là khi thư viện thời gian chạy giống với thư viện biên dịch. Nếu thư viện thời gian chạy khác với thư viện biên dịch, thì bạn phải đảm bảo rằng thư viện thời gian chạy chỉ khác ở những nơi mà JLS cấm trình biên dịch cùng dòng (và điều đó phải đúng cho tất cả các phiên bản JLS trong tương lai).
plugins	Danh sách nhãn; mặc định là [] Trình bổ trợ trình biên dịch Java để chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính này sẽ được chạy bất cứ khi nào quy tắc này được tạo. Thư viện cũng có thể kế thừa các trình bổ trợ từ các phần phụ thuộc sử dụng exported_plugins. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar thu được của quy tắc này.
proguard_specs	Danh sách nhãn; mặc định là [] Các tệp sẽ được dùng làm thông số kỹ thuật của Proguard. Các tệp này sẽ mô tả tập hợp thông số kỹ thuật mà Proguard sẽ sử dụng. Nếu được chỉ định, các lớp này sẽ được thêm vào bất kỳ mục tiêu android_binary nào tuỳ thuộc vào thư viện này. Các tệp có trong đây chỉ được có các quy tắc idempotent, cụ thể là -dontnote, -dontwarn, assumenosideeffects và các quy tắc bắt đầu bằng -keep. Các tuỳ chọn khác chỉ có thể xuất hiện trong proguard_specs của android_binary để đảm bảo việc hợp nhất không phải là tự động trùng lặp.
resource_strip_prefix	Chuỗi; mặc định là "" Tiền tố đường dẫn cần xoá khỏi tài nguyên Java. Nếu được chỉ định, tiền tố đường dẫn này sẽ bị xoá khỏi mọi tệp trong thuộc tính resources. Lỗi xảy ra khi tệp tài nguyên không nằm trong thư mục này. Nếu bạn không chỉ định (mặc định), đường dẫn của tệp tài nguyên sẽ được xác định theo logic giống như gói Java của các tệp nguồn. Ví dụ: tệp nguồn tại stuff/java/foo/bar/a.txt sẽ nằm tại foo/bar/a.txt.
runtime_deps	Danh sách nhãn; mặc định là [] Thư viện chỉ cung cấp cho tệp nhị phân hoặc kiểm thử cuối cùng trong thời gian chạy. Giống như deps thông thường, các tệp này sẽ xuất hiện trên đường dẫn lớp thời gian chạy, nhưng không giống như các tệp đó, không xuất hiện trên đường dẫn lớp thời gian biên dịch. Bạn chỉ nên liệt kê các phần phụ thuộc cần thiết tại thời gian chạy tại đây. Các công cụ phân tích phần phụ thuộc phải bỏ qua các mục tiêu xuất hiện trong cả runtime_deps và deps.

java_test

Xem nguồn quy tắc

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)

Quy tắc java_test() biên dịch một chương trình kiểm thử Java. Kiểm thử là một trình bao bọc tệp nhị phân xung quanh mã kiểm thử. Phương thức chính của trình chạy kiểm thử được gọi thay vì lớp chính đang được biên dịch.

Mục tiêu đầu ra ngầm ẩn

• name.jar: Tệp lưu trữ Java.
• name_deploy.jar: Tệp lưu trữ Java phù hợp để triển khai. (Chỉ được tạo nếu được yêu cầu rõ ràng.) Hãy xem nội dung mô tả về đầu ra name_deploy.jar từ java_binary để biết thêm chi tiết.

Xem phần về đối số java_binary(). Quy tắc này cũng hỗ trợ tất cả thuộc tính phổ biến cho tất cả quy tắc kiểm thử (*_test).

Ví dụ

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",
    ],
)

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách các thư viện khác cần được liên kết với mục tiêu. Xem các nhận xét chung về deps tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
srcs	Danh sách nhãn; mặc định là [] Danh sách các tệp nguồn được xử lý để tạo mục tiêu. Thuộc tính này hầu như luôn bắt buộc; hãy xem các trường hợp ngoại lệ bên dưới. Các tệp nguồn thuộc loại .java được biên dịch. Trong trường hợp tệp .java được tạo, bạn nên đặt tên của quy tắc tạo ở đây thay vì tên của chính tệp. Điều này không chỉ giúp cải thiện khả năng đọc mà còn giúp quy tắc linh hoạt hơn trước các thay đổi trong tương lai: nếu quy tắc tạo tạo ra nhiều tệp trong tương lai, bạn chỉ cần sửa một nơi: outs của quy tắc tạo. Bạn không nên liệt kê quy tắc tạo trong deps vì quy tắc này không có tác dụng. Các tệp nguồn thuộc loại .srcjar được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một tập hợp tệp .java bằng genrule.) Quy tắc: nếu quy tắc (thường là genrule hoặc filegroup) tạo bất kỳ tệp nào được liệt kê ở trên, thì các tệp đó sẽ được sử dụng theo cách tương tự như mô tả cho tệp nguồn. Đối số này gần như luôn bắt buộc, ngoại trừ trường hợp thuộc tính main_class chỉ định một lớp trên đường dẫn lớp thời gian chạy hoặc bạn chỉ định đối số runtime_deps.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà thư viện này cần trong thời gian chạy. Xem các nhận xét chung về data tại Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
resources	Danh sách nhãn; mặc định là [] Danh sách tệp dữ liệu cần đưa vào tệp jar Java. Tài nguyên có thể là tệp nguồn hoặc tệp được tạo. Nếu được chỉ định, các tài nguyên sẽ được đóng gói trong tệp jar cùng với các tệp .class thông thường do quá trình biên dịch tạo ra. Vị trí của tài nguyên bên trong tệp jar được xác định theo cấu trúc dự án. Trước tiên, Bazel tìm bố cục thư mục chuẩn của Maven (thư mục "src" theo sau là thư mục con "resources"). Nếu không tìm thấy thư mục đó, Bazel sẽ tìm thư mục trên cùng có tên "java" hoặc "javatests" (ví dụ: nếu một tài nguyên nằm ở <workspace root>/x/java/y/java/z, thì đường dẫn của tài nguyên đó sẽ là y/java/z. Bạn không thể ghi đè phương thức tìm kiếm phỏng đoán này, tuy nhiên, bạn có thể sử dụng thuộc tính resource_strip_prefix để chỉ định một thư mục thay thế cụ thể cho các tệp tài nguyên.
add_exports	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-exports=.
add_opens	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập phản chiếu vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-opens=.
bootclasspath	Nhãn; mặc định là None API bị hạn chế, không được sử dụng!
classpath_resources	Danh sách nhãn; mặc định là [] ĐỪNG SỬ DỤNG LỰA CHỌN NÀY TRỪ KHI KHÔNG CÓ CÁCH KHÁC) Danh sách các tài nguyên phải nằm ở gốc của cây java. Mục đích duy nhất của thuộc tính này là hỗ trợ các thư viện bên thứ ba yêu cầu tài nguyên của chúng phải được tìm thấy trên đường dẫn lớp chính xác là "myconfig.xml". Bạn chỉ được phép sử dụng trên các tệp nhị phân chứ không được phép sử dụng trên thư viện do nguy cơ xung đột không gian tên.
create_executable	Boolean; mặc định là True Không dùng nữa, hãy sử dụng java_single_jar.
deploy_manifest_lines	Danh sách chuỗi; mặc định là [] Danh sách các dòng cần thêm vào tệp META-INF/manifest.mf được tạo cho mục tiêu *_deploy.jar. Nội dung của thuộc tính này không phải tuân theo quy tắc thay thế "Tạo biến".
javacopts	Danh sách chuỗi; mặc định là [] Các tuỳ chọn bổ sung của trình biên dịch cho tệp nhị phân này. Chịu sự thay thế "Tạo biến" và tạo mã thông báo shell Bourne. Các tuỳ chọn trình biên dịch này được truyền đến javac sau các tuỳ chọn trình biên dịch toàn cục.
jvm_flags	Danh sách chuỗi; mặc định là [] Danh sách cờ để nhúng vào tập lệnh trình bao bọc được tạo để chạy tệp nhị phân này. Chịu sự thay thế của $(location) và "Tạo biến", cũng như tạo mã thông báo shell Bourne. Tập lệnh trình bao bọc cho tệp nhị phân Java bao gồm định nghĩa CLASSPATH (để tìm tất cả các tệp jar phụ thuộc) và gọi trình thông dịch Java phù hợp. Dòng lệnh do tập lệnh trình bao bọc tạo ra bao gồm tên của lớp chính, theo sau là "$@" để bạn có thể truyền các đối số khác sau tên lớp. Tuy nhiên, các đối số dành cho việc phân tích cú pháp của JVM phải được chỉ định trước tên lớp trên dòng lệnh. Nội dung của jvm_flags được thêm vào tập lệnh trình bao bọc trước khi liệt kê tên lớp. Lưu ý rằng thuộc tính này không ảnh hưởng đến đầu ra *_deploy.jar.
launcher	Nhãn; mặc định là None Chỉ định một tệp nhị phân sẽ được dùng để chạy chương trình Java thay vì chương trình bin/java thông thường đi kèm với JDK. Mục tiêu phải là cc_binary. Bạn có thể chỉ định bất kỳ cc_binary nào triển khai Java Invocation API làm giá trị cho thuộc tính này. Theo mặc định, Bazel sẽ sử dụng trình chạy JDK thông thường (bin/java hoặc java.exe). Cờ Bazel --java_launcher có liên quan chỉ ảnh hưởng đến các mục tiêu java_binary và java_test chưa chỉ định thuộc tính launcher. Xin lưu ý rằng các phần phụ thuộc gốc (C++, SWIG, JNI) sẽ được tạo theo cách khác nhau tuỳ thuộc vào việc bạn đang sử dụng trình chạy JDK hay một trình chạy khác: Nếu bạn đang sử dụng trình chạy JDK thông thường (mặc định), các phần phụ thuộc gốc sẽ được tạo dưới dạng thư viện dùng chung có tên {name}_nativedeps.so, trong đó {name} là thuộc tính name của quy tắc java_binary này. Trình liên kết không xoá mã không sử dụng trong cấu hình này. Nếu bạn đang sử dụng trình chạy nào khác, các phần phụ thuộc gốc (C++) sẽ được liên kết tĩnh vào một tệp nhị phân có tên {name}_nativedeps, trong đó {name} là thuộc tính name của quy tắc java_binary này. Trong trường hợp này, trình liên kết sẽ xoá mọi mã mà trình liên kết cho là không sử dụng từ tệp nhị phân thu được, nghĩa là mọi mã C++ chỉ truy cập được qua JNI có thể không được liên kết trừ phi mục tiêu cc_library đó chỉ định alwayslink = True. Khi sử dụng trình chạy nào khác ngoài trình chạy JDK mặc định, định dạng của đầu ra *_deploy.jar sẽ thay đổi. Hãy xem tài liệu chính về java_binary để biết thông tin chi tiết.
main_class	Chuỗi; mặc định là "" Tên lớp có phương thức main() để sử dụng làm điểm truy cập. Nếu một quy tắc sử dụng tuỳ chọn này, thì quy tắc đó không cần danh sách srcs=[...]. Do đó, với thuộc tính này, bạn có thể tạo một tệp thực thi từ một thư viện Java đã chứa một hoặc nhiều phương thức main(). Giá trị của thuộc tính này là tên lớp, chứ không phải tệp nguồn. Lớp phải có sẵn trong thời gian chạy: lớp này có thể được biên dịch theo quy tắc này (từ srcs) hoặc do các phần phụ thuộc trực tiếp hoặc bắc cầu cung cấp (thông qua runtime_deps hoặc deps). Nếu lớp không có sẵn, tệp nhị phân sẽ không hoạt động trong thời gian chạy; không có quy trình kiểm tra thời gian xây dựng.
neverlink	Boolean; mặc định là False
plugins	Danh sách nhãn; mặc định là [] Trình bổ trợ trình biên dịch Java để chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính này sẽ được chạy bất cứ khi nào quy tắc này được tạo. Thư viện cũng có thể kế thừa các trình bổ trợ từ các phần phụ thuộc sử dụng exported_plugins. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar thu được của quy tắc này.
resource_strip_prefix	Chuỗi; mặc định là "" Tiền tố đường dẫn cần xoá khỏi tài nguyên Java. Nếu được chỉ định, tiền tố đường dẫn này sẽ bị xoá khỏi mọi tệp trong thuộc tính resources. Lỗi xảy ra khi tệp tài nguyên không nằm trong thư mục này. Nếu bạn không chỉ định (mặc định), đường dẫn của tệp tài nguyên sẽ được xác định theo logic giống như gói Java của các tệp nguồn. Ví dụ: tệp nguồn tại stuff/java/foo/bar/a.txt sẽ nằm tại foo/bar/a.txt.
runtime_deps	Danh sách nhãn; mặc định là [] Thư viện chỉ cung cấp cho tệp nhị phân hoặc kiểm thử cuối cùng trong thời gian chạy. Giống như deps thông thường, các tệp này sẽ xuất hiện trên đường dẫn lớp thời gian chạy, nhưng không giống như các tệp đó, không xuất hiện trên đường dẫn lớp thời gian biên dịch. Bạn chỉ nên liệt kê các phần phụ thuộc cần thiết tại thời gian chạy tại đây. Các công cụ phân tích phần phụ thuộc phải bỏ qua các mục tiêu xuất hiện trong cả runtime_deps và deps.
stamp	Số nguyên; mặc định là 0 Có mã hoá thông tin bản dựng vào tệp nhị phân hay không. Các giá trị có thể là: stamp = 1: Luôn đóng dấu thông tin bản dựng vào tệp nhị phân, ngay cả trong các bản dựng --nostamp. Bạn nên tránh chế độ cài đặt này vì chế độ này có thể huỷ kích hoạt tính năng lưu vào bộ nhớ đệm từ xa cho tệp nhị phân và mọi thao tác tiếp theo phụ thuộc vào tệp nhị phân đó. stamp = 0: Luôn thay thế thông tin bản dựng bằng các giá trị không đổi. Điều này giúp lưu kết quả bản dựng vào bộ nhớ đệm hiệu quả. stamp = -1: Việc nhúng thông tin bản dựng được kiểm soát bằng cờ --[no]stamp. Tệp nhị phân được đóng dấu không được tạo lại trừ khi các phần phụ thuộc của tệp đó thay đổi.
test_class	Chuỗi; mặc định là "" Lớp Java sẽ được trình chạy kiểm thử tải. Theo mặc định, nếu không xác định đối số này, chế độ cũ sẽ được sử dụng và các đối số kiểm thử sẽ được sử dụng thay thế. Đặt cờ --nolegacy_bazel_java_test để không sử dụng lại đối số đầu tiên. Thuộc tính này chỉ định tên của một lớp Java sẽ được chạy bằng quy trình kiểm thử này. Bạn hiếm khi cần thiết lập giá trị này. Nếu bạn bỏ qua đối số này, hệ thống sẽ suy luận đối số này bằng cách sử dụng name của mục tiêu và đường dẫn tương đối gốc nguồn của mục tiêu đó. Nếu kiểm thử nằm bên ngoài thư mục gốc nguồn đã biết, Bazel sẽ báo cáo lỗi nếu bạn không đặt test_class. Đối với JUnit3, lớp kiểm thử cần phải là lớp con của junit.framework.TestCase hoặc cần có phương thức suite() tĩnh công khai trả về junit.framework.Test (hoặc lớp con của Test). Đối với JUnit4, lớp cần được chú thích bằng org.junit.runner.RunWith. Thuộc tính này cho phép một số quy tắc java_test chia sẻ cùng một Test (TestCase, TestSuite, ...). Thông thường, thông tin bổ sung sẽ được truyền đến thuộc tính này (ví dụ: thông qua jvm_flags=['-Dkey=value']) để hành vi của thuộc tính này khác nhau trong từng trường hợp, chẳng hạn như chạy một tập hợp con khác của các bài kiểm thử. Thuộc tính này cũng cho phép sử dụng các chương trình kiểm thử Java bên ngoài cây javatests.
use_launcher	Boolean; mặc định là True Tệp nhị phân có nên sử dụng trình chạy tuỳ chỉnh hay không. Nếu bạn đặt thuộc tính này thành false, thuộc tính trình chạy và cờ --java_launcher liên quan sẽ bị bỏ qua cho mục tiêu này.
use_testrunner	Boolean; mặc định là True Sử dụng lớp trình chạy kiểm thử (theo mặc định là com.google.testing.junit.runner.BazelTestRunner) làm điểm truy cập chính cho chương trình Java và cung cấp lớp kiểm thử cho trình chạy kiểm thử dưới dạng giá trị của thuộc tính hệ thống bazel.test_suite. Bạn có thể sử dụng thuộc tính này để ghi đè hành vi mặc định, đó là sử dụng trình chạy kiểm thử cho các quy tắc java_test và không sử dụng cho các quy tắc java_binary. Bạn không nên làm việc này. Một cách sử dụng là dành cho các quy tắc AllTest được một quy tắc khác gọi (ví dụ: để thiết lập cơ sở dữ liệu trước khi chạy kiểm thử). Bạn phải khai báo quy tắc AllTest dưới dạng java_binary, nhưng vẫn phải sử dụng trình chạy kiểm thử làm điểm truy cập chính. Bạn có thể ghi đè tên của lớp trình chạy kiểm thử bằng thuộc tính main_class.

java_package_configuration

Xem nguồn quy tắc

java_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)

Cấu hình để áp dụng cho một nhóm gói. Bạn có thể thêm cấu hình vào java_toolchain.javacopts.

Ví dụ:

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",
    ]
)

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà cấu hình này cần trong thời gian chạy.
javacopts	Danh sách chuỗi; mặc định là [] Cờ trình biên dịch Java.
output_licenses	Danh sách chuỗi; mặc định là []
packages	Danh sách nhãn; mặc định là [] Tập hợp package_group mà cấu hình sẽ được áp dụng.
system	Nhãn; mặc định là None Tương ứng với cờ --system của javac.

java_plugin

Xem nguồn quy tắc

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 xác định các trình bổ trợ cho trình biên dịch Java do Bazel chạy. Loại trình bổ trợ duy nhất được hỗ trợ là trình xử lý chú thích. Quy tắc java_library hoặc java_binary có thể chạy các trình bổ trợ bằng cách phụ thuộc vào các trình bổ trợ đó thông qua thuộc tính plugins. java_library cũng có thể tự động xuất các trình bổ trợ sang các thư viện phụ thuộc trực tiếp vào trình bổ trợ đó bằng cách sử dụng exported_plugins.

Mục tiêu đầu ra ngầm ẩn

• libname.jar: Tệp lưu trữ Java.

Các đối số giống hệt với java_library, ngoại trừ việc thêm đối số processor_class.

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách thư viện cần liên kết vào thư viện này. Xem các nhận xét chung về deps tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định. Các tệp jar được tạo bằng quy tắc java_library được liệt kê trong deps sẽ nằm trên đường dẫn lớp thời gian biên dịch của quy tắc này. Hơn nữa, tập hợp đóng bắc cầu của deps, runtime_deps và exports sẽ nằm trên đường dẫn lớp thời gian chạy. Ngược lại, các mục tiêu trong thuộc tính data được đưa vào tệp chạy nhưng không có trong đường dẫn lớp thời gian biên dịch hoặc thời gian chạy.
srcs	Danh sách nhãn; mặc định là [] Danh sách các tệp nguồn được xử lý để tạo mục tiêu. Thuộc tính này hầu như luôn bắt buộc; hãy xem các trường hợp ngoại lệ bên dưới. Các tệp nguồn thuộc loại .java được biên dịch. Trong trường hợp tệp .java được tạo, bạn nên đặt tên của quy tắc tạo ở đây thay vì tên của chính tệp. Điều này không chỉ giúp cải thiện khả năng đọc mà còn giúp quy tắc linh hoạt hơn trước các thay đổi trong tương lai: nếu quy tắc tạo tạo ra nhiều tệp trong tương lai, bạn chỉ cần sửa một nơi: outs của quy tắc tạo. Bạn không nên liệt kê quy tắc tạo trong deps vì quy tắc này không có tác dụng. Các tệp nguồn thuộc loại .srcjar được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một tập hợp tệp .java bằng genrule.) Quy tắc: nếu quy tắc (thường là genrule hoặc filegroup) tạo bất kỳ tệp nào được liệt kê ở trên, thì các tệp đó sẽ được sử dụng theo cách tương tự như mô tả cho tệp nguồn. Các tệp nguồn thuộc loại .properties được coi là tài nguyên. Tất cả các tệp khác đều bị bỏ qua, miễn là có ít nhất một tệp thuộc loại tệp được mô tả ở trên. Nếu không, lỗi sẽ được báo cáo. Đối số này hầu như luôn bắt buộc, ngoại trừ trường hợp bạn chỉ định đối số runtime_deps.
data	Danh sách nhãn; mặc định là [] Danh sách tệp mà thư viện này cần trong thời gian chạy. Xem các nhận xét chung về data tại phần Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định. Khi tạo java_library, Bazel không đặt các tệp này ở bất cứ đâu; nếu tệp data là tệp được tạo thì Bazel sẽ tạo các tệp đó. Khi tạo một chương trình kiểm thử phụ thuộc vào java_library này, Bazel sẽ sao chép hoặc liên kết các tệp data vào vùng runfiles.
resources	Danh sách nhãn; mặc định là [] Danh sách tệp dữ liệu cần đưa vào tệp jar Java. Tài nguyên có thể là tệp nguồn hoặc tệp được tạo. Nếu được chỉ định, các tài nguyên sẽ được đóng gói trong tệp jar cùng với các tệp .class thông thường do quá trình biên dịch tạo ra. Vị trí của tài nguyên bên trong tệp jar được xác định theo cấu trúc dự án. Trước tiên, Bazel tìm bố cục thư mục chuẩn của Maven (thư mục "src" theo sau là thư mục con "resources"). Nếu không tìm thấy thư mục đó, Bazel sẽ tìm thư mục trên cùng có tên "java" hoặc "javatests" (ví dụ: nếu một tài nguyên nằm ở <workspace root>/x/java/y/java/z, thì đường dẫn của tài nguyên đó sẽ là y/java/z. Bạn không thể ghi đè phương thức tìm kiếm phỏng đoán này, tuy nhiên, bạn có thể sử dụng thuộc tính resource_strip_prefix để chỉ định một thư mục thay thế cụ thể cho các tệp tài nguyên.
add_exports	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-exports=.
add_opens	Danh sách chuỗi; mặc định là [] Cho phép thư viện này truy cập phản chiếu vào module hoặc package đã cho. Điều này tương ứng với cờ javac và JVM --add-opens=.
bootclasspath	Nhãn; mặc định là None API bị hạn chế, không được sử dụng!
generates_api	Boolean; mặc định là False Thuộc tính này đánh dấu các trình xử lý chú giải tạo mã API. Nếu một quy tắc sử dụng trình xử lý chú thích tạo API, thì các quy tắc khác phụ thuộc vào quy tắc đó chỉ có thể tham chiếu đến mã được tạo nếu các thao tác biên dịch của chúng được lên lịch sau quy tắc tạo. Thuộc tính này hướng dẫn Bazel đưa ra các quy tắc ràng buộc về lịch biểu khi bật --java_header_compilation. CẢNH BÁO: Thuộc tính này ảnh hưởng đến hiệu suất của bản dựng, chỉ sử dụng thuộc tính này nếu cần.
javabuilder_jvm_flags	Danh sách chuỗi; mặc định là [] API bị hạn chế, không được sử dụng!
javacopts	Danh sách chuỗi; mặc định là [] Các tuỳ chọn trình biên dịch bổ sung cho thư viện này. Chịu sự thay thế "Tạo biến" và tạo mã thông báo shell Bourne. Các tuỳ chọn trình biên dịch này được truyền đến javac sau các tuỳ chọn trình biên dịch toàn cục.
neverlink	Boolean; mặc định là False Liệu thư viện này chỉ nên được dùng để biên dịch chứ không phải trong thời gian chạy. Hữu ích nếu thư viện được môi trường thời gian chạy cung cấp trong quá trình thực thi. Ví dụ về các thư viện như vậy là API IDE cho trình bổ trợ IDE hoặc tools.jar cho mọi thứ chạy trên JDK tiêu chuẩn. Xin lưu ý rằng neverlink = True không ngăn trình biên dịch đưa nội dung từ thư viện này vào các mục tiêu biên dịch phụ thuộc vào thư viện đó, theo quy định của Thông số kỹ thuật ngôn ngữ Java (ví dụ: Hằng số static final của String hoặc của các kiểu dữ liệu nguyên thuỷ). Do đó, trường hợp sử dụng ưu tiên là khi thư viện thời gian chạy giống với thư viện biên dịch. Nếu thư viện thời gian chạy khác với thư viện biên dịch, thì bạn phải đảm bảo rằng thư viện thời gian chạy chỉ khác ở những nơi mà JLS cấm trình biên dịch cùng dòng (và điều đó phải đúng cho tất cả các phiên bản JLS trong tương lai).
output_licenses	Danh sách chuỗi; mặc định là []
plugins	Danh sách nhãn; mặc định là [] Trình bổ trợ trình biên dịch Java để chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính này sẽ được chạy bất cứ khi nào quy tắc này được tạo. Thư viện cũng có thể kế thừa các trình bổ trợ từ các phần phụ thuộc sử dụng exported_plugins. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar thu được của quy tắc này.
processor_class	Chuỗi; mặc định là "" Lớp trình xử lý là loại đủ điều kiện của lớp mà trình biên dịch Java sẽ sử dụng làm điểm truy cập vào trình xử lý chú thích. Nếu không được chỉ định, quy tắc này sẽ không đóng góp trình xử lý chú giải vào quá trình xử lý chú giải của trình biên dịch Java, nhưng đường dẫn lớp thời gian chạy của trình xử lý chú giải vẫn sẽ được đưa vào đường dẫn trình xử lý chú giải của trình biên dịch. (Tính năng này chủ yếu dành cho các trình bổ trợ dễ gặp lỗi. Các trình bổ trợ này được tải từ đường dẫn trình xử lý chú giải bằng cách sử dụng java.util.ServiceLoader.)
proguard_specs	Danh sách nhãn; mặc định là [] Các tệp sẽ được dùng làm thông số kỹ thuật của Proguard. Các tệp này sẽ mô tả tập hợp thông số kỹ thuật mà Proguard sẽ sử dụng. Nếu được chỉ định, các lớp này sẽ được thêm vào bất kỳ mục tiêu android_binary nào tuỳ thuộc vào thư viện này. Các tệp có trong đây chỉ được có các quy tắc idempotent, cụ thể là -dontnote, -dontwarn, assumenosideeffects và các quy tắc bắt đầu bằng -keep. Các tuỳ chọn khác chỉ có thể xuất hiện trong proguard_specs của android_binary để đảm bảo việc hợp nhất không phải là tự động trùng lặp.
resource_strip_prefix	Chuỗi; mặc định là "" Tiền tố đường dẫn cần xoá khỏi tài nguyên Java. Nếu được chỉ định, tiền tố đường dẫn này sẽ bị xoá khỏi mọi tệp trong thuộc tính resources. Lỗi xảy ra khi tệp tài nguyên không nằm trong thư mục này. Nếu bạn không chỉ định (mặc định), đường dẫn của tệp tài nguyên sẽ được xác định theo logic giống như gói Java của các tệp nguồn. Ví dụ: tệp nguồn tại stuff/java/foo/bar/a.txt sẽ nằm tại foo/bar/a.txt.

java_runtime

Xem nguồn quy tắc

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)

Chỉ định cấu hình cho môi trường thời gian chạy Java.

Ví dụ:

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

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
srcs	Danh sách nhãn; mặc định là [] Tất cả tệp trong thời gian chạy.
default_cds	Nhãn; mặc định là None Lưu trữ CDS mặc định cho java_runtime kín. Khi chế độ kín được bật cho mục tiêu java_binary, CDS mặc định java_runtime sẽ được đóng gói trong tệp JAR triển khai kín.
hermetic_srcs	Danh sách nhãn; mặc định là [] Các tệp trong thời gian chạy cần thiết cho các bản triển khai kín.
hermetic_static_libs	Danh sách nhãn; mặc định là [] Các thư viện được liên kết tĩnh với trình chạy cho các bản triển khai kín
java	Nhãn; mặc định là None Đường dẫn đến tệp thực thi java.
java_home	Chuỗi; mặc định là "" Đường dẫn đến thư mục gốc của môi trường thời gian chạy. Chịu sự thay thế của biến"Make". Nếu đường dẫn này là tuyệt đối, quy tắc này sẽ biểu thị một môi trường thời gian chạy Java không kín với một đường dẫn đã biết. Trong trường hợp đó, thuộc tính srcs và java phải để trống.
lib_ct_sym	Nhãn; mặc định là None Tệp lib/ct.sym cần thiết để biên dịch bằng --release. Nếu bạn không chỉ định và có đúng một tệp trong srcs có đường dẫn kết thúc bằng /lib/ct.sym, thì tệp đó sẽ được sử dụng.
lib_modules	Nhãn; mặc định là None Tệp lib/modules cần thiết cho các bản triển khai kín.
output_licenses	Danh sách chuỗi; mặc định là []
version	Số nguyên; mặc định là 0 Phiên bản tính năng của môi trường thời gian chạy Java. Tức là số nguyên do Runtime.version().feature() trả về.

java_toolchain

Xem nguồn quy tắc

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, 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)

Chỉ định cấu hình cho trình biên dịch Java. Bạn có thể thay đổi chuỗi công cụ sẽ sử dụng thông qua đối số --java_toolchain. Thông thường, bạn không nên viết những loại quy tắc đó trừ phi bạn muốn điều chỉnh trình biên dịch Java.

Ví dụ

Ví dụ đơn giản:

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",
)

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
android_lint_data	Danh sách nhãn; mặc định là [] Nhãn của các công cụ có sẵn để mở rộng nhãn trong android_lint_jvm_opts.
android_lint_jvm_opts	Danh sách chuỗi; mặc định là [] Danh sách đối số cho JVM khi gọi Tìm lỗi mã nguồn Android.
android_lint_opts	Danh sách chuỗi; mặc định là [] Danh sách các đối số của Trình tìm lỗi mã nguồn của Android.
android_lint_package_configuration	Danh sách nhãn; mặc định là [] Cấu hình tìm lỗi mã nguồn Android cần được áp dụng cho các nhóm gói được chỉ định.
android_lint_runner	Nhãn; mặc định là None Nhãn của trình chạy Trình tìm lỗi mã nguồn của Android (nếu có).
bootclasspath	Danh sách nhãn; mặc định là [] Mục nhập đường dẫn khởi động mục tiêu Java. Tương ứng với cờ -bootclasspath của javac.
compatible_javacopts	rỗng; mặc định là {} API nội bộ, không được sử dụng!
deps_checker	Nhãn; mặc định là None Nhãn của tệp jar triển khai ImportDepsChecker.
forcibly_disable_header_compilation	Boolean; mặc định là False Ghi đè --java_header_compilation để tắt tính năng biên dịch tiêu đề trên các nền tảng không hỗ trợ tính năng này, ví dụ: JDK 7 Bazel.
genclass	Nhãn; mặc định là None Nhãn của tệp jar triển khai GenClass.
header_compiler	Nhãn; mặc định là None Nhãn của trình biên dịch tiêu đề. Bắt buộc nếu bạn bật --java_header_compilation.
header_compiler_builtin_processors	Danh sách chuỗi; mặc định là [] API nội bộ, không được sử dụng!
header_compiler_direct	Nhãn; mặc định là None Nhãn không bắt buộc của trình biên dịch tiêu đề để sử dụng cho các thao tác đường dẫn lớp trực tiếp không bao gồm bất kỳ trình xử lý chú giải nào tạo API. Công cụ này không hỗ trợ tính năng xử lý chú thích.
ijar	Nhãn; mặc định là None Nhãn của tệp thực thi ijar.
jacocorunner	Nhãn; mặc định là None Nhãn của tệp jar triển khai JacocoCoverageRunner.
java_runtime	Nhãn; mặc định là None java_runtime để sử dụng với chuỗi công cụ này. Giá trị này mặc định là java_runtime trong cấu hình thực thi.
javabuilder	Nhãn; mặc định là None Nhãn của tệp jar triển khai JavaBuilder.
javabuilder_data	Danh sách nhãn; mặc định là [] Nhãn dữ liệu có sẵn để mở rộng nhãn trong javabuilder_jvm_opts.
javabuilder_jvm_opts	Danh sách chuỗi; mặc định là [] Danh sách đối số cho JVM khi gọi JavaBuilder.
javac_supports_multiplex_workers	Boolean; mặc định là True Đúng nếu JavaBuilder hỗ trợ chạy dưới dạng trình thực thi liên tục đa kênh, sai nếu không hỗ trợ.
javac_supports_worker_cancellation	Boolean; mặc định là True Đúng nếu JavaBuilder hỗ trợ việc huỷ các worker ổn định, sai nếu không hỗ trợ.
javac_supports_worker_multiplex_sandboxing	Boolean; mặc định là False Đúng nếu JavaBuilder hỗ trợ chạy dưới dạng trình chạy liên tục đa kênh có tính năng hộp cát, sai nếu không hỗ trợ.
javac_supports_workers	Boolean; mặc định là True Đúng nếu JavaBuilder hỗ trợ chạy dưới dạng worker ổn định, sai nếu không.
javacopts	Danh sách chuỗi; mặc định là [] Danh sách đối số bổ sung cho trình biên dịch Java. Vui lòng tham khảo tài liệu về trình biên dịch Java để biết danh sách đầy đủ các cờ trình biên dịch Java có thể có.
jspecify_implicit_deps	Nhãn; mặc định là None Thử nghiệm, không sử dụng!
jspecify_javacopts	Danh sách chuỗi; mặc định là [] Thử nghiệm, không sử dụng!
jspecify_packages	Danh sách nhãn; mặc định là [] Thử nghiệm, không sử dụng!
jspecify_processor	Nhãn; mặc định là None Thử nghiệm, không sử dụng!
jspecify_processor_class	Chuỗi; mặc định là "" Thử nghiệm, không sử dụng!
jspecify_stubs	Danh sách nhãn; mặc định là [] Thử nghiệm, không sử dụng!
jvm_opts	Danh sách chuỗi; mặc định là [] Danh sách đối số cho JVM khi gọi trình biên dịch Java. Vui lòng tham khảo tài liệu về máy ảo Java để biết danh sách đầy đủ các cờ có thể dùng cho tuỳ chọn này.
misc	Danh sách chuỗi; mặc định là [] Không dùng nữa: hãy sử dụng javacopts
oneversion	Nhãn; mặc định là None Nhãn của tệp nhị phân thực thi một phiên bản.
oneversion_allowlist	Nhãn; mặc định là None Nhãn của danh sách cho phép một phiên bản.
oneversion_allowlist_for_tests	Nhãn; mặc định là None Nhãn của danh sách cho phép một phiên bản cho kiểm thử.
oneversion_whitelist	Nhãn; mặc định là None Không dùng nữa: hãy sử dụng oneversion_allowlist
package_configuration	Danh sách nhãn; mặc định là [] Cấu hình cần áp dụng cho các nhóm gói đã chỉ định.
proguard_allowlister	Nhãn; mặc định là "@bazel_tools//tools/jdk:proguard_whitelister" Nhãn của trình liệt kê danh sách cho phép Proguard.
reduced_classpath_incompatible_processors	Danh sách chuỗi; mặc định là [] API nội bộ, không được sử dụng!
singlejar	Nhãn; mặc định là None Nhãn của tệp jar triển khai SingleJar.
source_version	Chuỗi; mặc định là "" Phiên bản nguồn Java (ví dụ: '6' hoặc '7'). Tệp này chỉ định nhóm cấu trúc mã được phép trong mã nguồn Java.
target_version	Chuỗi; mặc định là "" Phiên bản mục tiêu Java (ví dụ: '6' hoặc '7'). Tệp này chỉ định môi trường thời gian chạy Java mà lớp sẽ được tạo.
timezone_data	Nhãn; mặc định là None Nhãn của tệp jar tài nguyên chứa dữ liệu múi giờ. Nếu được đặt, dữ liệu múi giờ sẽ được thêm vào dưới dạng một phần phụ thuộc thời gian chạy ngầm ẩn của tất cả các quy tắc java_binary.
tools	Danh sách nhãn; mặc định là [] Nhãn của các công cụ có sẵn để mở rộng nhãn trong jvm_opts.
turbine_data	Danh sách nhãn; mặc định là [] Nhãn dữ liệu có sẵn để mở rộng nhãn trong turbine_jvm_opts.
turbine_jvm_opts	Danh sách chuỗi; mặc định là [] Danh sách đối số cho JVM khi gọi turbine.
xlint	Danh sách chuỗi; mặc định là [] Danh sách cảnh báo cần thêm hoặc xoá khỏi danh sách mặc định. Đặt dấu gạch ngang trước để xoá dấu gạch ngang đó. Vui lòng xem tài liệu về Javac trên các tuỳ chọn -Xlint để biết thêm thông tin.