프로토콜 버퍼 규칙

규칙

• 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)

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

LANGUAGE_proto_library 규칙을 어떻게 지정할지 지정합니다 (예: java_proto_library)가 proto 컴파일러를 호출해야 합니다. 일부 LANGUAGE_proto_library 규칙에서는 명령줄 플래그를 사용하여 어떤 도구 모음을 사용할지 지정할 수 있습니다. 관련 문서를 참조하세요.

일반적으로 자바 컴파일러를 조정하지 않는 한 이러한 종류의 규칙을 작성하면 안 됩니다.

컴파일러는 없습니다. proto-compiler는 우리가 첨부한 proto_library 규칙에서 가져온 것입니다. 이는 명령줄 플래그로 Blaze에 전달됩니다. 여러 기능을 사용하려면 proto_library 규칙 자체에서 proto-컴파일러를 호출해야 합니다. LANGUAGE_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 속성에 있는 파일의 코드는 생성되지 않습니다. any.proto과 같이 proto 런타임에 이미 연결된 .proto 파일에 사용됩니다.
command_line	String; required 이 값은 코드를 생성하기 위해 proto-compiler로 전달됩니다. 이 코드 생성기/플러그인과 관련된 부분만 포함합니다 (예: -I 매개변수는 포함하지 않음). $(OUT)는 nl_proto_library 전용입니다. 규칙은 이 변수를 해석하는 방법을 정의해야 합니다. 예를 들어 Java의 경우 $(OUT)은 생성할 src-jar 파일 이름으로 대체됩니다.
mnemonic	String; optional; default is "GenProto" 이 값은 protoc 작업에서 연상 기호로 설정됩니다.
plugin	Label; optional 제공되는 경우 proto-compiler를 호출하는 작업에서 사용할 수 있으며 proto-compiler로 전달됩니다.--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 컴파일러 실행 파일입니다. 제공된 경우 이 타겟이 코드를 생성하기 위한 Proto-compiler로 사용됩니다.
runtime	Label; optional 생성된 코드가 컴파일되는 언어별 라이브러리입니다. 정확한 동작은 LANGUAGE_proto_library마다 다릅니다. 예를 들어 Java는 런타임에 대해 컴파일되어야 합니다.

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라는 파일을 만듭니다. 이 파일은 규칙이 src로 설정한 메시지에 설정된 설명어입니다. 파일은 https://developers.google.com/protocol-buffers/docs/techniques#self-description에 설명된 직렬화된 FileDescriptorSet입니다.

여기에는 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가 비어 있을 수 있는 한 가지 사용 사례는 alias-library입니다. 이는 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 속성의 접두사는 이 접두사를 제거한 후에 추가됩니다.