AEM Headless SDK
Das AEM Headless-SDK ist eine Reihe von Bibliotheken, die von Clients verwendet werden können, um schnell und einfach mit AEM Headless-APIs über HTTP zu interagieren.
Das AEM Headless-SDK ist für verschiedene Plattformen verfügbar:
Persistierte GraphQL-Abfragen
Das Abfragen von AEM mit GraphQL unter Verwendung von persistierten Abfragen (im Gegensatz zu Client-definierten GraphQL-Abfragen) ermöglicht es Entwicklerinnen und Entwicklern, eine Abfrage (aber nicht deren Ergebnisse) in AEM zu persistieren und dann anzufordern, dass die Abfrage nach Namen ausgeführt wird. Persistierte Abfragen ähneln dem Konzept gespeicherter Prozeduren in SQL-Datenbanken.
Persistierte Abfragen sind leistungsfähiger als Client-definierte GraphQL-Abfragen, da persistierte Abfragen mithilfe von HTTP-GET ausgeführt werden, der auf den CDN- und AEM Dispatcher-Ebenen zwischenspeicherbar ist. Persistierte Abfragen sind auch effektiv, definieren eine API und entbinden die Entwicklerin bzw. den Entwickler von der Notwendigkeit, die Details der einzelnen Inhaltsfragmentmodelle zu verstehen.
Code-Beispiele persisted-graphql-queries-code-examples
Im Folgenden finden Sie Code-Beispiele zum Ausführen einer von GraphQL persistierten Abfrage gegen AEM.
Installieren Sie @adobe/aem-headless-client-js durch Ausführen des Befehls npm install
aus dem Stammverzeichnis Ihres Node.js-Projekts.
code language-none |
---|
|
Dieses Code-Beispiel zeigt, wie Sie AEM mit dem npm-Modul @adobe/aem-headless-client-js unter Verwendung der Syntax async/await
abfragen. Das AEM Headless-SDK für JavaScript unterstützt auch die Promise-Syntax.
Dieser Code setzt eine persistierte Abfrage mit dem Namen wknd/adventureNames
voraus, wurde in AEM Author erstellt und in AEM Publish veröffentlicht.
code language-javascript |
---|
|
Installieren Sie @adobe/aem-headless-client-js durch Ausführen des Befehls npm install
aus dem Stammverzeichnis Ihres React-Projekts.
code language-none |
---|
|
In diesem Code-Beispiel wird gezeigt, wie der Hook React useEffect(…)verwendet wird, um einen asynchronen Aufruf an AEM GraphQL auszuführen.
Die Verwendung von useEffect
für den asynchronen GraphQL-Aufruf in React ist aus folgenden Gründen nützlich:
- Es stellt einen synchronen Wrapper für den asynchronen Aufruf an AEM bereit.
- Es reduziert unnötige Neuanforderungen von AEM.
Dieser Code setzt eine persistierte Abfrage mit dem Namen wknd-shared/adventure-by-slug
voraus, wurde in AEM Author erstellt und mit GraphiQL in AEM Publish veröffentlicht.
code language-javascript |
---|
|
Rufen Sie den benutzerdefinierten React-Hook useEffect
von einer anderen Stelle in einer React-Komponente auf.
code language-javascript |
---|
|
Es können neue useEffect
-Hooks für jede persistierte Abfrage erstellt werden, die die React-App verwendet.
GraphQL-Abfragen
AEM unterstützt Client-definierte GraphQL-Abfragen. Die beste AEM-Praxis ist jedoch, persistierte GraphQL-Abfragen zu verwenden.
Webpack 5+
Das AEM Headless JS SDK weist Abhängigkeiten mit util
auf, was standardmäßig nicht in Webpack 5+ enthalten ist. Wenn Sie Webpack 5+ verwenden und den folgenden Fehler erhalten:
Compiled with problems:
× ERROR in ./node_modules/@adobe/aio-lib-core-errors/src/AioCoreSDKErrorWrapper.js 12:13-28
Module not found: Error: Can't resolve 'util' in '/Users/me/Code/wknd-headless-examples/node_modules/@adobe/aio-lib-core-errors/src'
BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.
This is no longer the case. Verify if you need this module and configure a polyfill for it.
If you want to include a polyfill, you need to:
- add a fallback 'resolve.fallback: { "util": require.resolve("util/") }'
- install 'util'
If you don't want to include a polyfill, you can use an empty module like this:
resolve.fallback: { "util": false }
Fügen Sie folgende devDependencies
in Ihre Datei package.json
ein:
"devDependencies": {
"buffer": "npm:buffer@^6.0.3",
"crypto": "npm:crypto-browserify@^3.12.0",
"http": "npm:stream-http@^3.2.0",
"https": "npm:https-browserify@^1.0.0",
"stream": "npm:stream-browserify@^3.0.0",
"util": "npm:util@^0.12.5",
"zlib": "npm:browserify-zlib@^0.2.0"
},
Führen Sie dann npm install
aus, um die Abhängigkeiten zu installieren.