프로토콜 버퍼 규칙

규칙

proto_lang_toolchain
proto_library

proto_lang_toolchain

proto_lang_toolchain(name, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, mnemonic, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, visibility)

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

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

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

컴파일러가 없습니다. proto 컴파일러는 연결된 proto_library 규칙에서 가져옵니다. Blaze에 명령줄 플래그로 전달됩니다. proto_library 규칙 자체에서 proto 컴파일러를 호출해야 하는 기능이 많습니다. 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`	`Name; required` 이 타겟의 고유한 이름입니다.
`blacklisted_protos`	`List of labels; optional` `blacklisted_protos`의 `srcs` 속성에 있는 파일의 코드는 생성되지 않습니다. 이는 proto 런타임에 이미 연결된 .proto 파일에 사용됩니다(예: `any.proto`).
`command_line`	`String; required` 이 값은 proto-compiler로 전달되어 코드를 생성합니다. 이 코드 생성기/플러그인에 해당하는 부분만 포함합니다 (예: -I 매개변수 제외). `$(OUT)`는 LANG_proto_library 전용입니다. 규칙은 이 변수를 해석하는 방법을 정의해야 합니다. 예를 들어 자바의 경우 $(OUT)이 생성할 src-jar 파일 이름으로 대체됩니다.
`mnemonic`	`String; optional; default is "GenProto"` 이 값은 protoc 액션의 연상 기호로 설정됩니다.
`plugin`	`Label; optional` 제공되는 경우 proto 컴파일러를 호출하는 작업에 사용할 수 있으며 proto 컴파일러에 전달됩니다. `--plugin=protoc-gen-PLUGIN=.`
`plugin_format_flag`	`String; optional` 제공되는 경우 이 값은 proto-compiler에 전달되어 플러그인을 사용합니다. 값은 단일 %s를 포함해야 하며, 이는 플러그인 실행 파일로 대체됩니다. `--plugin=protoc-gen-PLUGIN=.`
`progress_message`	`String; optional; default is "Generating proto_library %{label}"` 이 값은 protoc 작업에서 진행률 메시지로 설정됩니다.
`proto_compiler`	`Label; optional` proto 컴파일러 실행 파일입니다. 제공된 경우 이 타겟은 프로토 컴파일러로 사용되어 코드를 생성합니다.
`runtime`	`Label; optional` 생성된 코드를 컴파일하는 언어별 라이브러리입니다. 정확한 동작은 LANG_proto_library별 동작입니다. 예를 들어 자바는 런타임에 대해 컴파일해야 합니다.

proto_library

규칙 소스 보기

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

지원이 중단되었습니다. 대신 https://github.com/bazelbuild/rules_proto를 사용하세요.

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

명령줄에서 컴파일할 때 proto_library는 foo-descriptor-set.proto.bin라는 파일을 만듭니다. 이 파일은 규칙이 매핑되는 메시지의 설명자 집합입니다. 파일은 직렬화된 FileDescriptorSet이며 https://developers.google.com/protocol-buffers/docs/technologys#self-description에 설명되어 있습니다.

여기에는 proto_library 규칙에서 직접 언급한 .proto 파일에 관한 정보만 포함됩니다. 전이 설명어 집합은 [ProtoInfo].transitive_descriptor_sets Starlark 제공업체를 통해 사용할 수 있습니다. ProtoInfo.java의 문서를 참고하세요.

권장되는 코드 구성:

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

인수

속성
`name`	`Name; required` 이 타겟의 고유한 이름입니다.
`deps`	`List of labels; optional` 대상이 종속된 다른 `proto_library` 규칙의 목록입니다. `proto_library`는 다른 `proto_library` 타겟에만 종속될 수 있습니다. 언어별 라이브러리에 종속되지 않을 수 있습니다.
`srcs`	`List of labels; optional` 대상을 만들기 위해 처리되는 `.proto` 및 `.protodevel` 파일의 목록입니다. 일반적으로 비어 있지 않은 목록입니다. `srcs`를 비워 둘 수 있는 한 가지 사용 사례는 별칭 라이브러리입니다. 이 규칙은 `deps`에 하나 이상의 다른 proto_library가 있는 proto_library 규칙입니다. 이 패턴은 영구 이름으로 공개 API를 내보내는 데 사용할 수 있습니다.
`exports`	`List of labels; optional` proto 소스에서 'import public'을 통해 참조할 수 있는 proto_library 대상의 목록입니다.
`import_prefix`	`String; optional` 이 규칙에서 .proto 파일의 경로에 추가할 프리픽스입니다. 설정하면 이 규칙의 `srcs` 속성에 있는 .proto 소스 파일에 액세스할 수 있습니다. 이 속성의 값은 저장소 상대 경로 앞에 추가됩니다. `strip_import_prefix` 속성의 프리픽스는 이 프리픽스가 추가되기 전에 삭제됩니다.
`strip_import_prefix`	`String; optional` 이 규칙에 있는 .proto 파일의 경로에서 제거할 프리픽스입니다. 설정하면 이 규칙의 `srcs` 속성에 있는 .proto 소스 파일에 프리픽스가 잘린 상태로 액세스할 수 있습니다. 상대 경로 (슬래시로 시작하지 않음)인 경우에는 패키지 기준 경로로 간주됩니다. 절대 경로인 경우 저장소 상대 경로로 간주됩니다. `import_prefix` 속성의 프리픽스는 이 프리픽스가 삭제된 후에 추가됩니다.