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.
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 se personaliza la caché) puede utilizar la API; consulte el ejemplo de cURL que se proporciona en Persistencia de una consulta de GraphQL.
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:
Consulte Habilitar la funcionalidad de fragmento de contenido en el explorador de configuración para obtener más información.
Las Consultas persistentes de GraphQL deben estar habilitadas 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
:
my-conf
específico, y luego la consulta se guardará de la siguiente manera:/conf/my-conf/settings/graphql/persistentQueries/my-query
global
, pero la consulta se guardará de la siguiente manera:/conf/global/settings/graphql/persistentQueries/my-query
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.
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:
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
}
}
}
}'
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"
}
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
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
}
}
}
}'
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 } } } }"}'
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 }}'
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
}
}
}
}'
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 donde se guarda la consulta persistente.
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
Ejecución de una consulta con parámetros.
Las variables y los valores de consulta deben ser codificados correctamente 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.
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.
Se recomiendan las Consultas persistentes, ya que se pueden almacenar en caché en las capas de Dispatcher y la Red de distribución de contenido (CDN), mejorando finalmente el rendimiento de la aplicación cliente solicitante.
De forma predeterminada, AEM invalidará la caché en función de una definición de tiempo de vida (TTL). Estos TTL se pueden definir mediante los siguientes parámetros. Se puede acceder a estos parámetros de varias formas, con variaciones en los nombres según el mecanismo utilizado:
Tipo de caché | Encabezado de HTTP | cURL | Configuración de OSGi | Cloud Manager |
---|---|---|---|---|
Explorador | max-age |
cache-control : max-age |
cacheControlMaxAge |
graphqlCacheControl |
La red de distribución de contenido (CDN) | s-maxage |
surrogate-control : max-age |
surrogateControlMaxAge |
graphqlSurrogateControl |
La red de distribución de contenido (CDN) | stale-while-revalidate |
surrogate-control : stale-while-revalidate |
surrogateControlStaleWhileRevalidate |
graphqlStaleWhileRevalidate |
La red de distribución de contenido (CDN) | stale-if-error |
surrogate-control : stale-if-error |
surrogateControlStaleIfError |
graphqlStaleIfError |
En las instancias de autor, los valores predeterminados son:
max-age
: 60s-maxage
: 60stale-while-revalidate
: 86400stale-if-error
: 86400Estos:
cache-control
y/o surrogate-control
; para ver ejemplos, consulte Administración de la caché en el nivel de consulta persistentePara las instancias de publicación, los valores predeterminados son:
max-age
: 60s-maxage
: 7200stale-while-revalidate
: 86400stale-if-error
: 86400Se pueden sobrescribir:
en el Nivel de Consulta persistente; esto implica publicar la consulta en AEM usando cURL en la interfaz de línea de comandos y publicar la Consulta persistente.
El IDE de GraphiQL: consulte Guardado de consultas persistentes
Esto implica publicar la consulta en AEM usando cURL en la interfaz de línea de comandos.
Para ver un ejemplo del método PUT (crear):
curl -u admin:admin -X PUT \
--url "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
--header "Content-Type: application/json" \
--data '{ "query": "{articleList { items { _path author } } }", "cache-control": { "max-age": 300 }, "surrogate-control": {"max-age":600, "stale-while-revalidate":1000, "stale-if-error":1000} }'
Para ver un ejemplo del método POST (actualización):
curl -u admin:admin -X POST \
--url "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
--header "Content-Type: application/json" \
--data '{ "query": "{articleList { items { _path author } } }", "cache-control": { "max-age": 300 }, "surrogate-control": {"max-age":600, "stale-while-revalidate":1000, "stale-if-error":1000} }'
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 Cómo hacer persistir una consulta de GraphQL, para ver un ejemplo de persistencia de una consulta utilizando cURL.
Variables de entorno de Cloud Manager se puede definir con Cloud Manager para definir los valores necesarios:
Nombre | Value | Servicio aplicado | Tipo |
---|---|---|---|
graphqlStaleIfError |
86400 | según proceda | según proceda |
graphqlSurrogateControl |
600 | según proceda | según proceda |
Para administrar la caché globalmente, puede configurar la configuración de OSGi para la Configuración del servicio de consulta persistente.
La configuración de OSGi solo es adecuada para instancias de publicación. La configuración existe en instancias de autor, pero se ignora.
La configuración de OSGi predeterminada para instancias de publicación:
lee las variables de Cloud Manager si están disponibles:
Propiedad de configuración de OSGi | lee esto | Variable de Cloud Manager |
---|---|---|
cacheControlMaxAge |
lee | graphqlCacheControl |
surrogateControlMaxAge |
lee | graphqlSurrogateControl |
surrogateControlStaleWhileRevalidate |
lee | graphqlStaleWhileRevalidate |
surrogateControlStaleIfError |
lee | graphqlStaleIfError |
y si no está disponible, la configuración de OSGi utiliza la variable valores predeterminados para instancias de publicació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 |
Punto de conexión 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.
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.
Las consultas persistentes se pueden integrar en Paquetes de 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:
persistentQueries
debajo de la configuración. Por ejemplo, para la configuración wknd
la ruta completa será /conf/wknd/settings/graphql/persistentQueries
.Una vez creado el paquete, puede hacer lo siguiente: