프로토콜 버퍼 규칙

문제 신고 소스 보기 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

규칙

• 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, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, 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",
)

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
deps	라벨 목록입니다. 기본값은 []입니다. C++ 코드를 생성할 proto_library 규칙 목록입니다.

java_lite_proto_library

규칙 소스 보기

java_lite_proto_library(name, deps, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, 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",
)

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
deps	라벨 목록입니다. 기본값은 []입니다. Java 코드를 생성할 proto_library 규칙 목록입니다.

java_proto_library

규칙 소스 보기

java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_group_compatible_with, exec_properties, features, licenses, package_metadata, 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",
)

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
deps	라벨 목록입니다. 기본값은 []입니다. Java 코드를 생성할 proto_library 규칙 목록입니다.
distribs	문자열 목록입니다. 기본값은 []입니다.

proto_library

규칙 소스 보기

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, exports, features, import_prefix, licenses, package_metadata, 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 규칙
• foo.proto라는 파일은 동일한 패키지에 있는 foo_proto이라는 규칙에 있습니다.
• foo_proto라는 proto_library를 래핑하는 [language]_proto_library는 foo_[language]_proto라고 해야 하며 동일한 패키지에 있어야 합니다.

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
deps	라벨 목록입니다. 기본값은 []입니다. 타겟이 종속되는 다른 proto_library 규칙 목록입니다. proto_library는 다른 proto_library 타겟에만 종속될 수 있습니다. 언어별 라이브러리에 종속되지 않을 수 있습니다.
srcs	라벨 목록입니다. 기본값은 []입니다. 타겟을 만들기 위해 처리되는 .proto 및 .protodevel 파일의 목록입니다. 일반적으로 빈 목록이 아닙니다. srcs가 비어 있을 수 있는 한 가지 사용 사례는 별칭 라이브러리입니다. deps에 하나 이상의 다른 proto_library가 있는 proto_library 규칙입니다. 이 패턴은 예를 들어 영구 이름으로 공개 API를 내보내는 데 사용할 수 있습니다.
allow_exports	라벨: 기본값은 None입니다. 나열된 패키지 중 하나에 없는 lang_proto_library에서 proto 라이브러리가 다시 내보내지 않거나 사용되지 않도록 하는 선택적 허용 목록입니다.
exports	라벨 목록입니다. 기본값은 []입니다. proto 소스에서 'import public'을 통해 참조할 수 있는 proto_library 타겟 목록입니다. 'import public'을 사용하지만 exports 속성에 해당 라이브러리를 나열하지 않으면 오류가 발생합니다. 아직 일부 lang_proto_library 구현이 변경되지 않았으므로 deps와 exports에 모두 라이브러리를 나열해야 합니다.
import_prefix	문자열, 기본값은 ""입니다. 이 규칙의 .proto 파일 경로에 추가할 접두사입니다. 이 속성을 설정하면 이 규칙의 srcs 속성에 있는 .proto 소스 파일에 저장소 상대 경로 앞에 이 속성 값이 추가된 위치에서 액세스할 수 있습니다. 이 접두사가 추가되기 전에 strip_import_prefix 속성의 접두사가 삭제됩니다.
strip_import_prefix	문자열, 기본값은 "/"입니다. 이 규칙의 .proto 파일 경로에서 제거할 접두사입니다. 이 속성을 설정하면 이 규칙의 srcs 속성에 있는 .proto 소스 파일에 이 접두사가 잘린 경로에서 액세스할 수 있습니다. 상대 경로 (슬래시로 시작하지 않음)인 경우 패키지 상대 경로로 간주됩니다. 절대 경로인 경우 저장소 상대 경로로 이해됩니다. import_prefix 속성의 접두사는 이 접두사가 제거된 후에 추가됩니다.

py_proto_library

규칙 소스 보기

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

`py_proto_library` 를 사용하여 `.proto` 파일에서 Python 라이브러리를 생성합니다. `proto_library` 규칙 `foo_proto`를 래핑할 때는 `py_proto_library` 규칙의 이름을 `foo_py_pb2`로 지정하는 것이 관례입니다. `deps` 는 `proto_library` 규칙을 가리켜야 합니다. 예: ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "foo_proto", srcs = ["foo.proto"], ) ```

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
deps	라벨 목록입니다. 기본값은 []입니다. Python 라이브러리를 생성할 `proto_library` 규칙 목록입니다. 일반적으로 관심 있는 프로토 라이브러리라는 단일 타겟만 있습니다. `ProtoInfo`를 제공하는 모든 타겟일 수 있습니다.

proto_lang_toolchain

규칙 소스 보기

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, 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",
)

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
allowlist_different_package	라벨: 기본값은 None입니다.
blacklisted_protos	라벨 목록입니다. 기본값은 []입니다. blacklisted_protos의 srcs 속성에 있는 파일에는 코드가 생성되지 않습니다. 이는 이미 proto 런타임(예: any.proto)에 연결된 .proto 파일에 사용됩니다.
command_line	문자열, 필수 이 값은 코드를 생성하기 위해 proto-compiler에 전달됩니다. 이 코드 생성기/플러그인에만 해당하는 부분만 포함합니다 (예: -I 매개변수는 포함하지 않음). $(OUT)는 LANG_proto_library에 따라 다릅니다. 규칙은 이 변수를 해석하는 방법을 정의해야 합니다. 예를 들어 Java의 경우 $(OUT)은 만들 src-jar 파일 이름으로 대체됩니다.
mnemonic	문자열, 기본값은 "GenProto"입니다. 이 값은 protoc 작업에서 니모닉으로 설정됩니다.
output_files	문자열, 기본값은 "legacy"입니다. 단일 파일의 경로 또는 여러 파일의 경우 출력 디렉터리를 사용하여 command_line의 $(OUT) 형식을 지정하는 방법을 제어합니다. 가능한 값은 'single', 'multiple'입니다.
plugin	라벨: 기본값은 None입니다. 제공된 경우 프로토 컴파일러를 호출하는 작업에서 사용할 수 있으며 프로토 컴파일러에 전달됩니다. --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	문자열, 기본값은 ""입니다. 이 값을 제공하면 플러그인을 사용하기 위해 proto-compiler에 전달됩니다. 값에는 플러그인 실행 파일로 대체되는 단일 %s가 포함되어야 합니다. --plugin=protoc-gen-PLUGIN=<executable>.
progress_message	문자열, 기본값은 "Generating proto_library %{label}"입니다. 이 값은 protoc 작업의 진행률 메시지로 설정됩니다.
protoc_minimal_do_not_use	라벨: 기본값은 None입니다.
runtime	라벨: 기본값은 None입니다. 생성된 코드가 컴파일되는 언어별 라이브러리입니다. 정확한 동작은 LANG_proto_library에 따라 다릅니다. 예를 들어 Java는 런타임에 맞게 컴파일해야 합니다.
toolchain_type	라벨: 기본값은 None입니다.

proto_toolchain

규칙 소스 보기

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

인수

속성
name	이름: 필수사항 이 타겟의 고유한 이름입니다.
command_line	문자열, 기본값은 "--descriptor_set_out=%s"입니다.
mnemonic	문자열, 기본값은 "GenProtoDescriptorSet"입니다.
output_files	문자열, 기본값은 "single"입니다.
progress_message	문자열, 기본값은 "Generating Descriptor Set proto_library %{label}"입니다.
proto_compiler	라벨: 기본값은 None입니다.