프로토콜 버퍼 규칙

규칙

• cc_proto_library
• java_lite_proto_library
• java_proto_library
• proto_library
• py_proto_library
• proto_lang_toolchain
• proto_toolchain

cc_proto_library

cc_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library는 .proto 파일에서 C++ 코드를 생성합니다.

deps는 proto_library 규칙을 가리켜야 합니다.

예:

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

인수

java_lite_proto_library

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

java_lite_proto_library는 .proto 파일에서 Java 코드를 생성합니다.

deps는 proto_library 규칙을 가리켜야 합니다.

예:

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

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

proto_library(
    name = "bar",
)

인수

java_proto_library

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

java_proto_library는 .proto 파일에서 Java 코드를 생성합니다.

deps는 proto_library 규칙을 가리켜야 합니다.

예:

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

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

proto_library(
    name = "foo_proto",
)

인수

proto_library

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

Bazel을 사용하는 경우 https://github.com/bazelbuild/rules_proto에서 규칙을 로드하세요.

proto_library를 사용하여 여러 언어에서 사용할 수 있는 프로토콜 버퍼 라이브러리를 정의합니다. proto_library는 지원되는 규칙의 deps 절(예: java_proto_library)에 나열될 수 있습니다.

명령줄에서 컴파일하면 proto_library는 규칙 src의 메시지에 관한 설명자 집합인 foo-descriptor-set.proto.bin라는 파일을 만듭니다. 이 파일은 https://developers.google.com/protocol-buffers/docs/techniques#self-description에 설명된 직렬화된 FileDescriptorSet입니다.

여기에는 proto_library 규칙에서 직접 언급한 .proto 파일에 관한 정보만 포함됩니다. 암시적 설명자 집합 모음은 [ProtoInfo].transitive_descriptor_sets Starlark 제공자를 통해 사용할 수 있습니다. proto_info.bzl의 문서를 참고하세요.

권장되는 코드 구성:

• .proto 파일당 proto_library 규칙 1개
• foo.proto라는 파일은 동일한 패키지에 있는 foo_proto이라는 규칙에 있습니다.
• foo_proto라는 proto_library를 래핑하는 [language]_proto_library는 foo_[language]_proto라고 호출되어야 하며 동일한 패키지에 있어야 합니다.

인수

py_proto_library

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

인수

proto_lang_toolchain

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

Bazel을 사용하는 경우 https://github.com/bazelbuild/rules_proto에서 규칙을 로드하세요.

LANG_proto_library 규칙 (예: java_proto_library)는 프로토 컴파일러를 호출해야 합니다. 일부 LANG_proto_library 규칙에서는 명령줄 플래그를 사용하여 사용할 도구 모음을 지정할 수 있습니다. 문서를 참고하세요.

일반적으로 Java 컴파일러를 조정하려는 경우가 아니라면 이러한 종류의 규칙을 작성해서는 안 됩니다.

컴파일러가 없습니다. proto 컴파일러는 연결된 proto_library 규칙에서 가져옵니다. Blaze에 명령줄 플래그로 전달됩니다. 몇몇 기능에는 proto_library 규칙 자체에서 proto-compiler를 호출해야 합니다. LANG_proto_library에서 사용하는 컴파일러가 proto_library에서 사용하는 컴파일러와 동일하도록 적용하는 것이 좋습니다.

예

간단한 예는 다음과 같습니다.

proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

인수

proto_toolchain

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

인수