Consultas persistentes de GraphQL

Las consultas persistentes son consultas de GraphQL que se crean y almacenan en el servidor de Adobe Experience Manager (AEM) as a Cloud Service. Las consultas persistentes pueden solicitarlas las aplicaciones cliente con una petición GET. La respuesta de una petición GET se puede almacenar en caché en las capas de Dispatcher y CDN, lo que a la larga mejora el rendimiento de la aplicación cliente solicitante. Esto difiere de las consultas estándar de GraphQL, que se ejecutan mediante peticiones POST en las que la respuesta no se puede almacenar en caché fácilmente.

NOTA

Se recomiendan las consultas persistentes. Consulte Prácticas recomendadas para consultas de GraphQL (Dispatcher) para obtener más información y la configuración de Dispatcher relacionada.

El IDE de GraphiQL está disponible en AEM para que desarrolle, pruebe y mantenga sus consultas de GraphQL antes de la transferencia a su entorno de producción. Para los casos que necesitan personalización (por ejemplo, cuando personaliza la caché) puede utilizar la API; consulte el ejemplo de curl que se proporciona en Persistencia de una consulta de GraphQL.

Consultas y puntos de conexión persistentes

Las consultas persistentes siempre deben utilizar el punto de conexión relacionado con la configuración de Sites adecuada, para que puedan usar una o ambas:

  • La configuración global y el punto de conexión
    La consulta tiene acceso a todos los modelos de fragmentos de contenido.
  • Configuraciones de sitios específicas y puntos de conexión
    La creación de una consulta persistente para una configuración de sitios específica requiere un punto de conexión específico de configuración de sitios correspondiente (para proporcionar acceso a los modelos de fragmentos de contenido relacionados).
    Por ejemplo, para crear una consulta persistente específica para la configuración de WKND Sites, se debe crear de antemano una configuración de sitios específica de WKND y un punto de conexión específico de WKND.
NOTA

Consulte Habilitar la funcionalidad de fragmento de contenido en el explorador de configuración para obtener más información.

La variable Consultas persistentes de GraphQL debe estar habilitado, para la configuración de sitios adecuada.

Por ejemplo, si hay una consulta en particular llamada my-query, que utiliza un modelo my-model desde la configuración de Sites my-conf:

  • Puede crear una consulta utilizando el punto de conexión my-conf específico, y luego la consulta se guardará de la siguiente manera:
    /conf/my-conf/settings/graphql/persistentQueries/my-query
  • Puede crear la misma consulta utilizando el punto de conexión global, pero la consulta se guardará de la siguiente manera:
    /conf/global/settings/graphql/persistentQueries/my-query
NOTA

Estas son dos consultas distintas: se guardan en rutas diferentes.

Simplemente, utilizan el mismo modelo, pero a través de puntos de conexión diferentes.

Cómo conservar una consulta de GraphQL

Se recomienda mantener las consultas en un entorno de creación de AEM primero, y después transferir la consulta al entorno de publicación de producción de AEM para su uso por parte de las aplicaciones.

Existen varios métodos para hacer que persistan las consultas, entre los que se incluyen los siguientes:

El IDE de GraphiQL es el método preferido para consultas persistentes. Para mantener una consulta determinada utilizando la herramienta línea de comandos curl:

  1. Prepare la consulta colocándola en la nueva URL de punto de conexión /graphql/persist.json/<config>/<persisted-label>.

    Por ejemplo, cree una consulta persistente:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
        }
      }
    }'
    
  2. En este punto, compruebe la respuesta.

    Por ejemplo, compruebe si se ha realizado correctamente:

    {
      "action": "create",
      "configurationName": "wknd",
      "name": "plain-article-query",
      "shortPath": "/wknd/plain-article-query",
      "path": "/conf/wknd/settings/graphql/persistentQueries/plain-article-query"
    }
    
  3. A continuación, puede solicitar la consulta persistente usando GET en la dirección URL /graphql/execute.json/<shortPath>.

    Por ejemplo, utilice la consulta persistente:

    $ curl -X GET \
        http://localhost:4502/graphql/execute.json/wknd/plain-article-query
    
  4. Actualice una consulta persistente usando POST en una ruta de consulta ya existente.

    Por ejemplo, utilice la consulta persistente:

    $ curl -X POST \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
          referencearticle {
            _path
          }
        }
      }
    }'
    
  5. Cree una consulta sin formato ajustada.

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-wrapped" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }"}'
    
  6. Cree una consulta sencilla ajustada con control de caché.

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
    
  7. Cree una consulta persistente con parámetros:

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-parameters" \
        -d \
    'query GetAsGraphqlModelTestByPath($apath: String!, $withReference: Boolean = true) {
      articleByPath(_path: $apath) {
        item {
          _path
            author
            main {
            plaintext
            }
            referencearticle @include(if: $withReference) {
            _path
            }
          }
        }
      }'
    

Ejecución de una consulta persistente

Para ejecutar una consulta persistente, una aplicación cliente realiza una petición GET utilizando la siguiente sintaxis:

GET <AEM_HOST>/graphql/execute.json/<PERSISTENT_PATH>

Donde PERSISTENT_PATH es una ruta abreviada en la que se guarda la consulta persistente.

  1. Por ejemplo wknd es el nombre de configuración y plain-article-query es el nombre de la consulta persistente. Para ejecutar la consulta:

    $ curl -X GET \
        https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query
    
  2. Ejecución de una consulta con parámetros.

    NOTA

    Las variables y los valores de consulta deben ser correctos codificado al ejecutar una consulta persistente.

    Por ejemplo:

    $ curl -X GET \
        "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query-parameters%3Bapath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fmagazine%2Falaska-adventure%2Falaskan-adventures%3BwithReference%3Dfalse
    

    Consulte variables de consulta para obtener más información.

Uso de variables de consulta

Las variables de consulta se pueden usar con Consultas persistentes. Las variables de consulta se anexan a la solicitud con el prefijo punto y coma (;) empleando el nombre y valor de la variable. Las variables múltiples se separan con punto y coma.

El patrón tiene el siguiente aspecto:

<AEM_HOST>/graphql/execute.json/<PERSISTENT_QUERY_PATH>;variable1=value1;variable2=value2

Por ejemplo, la siguiente consulta contiene una variable activity para filtrar una lista en función de un valor de actividad:

query getAdventuresByActivity($activity: String!) {
      adventureList (filter: {
        adventureActivity: {
          _expressions: [
            {
              value: $activity
            }
          ]
        }
      }){
        items {
          _path
        adventureTitle
        adventurePrice
        adventureTripLength
      }
    }
  }

Esta consulta se puede mantener en una ruta wknd/adventures-by-activity. Para llamar a la consulta persistente donde activity=Camping la solicitud tendría este aspecto:

<AEM_HOST>/graphql/execute.json/wknd/adventures-by-activity%3Bactivity%3DCamping

Tenga en cuenta que %3B es la codificación UTF-8 para ; y %3D es la codificación para =. Las variables de consulta y los caracteres especiales deben ser codificados correctamente para que se ejecute la consulta persistente.

Almacenamiento en caché de las consultas persistentes

Se recomiendan las consultas persistentes, ya que se pueden almacenar en caché en las capas de Dispatcher y CDN, lo que a la larga mejora el rendimiento de la aplicación cliente solicitante.

De forma predeterminada, AEM invalidará la caché de la red de distribución de contenido (CDN) en función de un tiempo de vida predeterminado (TTL).

Este valor se establece en lo siguiente:

  • 7200 segundos es el TTL predeterminado para Dispatcher y CDN; también conocido como cachés compartidas
    • predeterminado: s-maxage=7200
  • 60 es el TTL predeterminado para el cliente (por ejemplo, un explorador)
    • default: maxage=60

Si desea cambiar el TTL para la consulta de GraphLQ, la consulta debe ser la siguiente:

Administración de encabezados de caché HTTP en GraphQL

El IDE de GraphiQL: consulte Guardado de consultas persistentes

Administración de caché desde la API

Esto implica publicar la consulta en AEM usando CURL en la interfaz de línea de comandos.

Por ejemplo:

curl -X PUT \
    -H 'authorization: Basic YWRtaW46YWRtaW4=' \
    -H "Content-Type: application/json" \
    "https://publish-p123-e456.adobeaemcloud.com/graphql/persist.json/wknd/plain-article-query-max-age" \
    -d \
'{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'

El cache-control se puede configurar en el momento de la creación (PUT) o más tarde (por ejemplo, mediante una petición POST). El control de caché es opcional al crear la consulta persistente, ya que AEM puede proporcionar el valor predeterminado. Consulte Conservación de una consulta de GraphQL para ver un ejemplo de persistencia de una consulta utilizando curl.

Codificación de la URL de consulta para su uso en una aplicación

Para su uso en una aplicación, cualquier carácter especial utilizado al construir variables de consulta (es decir, punto y coma (;), signo igual (=), barras oblicuas /) debe convertirse para utilizar la codificación UTF-8 correspondiente.

Por ejemplo:

curl -X GET \ "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/adventure-by-path%3BadventurePath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fadventures%2Fbali-surf-camp%2Fbali-surf-camp"

La dirección URL se puede desglosar en las siguientes partes:

Parte URL Descripción
/graphql/execute.json Extremo de consulta persistente
/wknd/adventure-by-path Ruta de consulta persistente
%3B Codificación de ;
adventurePath Variable de consulta
%3D Codificación de =
%2F Codificación de /
%2Fcontent%2Fdam... Ruta codificada al fragmento de contenido

En texto sin formato, el URI de solicitud tiene el siguiente aspecto:

/graphql/execute.json/wknd/adventure-by-path;adventurePath=/content/dam/wknd/en/adventures/bali-surf-camp/bali-surf-camp

Para utilizar una consulta persistente en una aplicación cliente, se debe utilizar el SDK de cliente AEM sin encabezado para JavaScript, Java o NodeJS. El SDK de cliente sin encabezado codificará automáticamente todas las variables de consulta de la forma adecuada en la solicitud.

Transferencia de una consulta persistente al entorno de producción

Las consultas persistentes siempre deben crearse en un servicio de AEM Author y luego publicarse (replicarse) en un servicio de AEM Publish. A menudo, las consultas persistentes se crean y prueban en entornos más bajos, como los entornos locales o de desarrollo. A continuación, es necesario promocionar las consultas persistentes a entornos de nivel superior, para que finalmente estén disponibles en un entorno de publicación de AEM de producción para que las aplicaciones de cliente las consuman.

Empaquetar consultas persistentes

Las consultas persistentes se pueden incorporar en Paquetes AEM. Los paquetes AEM se pueden descargar e instalar en diferentes entornos. Los paquetes AEM también se pueden replicar desde un entorno de AEM Author a entornos de AEM Publish.

Para crear un paquete, haga lo siguiente:

  1. Vaya a Herramientas > Implementación > Paquetes.
  2. Cree un nuevo paquete tocando Crear paquete. Se abre un cuadro de diálogo para definir el paquete.
  3. En el cuadro de diálogo Definición de paquete, en General introduzca un Nombre como “wknd-persistent-queries”.
  4. Escriba un número de versión como “1.0”.
  5. En Filtros, agregue un nuevo Filtro. Utilice el Buscador de rutas para seleccionar la carpeta persistentQueries debajo de la configuración. Por ejemplo, para la configuración wknd la ruta completa será /conf/wknd/settings/graphql/persistentQueries.
  6. Toque Guardar para guardar la nueva definición del paquete y cerrar el cuadro de diálogo.
  7. Toque el botón Generar en la definición del paquete recién creada.

Una vez creado el paquete, puede hacer lo siguiente:

  • Descargar el paquete y vuelva a cargarlo en un entorno diferente.
  • Replicar el paquete tocando Más > Replicar. Esto replicará el paquete en el entorno de publicación de AEM conectado.

En esta página