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

Rules#
Rule	Description
java_proto_compile	Generates a Java protobuf srcjar file
java_grpc_compile	Generates a Java protobuf and gRPC srcjar file
java_proto_library	Generates a Java protobuf library using `java_library`
java_grpc_library	Generates a Java protobuf and gRPC library using `java_library`

java_proto_compile#

Generates a Java protobuf srcjar file

Example#

Full example project can be found here

`BUILD.bazel`#

load("@rules_proto_grpc_java//:defs.bzl", "java_proto_compile")

java_proto_compile(
    name = "person_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
)

java_proto_compile(
    name = "place_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
)

java_proto_compile(
    name = "thing_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes#

Attributes for java_proto_compile#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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#

@rules_proto_grpc_java//:proto_plugin

java_grpc_compile#

Generates a Java protobuf and gRPC srcjar file

Example#

Full example project can be found here

`BUILD.bazel`#

load("@rules_proto_grpc_java//:defs.bzl", "java_grpc_compile")

java_grpc_compile(
    name = "thing_java_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

java_grpc_compile(
    name = "greeter_java_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
)

Attributes#

Attributes for java_grpc_compile#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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

`BUILD.bazel`#

load("@rules_proto_grpc_java//:defs.bzl", "java_proto_library")

java_proto_library(
    name = "person_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
    deps = ["place_java_proto"],
)

java_proto_library(
    name = "place_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
    deps = ["thing_java_proto"],
)

java_proto_library(
    name = "thing_java_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes#

Attributes for java_proto_library#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`exports`	`label_list`	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

`BUILD.bazel`#

load("@rules_proto_grpc_java//:defs.bzl", "java_grpc_library")

java_grpc_library(
    name = "thing_java_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

java_grpc_library(
    name = "greeter_java_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
    deps = ["thing_java_grpc"],
)

Attributes#

Attributes for java_grpc_library#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`exports`	`label_list`	false	`[]`	List of labels to pass as exports attr to underlying lang_library rule

Java#

java_proto_compile#

Example#

BUILD.bazel#

Attributes#

Plugins#

java_grpc_compile#

Example#

BUILD.bazel#

Attributes#

Plugins#

java_proto_library#

Example#

BUILD.bazel#

Attributes#

java_grpc_library#

Example#

BUILD.bazel#

Attributes#

`BUILD.bazel`#

`BUILD.bazel`#

`BUILD.bazel`#

`BUILD.bazel`#