En esta página

qt_add_grpc

Genera servicios en C++ basados en Qt utilizando un esquema protobuf

El comando está definido en el componente Grpc del paquete Qt6. Carga el paquete con:

find_package(Qt6 REQUIRED COMPONENTS Grpc)

Este comando se introdujo en Qt 6.5.

Normalmente, « qtgrpcgen » se invoca mediante la macro CMake « qt_add_grpc ».

Sinopsis

qt_add_grpc(<target> <CLIENT|SERVER>
    PROTO_FILES <file> ...
    [PROTO_INCLUDES <path> ...]
    [QML]
    [OUTPUT_DIRECTORY <dir>]
    [GENERATE_PACKAGE_SUBFOLDERS]
    [COPY_COMMENTS]
    [EXPORT_MACRO <infix>]
    [OUTPUT_HEADERS <var>]
    [OUTPUT_TARGETS <var>]
    [HEADER_GUARD <pragma|filename>]
)

Nota: Actualmentesolo se admite la generación de código « CLIENT ».

Si los comandos sin versión están desactivados, utiliza en su lugar « qt6_add_grpc() ». Admite el mismo conjunto de argumentos que este comando.

Descripción

Los archivos fuente se crean mediante qtgrpcgen y se añaden al destino. Si el destino ya existe, los archivos se añaden a la lista de fuentes del destino. Si el destino no existe, se crea como una biblioteca a la que debes vincular.

La gRPC™ biblioteca que se genera mediante el comando « qt_add_grpc » hace referencia a los símbolos protobuf que se utilizan en las llamadas al servicio. Esto significa que debes utilizar un destino común tanto en las llamadas a `qt_add_protobuf()` como a `qt_add_grpc() `, o bien vincular la biblioteca protobuf generada a la de « gRPC ».

Teniendo en cuenta lo anterior, puedes reutilizar el destino tanto para el código cliente de protobuf como para el de gRPC:

# Generate the protobuf types first
qt_add_protobuf(test_service_client
    PROTO_FILES
        test_service.protobuf
)
...
# Reuse the protobuf target and extend it with \gRPC client
# functionality
qt_add_grpc(test_service_client CLIENT
    PROTO_FILES
        test_service.protobuf
)

Si desea tener objetivos separados, deberá vincular el objetivo del cliente de gRPC al de protobuf:

# Generate the protobuf types first
qt_add_protobuf(test_service_protobuf
    PROTO_FILES
        test_service.protobuf
)
...
# Add separate target with the generated code of the \gRPC client.
qt_add_grpc(test_service_client CLIENT
    PROTO_FILES
        test_service.protobuf
)
target_link_libraries(test_service_client PRIVATE test_service_protobuf)

Argumentos

  • PROTO_FILES especifica la lista de archivos .proto utilizados por el procedimiento de generación de código.
  • PROTO_INCLUDES Especifica la lista de directorios en los que se buscarán las dependencias de Protobuf.

    Nota: La ubicación de PROTO_FILES se considera implícitamente parte de la ruta de inclusión de protobuf.

  • QML Genera la API de cliente QML para el servicio gRPC. El argumento requiere el componente Qt « GrpcQuick ».
    find_package(Qt6 6.8 REQUIRED COMPONENTS Quick Protobuf ProtobufQuick Grpc GrpcQuick)
    ...
    # Generate the protobuf types
    qt_add_protobuf(test_service_client
        PROTO_FILES
            test_service.protobuf
        QML
    )
    ...
    # Generate \gRPC client functionality
    qt_add_grpc(test_service_client CLIENT
        PROTO_FILES
            test_service.protobuf
        QML
    )
  • OUTPUT_DIRECTORY Define el directorio en el que se colocarán los archivos generados. Por defecto, se utiliza el directorio de compilación actual.
  • GENERATE_PACKAGE_SUBFOLDERS Utiliza el especificador de nombre de paquete de los archivos .proto para 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/.
  • COPY_COMMENTS copia los comentarios de los archivos .proto al código generado.
  • EXPORT_MACRO Se aplica únicamente al crear una nueva biblioteca compartida a partir de <target>. Esta opción especifica el nombre base de la macro de exportación utilizada en el código generado. El nombre final de la macro se construye como QPB_<EXPORT_MACRO>_EXPORT. Si no se establece esta opción, se utiliza el nombre del objetivo como EXPORT_MACRO.

    Consulte «Creación de bibliotecas compartidas » para obtener información más detallada.

  • OUTPUT_HEADERS Especifica una variable que almacenará la lista de encabezados generados. Esta lista puede resultar útil para definir reglas de instalación personalizadas del proyecto.
  • OUTPUT_TARGETS Especifica una variable que almacenará la lista de objetivos generados. Esta lista puede resultar útil para definir reglas de instalación personalizadas del proyecto.
  • HEADER_GUARD especifica el mecanismo utilizado para evitar la inclusión múltiple de los archivos de cabecera generados. Los valores posibles son pragma y filename. El valor por defecto es filename. Al establecer la opción en pragma, se genera la protección de cabecera pragma moderna:
    #pragma once
    ...

    Si se omite la opción o se establece en filename, se genera la protección de envoltura ifdef y se utiliza el nombre de archivo «.proto» como infijo de protección:

    #ifdef MYMESSAGES_QPB_H
    #define MYMESSAGES_QPB_H
    ...
    #endif // MYMESSAGES_QPB_H

    Selecciona el estilo de protección que prefieras según la estructura de tu proyecto.

Véase también La herramienta qtgrpcgen.

© 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.