Se usó la API de Cloud Translation para traducir esta página.

Reglas de búfer de protocolo

Reglas

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, output_files, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, visibility)

Si usas Bazel, carga la regla desde https://github.com/bazelbuild/rules_proto.

Especifica cómo una regla LANG_proto_library (p.ej., java_proto_library) debe invocar el protocompilador. Algunas reglas LANG_proto_library permiten especificar qué cadena de herramientas usar mediante marcas de línea de comandos. Consulta su documentación.

Por lo general, no debes escribir ese tipo de reglas, a menos que desees ajustar tu compilador de Java.

No hay compilador. El proto-compiler se toma de la regla proto_library a la que adjuntamos. Se pasa al Blaze como una marca de línea de comandos. Varias funciones requieren que se invoque un proto-compiler en la misma regla proto_library. Es conveniente aplicar de manera forzosa que el compilador que usa LANG_proto_library sea el mismo que hace proto_library.

Ejemplos

Un ejemplo sencillo sería el siguiente:

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

Argumentos

Atributos
`name`	Name; obligatorio Un nombre único para este destino.
`blacklisted_protos`	Lista de etiquetas; el valor predeterminado es `[]` No se generará ningún código para los archivos del atributo `srcs` de `blacklisted_protos`. Se usa para archivos .proto que ya están vinculados en entornos de ejecución proto, como `any.proto`.
`command_line`	String; obligatoria Este valor se pasará a proto-compiler para generar el código. Solo incluye las partes específicas de este generador de código o complemento (p. ej., no incluyas los parámetros -I). `$(OUT)` es específico de LANG_proto_library. Se espera que las reglas definan cómo interpretan esta variable. En el caso de Java, por ejemplo, $(OUT) se reemplazará con el nombre de archivo src-jar que se creará.
`mnemonic`	String; el valor predeterminado es `"GenProto"` Este valor se establecerá como mnemotécnico en la acción de protocolo.
`output_files`	String; el valor predeterminado es `"legacy"` Controla el formato de `$(OUT)` en `command_line`, ya sea mediante una ruta de acceso a un solo archivo o a un directorio de salida en caso de varios archivos. Los valores posibles son “single”, “multiple”.
`plugin`	Etiqueta; el valor predeterminado es `None` Si se proporciona, estará disponible para la acción que llame al proto-compiler y se pasará al proto-compiler: `--plugin=protoc-gen-PLUGIN=<executable>.`
`plugin_format_flag`	String; el valor predeterminado es `""` Si se proporciona, este valor se pasará a proto-compiler para usar el complemento. El valor debe contener un solo %s que se reemplazará por el ejecutable del complemento. `--plugin=protoc-gen-PLUGIN=<executable>.`
`progress_message`	String; el valor predeterminado es `"Generating proto_library %{label}"` Este valor se establecerá como el mensaje de progreso en la acción de protocolo.
`proto_compiler`	Etiqueta; el valor predeterminado es `None` Es el ejecutable del compilador proto. Si se proporciona, este destino se usará como protocompilador para generar el código.
`runtime`	Etiqueta; el valor predeterminado es `None` Una biblioteca específica del lenguaje con la que se compila el código generado. El comportamiento exacto es específico de LANG_proto_library. Java, por ejemplo, debe compilar en el entorno de ejecución.

proto_library

Ver el código fuente de la regla

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, visibility)

Ya no está disponible. En su lugar, usa https://github.com/bazelbuild/rules_proto.

Usa proto_library para definir bibliotecas de búferes de protocolo que se pueden usar desde varios lenguajes. Un proto_library puede aparecer en la cláusula deps de las reglas admitidas, como java_proto_library.

Cuando se compila en la línea de comandos, un proto_library crea un archivo llamado foo-descriptor-set.proto.bin, que es el conjunto de descriptores para los mensajes que genera la regla. El archivo es un FileDescriptorSet serializado, que se describe en https://developers.google.com/protocol-buffers/docs/techniques#self-description.

Solo contiene información sobre los archivos .proto mencionados directamente por una regla proto_library. La colección de conjuntos de descriptores transitivos está disponible a través del proveedor [ProtoInfo].transitive_descriptor_sets de Starlark. Consulta la documentación en ProtoInfo.java.

Organización de código recomendada:

Una regla proto_library por archivo .proto.
Un archivo llamado foo.proto estará en una regla llamada foo_proto, que se encuentra en el mismo paquete.
Un [language]_proto_library que une un proto_library llamado foo_proto debe llamarse foo_[language]_proto y estar ubicado en el mismo paquete.

Argumentos

Atributos
`name`	Name; obligatorio Un nombre único para este destino.
`deps`	Lista de etiquetas; el valor predeterminado es `[]` Es la lista de otras reglas `proto_library` de las que depende el destino. Un `proto_library` solo puede depender de otros destinos de `proto_library`. Es posible que no dependa de las bibliotecas específicas de un lenguaje.
`srcs`	Lista de etiquetas; el valor predeterminado es `[]` La lista de archivos `.proto` y `.protodevel` que se procesan para crear el destino. Por lo general, no está vacía. Un caso de uso en el que `srcs` puede estar vacío es una biblioteca de alias. Esta es una regla proto_library que tiene uno o más otros objetos proto_library en `deps`. Este patrón se puede usar, p.ej., para exportar una API pública con un nombre persistente.
`allow_exports`	Etiqueta; el valor predeterminado es `None` Una lista de entidades permitidas opcional que evita que la biblioteca de proto se vuelva a exportar o se use en lang_proto_library que no se encuentra en uno de los paquetes de la lista.
`exports`	Lista de etiquetas; el valor predeterminado es `[]` Lista de destinos de proto_library a los que se puede hacer referencia con "import public" en la fuente de proto.
`import_prefix`	String; el valor predeterminado es `""` El prefijo que se agregará a las rutas de acceso de los archivos .proto en esta regla. Cuando se establece, se puede acceder a los archivos de origen .proto en el atributo `srcs` de esta regla al valor de este atributo antepuesto a su ruta de acceso relativa del repositorio. Se quita el prefijo del atributo `strip_import_prefix` antes de agregar este prefijo.
`strip_import_prefix`	String; el valor predeterminado es `""` El prefijo que se quitará de las rutas de acceso de los archivos .proto en esta regla. Cuando se configura, se puede acceder a los archivos de origen .proto en el atributo `srcs` de esta regla en su ruta de acceso con este prefijo cortado. Si es una ruta de acceso relativa (que no comienza con una barra diagonal), se toma como una ruta relativa del paquete. Si es una absoluta, se entiende como una ruta de acceso relativa de repositorio. El prefijo en el atributo `import_prefix` se agrega después de que se quita este prefijo.