Java¶
Rules for generating Java protobuf and gRPC .jar
files and libraries using standard Protocol Buffers and gRPC-Java. Libraries are created with the Bazel native java_library
Rule |
Description |
---|---|
Generates a Java protobuf srcjar file |
|
Generates a Java protobuf and gRPC srcjar file |
|
Generates a Java protobuf library using |
|
Generates a Java protobuf and gRPC library using |
java_proto_compile¶
Generates a Java protobuf srcjar file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//java:repositories.bzl", rules_proto_grpc_java_repos = "java_repos")
rules_proto_grpc_java_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//java:defs.bzl", "java_proto_compile")
java_proto_compile(
name = "person_java_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
java_proto_compile(
name = "place_java_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
java_proto_compile(
name = "thing_java_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins¶
java_grpc_compile¶
Generates a Java protobuf and gRPC srcjar file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//java:repositories.bzl", rules_proto_grpc_java_repos = "java_repos")
rules_proto_grpc_java_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//java:defs.bzl", "java_grpc_compile")
java_grpc_compile(
name = "thing_java_grpc",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
java_grpc_compile(
name = "greeter_java_grpc",
protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins¶
java_proto_library¶
Generates a Java protobuf library using java_library
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//java:repositories.bzl", rules_proto_grpc_java_repos = "java_repos")
rules_proto_grpc_java_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//java:defs.bzl", "java_proto_library")
java_proto_library(
name = "person_java_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
deps = ["place_java_proto"],
)
java_proto_library(
name = "place_java_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
deps = ["thing_java_proto"],
)
java_proto_library(
name = "thing_java_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
|
List of labels to pass as exports attr to underlying lang_library rule |
java_grpc_library¶
Generates a Java protobuf and gRPC library using java_library
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//java:repositories.bzl", rules_proto_grpc_java_repos = "java_repos")
rules_proto_grpc_java_repos()
load("@rules_jvm_external//:defs.bzl", "maven_install")
load("@io_grpc_grpc_java//:repositories.bzl", "IO_GRPC_GRPC_JAVA_ARTIFACTS", "IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS", "grpc_java_repositories")
maven_install(
artifacts = IO_GRPC_GRPC_JAVA_ARTIFACTS,
generate_compat_repositories = True,
override_targets = IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS,
repositories = [
"https://repo.maven.apache.org/maven2/",
],
)
load("@maven//:compat.bzl", "compat_repositories")
compat_repositories()
grpc_java_repositories()
BUILD.bazel
¶
load("@rules_proto_grpc//java:defs.bzl", "java_grpc_library")
java_grpc_library(
name = "thing_java_grpc",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
java_grpc_library(
name = "greeter_java_grpc",
protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
deps = ["thing_java_grpc"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
|
List of labels to pass as exports attr to underlying lang_library rule |