La herramienta qtprotobufgen
La herramienta qtprotobufgen se puede utilizar para generar clases de « Qt Protobuf » a partir de un esquema protobuf. La herramienta se incluye en el paquete CMake Qt6::ProtobufTools. Funciona como una extensión de la herramienta protoc de Google.
find_package(Qt6 COMPONENTS ProtobufTools REQUIRED)Uso
Qt proporciona funciones de CMake que facilitan el uso de la herramienta qtprotobufgen. Cuando se utilice CMake como herramienta de compilación, se recomienda utilizar la API de CMake de Qt. Para sistemas de compilación distintos de CMake, adapta los comandos descritos en «Ejecución manual».
Nota: no existe soporte explícito para la compilación gRPC™ y de aplicaciones Protobuf utilizando el módulo Qt GRPC con qmake.
CMake
Los siguientes comandos de CMake integran un esquema de Protobuf en un proyecto de Qt.
Genera código fuente C++ basado en Qt utilizando un esquema protobuf. |
Normalmente, qtprotobufgen se invoca a través de CMake utilizando la macro qt_add_protobuf.
Uso de `qt_add_protobuf`
cmake_minimum_required(VERSION 3.16...3.22)
project(MyThings)
find_package(Qt6 REQUIRED COMPONENTS Protobuf)
qt_standard_project_setup()
qt_add_protobuf(MyMessages
GENERATE_PACKAGE_SUBFOLDERS
PROTO_FILES
path/to/message.proto
path/to/other_message.proto
PROTO_INCLUDES
/path/to/proto/include
)
qt_add_executable(MyApp main.cpp)
target_link_libraries(MyApp PRIVATE MyMessages)En el ejemplo anterior, generamos una biblioteca llamada MyMessages, que contiene los tipos de mensajes definidos en las rutas pasadas a la opción PROTO_FILES. La opción GENERATE_PACKAGE_SUBFOLDERS sirve para generar una estructura de carpetas para los archivos generados. Y la opción PROTO_INCLUDES indica a protoc que busque dependencias o importaciones en los directorios especificados. Creamos un objetivo para un ejecutable llamado MyApp, que enlazamos con la biblioteca MyMessages.
Ejecución manual
protoc --plugin=protoc-gen-qtprotobuf=<path/to/bin/>qtprotobufgen \
--qtprotobuf_out="[<options>:]<output_dir>" \
[--qtprotobuf_opt="<options>"] \
[-I/extra/proto/include/path] \
<protofile>.protoEl argumento « options » es una lista de opciones separadas por punto y coma. Se puede pasar de dos formas diferentes. O bien añadiendo las opciones al principio del argumento `output_dir`, delimitadas por dos puntos; o bien mediante un argumento independiente, ` --qtprotobuf_opt`. También se pueden pasar las claves correspondientes como variable de entorno ` QT_PROTOBUF_OPTIONS `. Las claves deben presentarse como una lista separada por punto y coma:
export QT_PROTOBUF_OPTIONS="COPY_COMMENTS;GENERATE_PACKAGE_SUBFOLDERS"Opciones
El generador admite opciones que se pueden proporcionar para ajustar la generación. Las opciones tienen alias directos en la función ` qt_add_protobuf `. Se admiten las siguientes opciones:
COPY_COMMENTScopia los comentarios de los archivos.protoal código generado.GENERATE_PACKAGE_SUBFOLDERSutiliza el especificador del nombre del paquete de los archivos.protopara crear la estructura de carpetas de los archivos generados. Por ejemplo, si el paquete se define como:package io.qt.test, los archivos generados se colocarán en OUTPUT_DIRECTORY/io/qt/test/.EXPORT_MACROdefine el nombre base de la macro de exportación utilizada en el código generado. El nombre final de la macro se construye comoQPB_<EXPORT_MACRO>_EXPORT. Si no se establece esta opción, no se genera ninguna macro de exportación.Desde Qt 6.8, se admite el siguiente formato:
EXPORT_MACRO=macro_name[:macro_output_file[:<true|false>]]. Este formato permite especificar el nombre del archivo de cabecera que contiene la macro de exportación y controlar explícitamente si se genera o no.Nota: Si no se proporciona <macro_output_file>, la opción adopta por defecto la sintaxis anterior.
HEADER_GUARDEspecifica el mecanismo utilizado para evitar la inclusión múltiple de los archivos de cabecera generados. Los valores posibles sonpragmayfilename. El valor por defecto esfilename. Al establecer la opción enpragma, se genera el pragma «header guard» moderno:#pragma once ...Si se omite la opción o se establece en
filename, se genera la protección de envolturaifdefy se utiliza el nombre de archivo «.proto» como infijo de protección:#ifdef MYMESSAGES_QPB_H #define MYMESSAGES_QPB_H ... #endif // MYMESSAGES_QPB_HSelecciona el estilo de protección que prefieras según la estructura de tu proyecto.
GENERATE_NON_FINAL_MESSAGES(desde Qt 6.11) genera clases de mensajes « QtProtobuf » sin el especificador «final». Esta opción se proporciona por motivos de compatibilidad con versiones anteriores. Desde Qt 6.11, las clases de mensajes « QtProtobuf » se generan como «final» de forma predeterminada. Para ampliar el comportamiento de los mensajes generados, es preferible utilizar la composición en lugar de la herencia. Esta opción se eliminará en Qt 7.GENERATE_NON_FINAL_PROPERTIES(desde Qt 6.12) genera propiedades de clases de mensajes QtProtobuf sin el especificadorFINAL. El especificador «FINAL» permite que las herramientas de QML apliquen optimizaciones de rendimiento y generen código más eficiente. Desde Qt 6.12, las propiedades de los mensajes « QtProtobuf » se generan con el especificador «FINAL» de forma predeterminada. Esta opción se proporciona únicamente por motivos de compatibilidad con versiones anteriores y se eliminará en Qt 7. Para obtener más información sobre el especificador «FINAL», consulta el Sistema de propiedades de Qt.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.