Blijvende GraphQL-query's persisted-graphql-queries

Persisted query's zijn GraphQL query's die worden gemaakt en opgeslagen op de Adobe Experience Manager (AEM) as a Cloud Service server. Ze kunnen worden aangevraagd met een GET-aanvraag door clienttoepassingen. De reactie van een verzoek van de GET kan bij de verzender en lagen CDN in het voorgeheugen ondergebracht worden, die uiteindelijk de prestaties van de het verzoeken cliënttoepassing verbeteren. Dit verschilt van standaard GraphQL query's, die worden uitgevoerd met behulp van POST-aanvragen waarbij de reactie niet gemakkelijk in cache kan worden geplaatst.

IDE GraphiQLis beschikbaar in AEM voor u om, uw vragen van GraphQL te ontwikkelen te testen en voort te zetten, alvorens over te brengen naar uw productiemilieu. Voor gevallen die aanpassing (bijvoorbeeld, wanneer het geheime voorgeheugenaanpassen) nodig hebben kunt u API gebruiken; zie het cURL voorbeeld dat in wordt verstrekt hoe te om een vraag van GraphQLvoort te zetten.

Blijvende query's en eindpunten persisted-queries-and-endpoints

De aangehouden vragen moeten altijd het eindpunt met betrekking tot de aangewezen configuratie van Plaatsengebruiken; zodat kunnen zij of, of allebei gebruiken:

Als er bijvoorbeeld een bepaalde query met de naam my-query is, die een model my-model uit de configuratie Sites my-conf gebruikt:

Een GraphQL-query laten doorgaan how-to-persist-query

Het wordt geadviseerd om vragen over een AEM auteursmilieu aanvankelijk en dan over te zetten de vraagaan uw productie AEM milieu, voor gebruik door toepassingen publiceren.

Er zijn verschillende methoden om query's te blijven uitvoeren, waaronder:

IDE GraphiQL is de geprefereerde methode voor het voortduren van vragen. Om een bepaalde vraag voort te zetten gebruikend het cURL hulpmiddel van de bevellijn:

Hoe te om een Verlengde vraag uit te voeren execute-persisted-query

Een clienttoepassing vraagt een aanvraag tot GET met de volgende syntaxis uit om een query met behoud van waarden uit te voeren:

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

Waar PERSISTENT_PATH een verkort pad is naar waar de Persisted-query wordt opgeslagen.

Query-variabelen gebruiken query-variables

De variabelen van de vraag kunnen met Verblijfsde Vragen worden gebruikt. De vraagvariabelen worden toegevoegd aan het verzoek vooraf bepaald met een puntkomma (;) gebruikend de veranderlijke naam en de waarde. Meerdere variabelen worden gescheiden door puntkomma's.

Het patroon ziet er als volgt uit:

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

De volgende query bevat bijvoorbeeld een variabele activity om een lijst te filteren op basis van een activiteitwaarde:

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

Deze query kan worden uitgevoerd onder een pad wknd/adventures-by-activity . Om de Persisted vraag te roepen waar activity=Camping het verzoek als dit zou kijken:

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

De UTF-8-codering %3B is voor ; en %3D is de codering voor = . De vraagvariabelen en om het even welke speciale karakters moeten behoorlijkvoor de Persisted vraag worden gecodeerd om uit te voeren.

Query-variabelen gebruiken - Aanbevolen werkwijzen query-variables-best-practices

Wanneer het gebruiken van variabelen in uw vragen zijn er een paar beste praktijken die zouden moeten worden gevolgd:

Door uw doorlopende query's in cache te plaatsen caching-persisted-queries

De geadviseerde vragen worden geadviseerd aangezien zij bij de Dispatcheren de lagen van het Netwerk van de Levering van de Inhoud (CDN) in het voorgeheugen kunnen worden ondergebracht, uiteindelijk verbeterend de prestaties van de het vragen cliënttoepassing.

AEM maakt de cache standaard ongeldig op basis van de definitie Tijd tot live (TTL). Deze TTLs kan door de volgende parameters worden bepaald. Deze parameters zijn op verschillende manieren toegankelijk, waarbij de namen variëren volgens het gebruikte mechanisme:

Auteursinstanties author-instances

Voor auteur-instanties zijn de standaardwaarden:

Hiervoor gold het volgende:

Publish-instanties publish-instances

Voor publicatie-instanties zijn de standaardwaarden:

Deze kunnen worden overschreven:

Het beheren van de Kopballen van het Geheime voorgeheugen van HTTP in GrahiQL winde http-cache-headers-graphiql-ide

GrahiQL winde - zie het Opslaan van Persisted Vragen

Het beheren van Geheime voorgeheugen op het Aanhoudende Niveau van de Vraag cache-persisted-query-level

Dit omvat het posten van de vraag aan AEM gebruikend cURL in uw interface van de bevellijn.

Een voorbeeld van de methode PUT (create):

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} }'

Een voorbeeld van de methode POST (update):

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} }'

cache-control kan op de aanmaaktijd (PUT) of later worden ingesteld (bijvoorbeeld via een verzoek om POST). Het cache-control is optioneel wanneer u de aanhoudend query maakt, omdat AEM de standaardwaarde kan opgeven. Zie hoe te om een vraag van GraphQL, voor een voorbeeld voort te zetten om een vraag te gebruiken cURL.

Cache beheren met Cloud Manager-variabelen cache-cloud-manager-variables

de Variabelen van het Milieu van Cloud Managerkunnen met Cloud Manager worden bepaald om de vereiste waarden te bepalen:

Het beheren van Geheime voorgeheugen met een configuratie OSGi cache-osgi-configration

Om het geheime voorgeheugen globaal te beheren, kunt u de montages OSGivoor de Verlengde Configuratie van de Dienst van de Vraag vormen.

De standaard configuratie OSGi voor publiceer instanties:

De antwoordcode voor de query configureren configuring-query-response-code

Standaard verzendt PersistedQueryServlet een 200 -reactie wanneer een query wordt uitgevoerd, ongeacht het werkelijke resultaat.

U kunt de montages OSGivoor de Versiesde Configuratie van de Dienst van de Vraag vormen om te controleren of de meer gedetailleerde statuscodes door het /execute.json/persisted-query eindpunt zijn teruggekeerd, wanneer er een fout in de gepersisteerde vraag is.

Het veld Respond with application/graphql-response+json (responseContentTypeGraphQLResponseJson) kan als vereist worden gedefinieerd:

De URL van de query coderen voor gebruik door een app encoding-query-url

Voor gebruik door een toepassing, moeten om het even welke speciale karakters die wanneer het construeren van vraagvariabelen (namelijk puntkomma's (;), gelijkteken (=), schuine strepen /) worden gebruikt worden omgezet om het overeenkomstige coderen te gebruiken UTF-8.

Bijvoorbeeld:

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"

De URL kan worden opgesplitst in de volgende onderdelen:

In onbewerkte tekst ziet de aanvraag-URI er als volgt uit:

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

Om een voortgezette vraag in een cliënttoepassing te gebruiken, zou de AEM headless cliënt SDK voor JavaScript, Java, of NodeJSmoeten worden gebruikt. De Headless Client SDK codeert alle queryvariabelen automatisch naar behoren in de aanvraag.

Het overbrengen van een blijvende vraag aan uw milieu van de Productie transfer-persisted-query-production

De gepersisteerde vragen zouden altijd op de dienst van de Auteur van de AEM moeten worden gecreeerd en dan (herhaald) aan de dienst van AEM Publish gepubliceerd. Vaak, worden de Persisted vragen gecreeerd en op lagere milieu's zoals lokale of milieu's van de Ontwikkeling getest. Het is dan noodzakelijk om Persisted query's naar omgevingen op een hoger niveau te promoten, zodat ze uiteindelijk beschikbaar worden gesteld op een productie AEM Publish-omgeving voor gebruik door clienttoepassingen.

Voorbehouden query's verpakken

De aanhoudende vragen kunnen in AEM Pakkettenworden gebouwd. AEM pakketten kunnen vervolgens worden gedownload en geïnstalleerd in verschillende omgevingen. AEM Pakketten kunnen ook worden gerepliceerd vanuit een AEM Auteur-omgeving naar AEM Publish-omgevingen.

Een pakket maken:

Nadat het pakket is gemaakt, kunt u: