Verwenden Client-seitiger Bibliotheken für AEM as a Cloud Service using-client-side-libraries

Digitale Erlebnisse beruhen in hohem Maße auf der Client-seitigen Verarbeitung durch einen komplexen JavaScript- und CSS-Code. Client-seitige Bibliotheken von AEM (clientlibs) ermöglichen es Ihnen, diese Client-seitigen Bibliotheken zentral im Repository zu organisieren und zu speichern. In Verbindung mit dem Frontend-Build-Mechanismus im AEM-Projektarchetyp gestaltet sich die Verwaltung Ihres Fronend-Codes für Ihr AEM Projekt unkompliziert.

Vorteile der Verwendung Client-seitiger Bibliotheken in AEM:

Client-seitige Bibliotheken bilden die integrierte Lösung zur Bereitstellung von CSS und JavaScript aus AEM.

Was sind Client-seitige Bibliotheken? what-are-clientlibs

Für Sites sind JavaScript und CSS sowie statische Ressourcen wie Symbole und Webfonts erforderlich, um eine Client-seitige Verarbeitung zu ermöglichen. Eine Client-seitige Bibliothek (Clientlib) ist der Mechanismus von AEM, um auf diese Ressourcen zu verweisen (ggf. nach Kategorie) und sie bereitzustellen.

AEM erfasst die CSS- und JavaScript-Elemente der Site in einer einzigen Datei an einem zentralen Speicherort, um sicherzustellen, dass in der HTML-Ausgabe nur eine Kopie einer Ressource enthalten ist. Dadurch wird die Effizienz der Bereitstellung gesteigert. Außerdem können diese Ressourcen über einen Proxy zentral im Repository verwaltet werden, sodass der Zugriff sicher bleibt.

Frontend-Entwicklung für AEM as a Cloud Service fed-for-aemaacs

Sämtliche JavaScript-, CSS- und anderen Frontend-Elemente sollten im ui.frontend-Modul des AEM-Projektarchetyps vorgehalten werden. Die Flexibilität des Archetyps ermöglicht es Ihnen, Ihre bevorzugten modernen Webtools zu nutzen, um diese Ressourcen zu erstellen und zu verwalten.

Der Archetyp kann die Ressourcen dann in einzelne CSS- und JS-Dateien kompilieren und sie automatisch in einen cq:clientLibraryFolder im Repository einbetten.

Client-seitige Ordnerstruktur der Bibliothek clientlib-folders

Ein Client-seitiger Bibliotheksordner ist ein Repository-Knoten des Typs cq:ClientLibraryFolder. Seine Definition in CND-Notation lautet:

[cq:ClientLibraryFolder] > sling:Folder
  - dependencies (string) multiple
  - categories (string) multiple
  - embed (string) multiple
  - channels (string) multiple

Jeder cq:ClientLibraryFolder wird mit einer Reihe von JS- und/oder CSS-Dateien sowie mehreren unterstützenden Dateien vorab gefüllt (siehe unten). Wichtige Eigenschaften des cq:ClientLibraryFolder sind wie folgt konfiguriert:

Wenn der Client-Bibliotheksordner eine oder mehrere Quelldateien enthält, werden sie zur Laufzeit zu einer einzelnen JS- und/oder CSS-Datei zusammengeführt. Der Name der generierten Datei ist der Knotenname mit der Dateinamenerweiterung .js oder .css. Beispielsweise wird aus einem Bibliotheksknoten mit dem Namen cq.jquery eine Datei mit dem Namen cq.jquery.js oder cq.jquery.css generiert.

Client-Bibliotheksordner enthalten die folgenden Elemente:

Erstellen Client-seitiger Bibliotheksordner creating-clientlib-folders

Client-Bibliotheken müssen sich unter /apps befinden. Diese Regel ist wichtig, um Code besser von Inhalt und Konfiguration zu isolieren.

Damit die Client-Bibliotheken unter /apps zugänglich sind, wird ein Proxy-Servlet verwendet. Die ACLs werden weiterhin im Client-Bibliotheksordner erzwungen, aber das Servlet ermöglicht, dass der Content über /etc.clientlibs/ gelesen wird, wenn die allowProxy-Eigenschaft auf true gesetzt ist.

Bereitstellen Client-seitiger Bibliotheken serving-clientlibs

Sobald Ihr Client-Bibliotheksordner wie erforderlich konfiguriert ist, können Ihre Client-seitige Bibliotheken über einen Proxy angefordert werden. Beispiel:

Mit der allowProxy-Eigenschaft können Sie Folgendes anfordern:

Laden von Client-Bibliotheken über HTL loading-via-htl

Sobald Ihre Client-seitigen Bibliotheken erfolgreich in ihrem Client-Bibliotheksordner gespeichert und verwaltet werden, kann über HTL darauf zugegriffen werden.

Client-Bibliotheken werden über eine durch AEM bereitgestellte Hilfsvorlage geladen, auf die über data-sly-use zugegriffen werden kann. In dieser Datei sind Hilfsvorlagen verfügbar, die über data-sly-call abgerufen werden können.

Jede Hilfsvorlage erwartet eine categories-Option für das Referenzieren der gewünschten Client-Bibliotheken. Bei dieser Option kann es sich um einen Zeichenfolgenwertbereich handeln oder um eine Zeichenfolge, die eine CSV-Liste enthält.

Weitere Informationen zum Laden Client-seitiger Bibliotheken über HTL finden Sie in der HTL-Dokumentation.

Client-Bibliotheken auf einer Autoreninstanz im Vergleich zur Veröffentlichungsinstanz clientlibs-author-publish

Die meisten Client-seitigen Bibliotheken sind für die AEM-Publishing-Instanz erforderlich. Das bedeutet, dass der Zweck der meisten Client-seitigen Bibliotheken darin besteht, das Endanwendererlebnis des Contents zu erstellen. Bei Client-seitigen Bibliotheken auf Veröffentlichungsinstanzen können Frontend-Build-Tools wie oben beschrieben über Client-Bibliotheksordner verwendet und bereitgestellt werden.

Es kann jedoch vorkommen, dass Client-Bibliotheken zum Anpassen des Authoring-Erlebnisses erforderlich sind. Beispielsweise kann es zum Anpassen eines Dialogfelds erforderlich sein, kleine CSS- oder JS-Elemente auf der AEM-Autoreninstanz bereitzustellen.

Verwalten von Client-Bibliotheken auf der Autoreninstanz clientlibs-on-author

Wenn Sie Client-Bibliotheken auf der Autoreninstanz verwenden müssen, können Sie Ihre Client-Bibliotheken unter /apps mit den gleichen Methoden wie für Publishing-Instanzen erstellen, aber sie direkt unter /apps/.../clientlibs/foo schreiben, anstatt zur Verwaltung ein ganzes Projekt zu erstellen.

Anschließend können Sie einen Hook für die JS-Datei auf der Autoreninstanz verwenden, indem Sie Ihre Client-Bibliotheken zu einer vordefinierten Client-Bibliothekskategorie hinzufügen.

Debugging-Tools debugging-tools

AEM bietet eine Vielzahl von Tools zum Debuggen und Testen von Client-Bibliotheksordnern an.

Ermitteln der Client-Bibliotheken discover-client-libraries

Die Komponente /libs/cq/granite/components/dumplibs/dumplibs generiert eine Seite mit Informationen zu allen Client-Bibliotheksordnern im System. Der /libs/granite/ui/content/dumplibs-Knoten hat die Komponente als Ressourcentyp. Um die Seite zu öffnen, verwenden Sie die folgende URL (verwenden Sie je nach Bedarf einen anderen Host und Port):

https://<host>:<port>/libs/granite/ui/content/dumplibs.test.html

Die Informationen enthalten den Bibliothekspfad und -typ (CSS oder JS) sowie die Werte der Bibliotheksattribute, wie Kategorien und Abhängigkeiten. Nachfolgende Tabellen zeigen die Bibliotheken in jeder Kategorie und jedem Kanal an.

Anzeigen der generierten Ausgabe see-generated-output

Die Komponente dumplibs enthält einen Test-Selektor, der den für ui:includeClientLib-Tags generierten Quell-Code anzeigt. Die Seite enthält Code für verschiedene Kombinationen aus JS, CSS und Themenattributen.

Zusätzliche Funktionen für Client-Bibliotheksordner additional-features

Es gibt eine Reihe weiterer Funktionen, die von Client-Bibliothek-Ordnern in AEM unterstützt werden. Diese sind jedoch für AEM as a Cloud Service nicht erforderlich und werden daher nicht empfohlen. Sie werden hier der Vollständigkeit halber aufgelistet.

Adobe Granite HTML Library Manager html-library-manager

Weitere Einstellungen der Client-Bibliothek können über das Bedienfeld Adobe Granite HTML Library Manager der Systemkonsole unter https://<host>:<port>/system/console/configMgr gesteuert werden.

Zusätzliche Ordnereigenschaften additional-folder-properties

Zu den zusätzlichen Ordnereigenschaften gehört die Möglichkeit, Abhängigkeiten und Einbettungen zu kontrollieren, sie sind jedoch im Allgemeinen nicht mehr erforderlich und von ihrer Verwendung wird abgeraten:

Verknüpfen mit Abhängigkeiten linking-to-dependencies

Wenn der Code in Ihrem Client-Bibliotheksordner auf andere Bibliotheken verweist, müssen Sie die anderen Bibliotheken als Abhängigkeiten angeben. Durch das Tag ui:includeClientLib, das Ihren Client-Bibliotheksordner referenziert, enthält der HTML-Code einen Link zu Ihrer generierten Bibliotheksdatei sowie die Abhängigkeiten.

Die Abhängigkeiten müssen ein anderer cq:ClientLibraryFolder sein. Fügen Sie Ihrem cq:ClientLibraryFolder-Knoten eine Eigenschaft mit den folgenden Attributen hinzu, um Abhängigkeiten anzugeben:

Beispielsweise weist /etc/clientlibs/myclientlibs/publicmain eine Abhängigkeit von der cq.jquery-Bibliothek auf. Die Seite, die die Haupt-Client-Bibliothek referenziert, erzeugt HTML-Code, der den folgenden Code enthält:

<script src="/etc/clientlibs/foundation/cq.jquery.js" type="text/javascript">
<script src="/etc/clientlibs/mylibs/publicmain.js" type="text/javascript">

Einbetten von Code aus anderen Bibliotheken embedding-code-from-other-libraries

Sie können Code aus einer Client-Bibliothek in eine andere Client-Bibliothek einbetten. Zur Laufzeit wird der Code der eingebetteten Bibliothek in die generierten JS- und CSS-Dateien der einbettenden Bibliothek eingefügt.

Das Einbetten von Code ist nützlich, um Zugriff auf Bibliotheken zu ermöglichen, die in sicheren Bereichen des Repositorys gespeichert sind.

Anwendungsspezifische Client-Bibliotheksordner app-specific-client-library-folders

Es gilt als Best Practice, alle Dateien, die zu einer Anwendung gehören, im Anwendungsordner unter /apps abzulegen. Außerdem sollten Sie Website-Besuchern den Zugriff auf den Ordner /appsverweigern. Um beide Best Practices einzuhalten, erstellen Sie einen Client-Bibliotheksordner unter dem Ordner /etc, der die Client-Bibliothek unter /apps einbettet.

Legen Sie mit der categories-Eigenschaft den Client-Bibliotheksordner fest, den Sie einbetten möchten. Um die Bibliothek einzubetten, fügen Sie dem eingebetteten cq:ClientLibraryFolder-Knoten eine Eigenschaft mit den folgenden Eigenschaftsattributen hinzu:

Minimieren von Anfragen durch Einbetten using-embedding-to-minimize-requests

In einigen Fällen enthält der endgültige HTML-Code, den Ihre Publishing-Instanz für eine typische Seite generiert, möglicherweise eine recht große Anzahl an <script>-Elementen.

In solchen Fällen kann es nützlich sein, den gesamten benötigten Client-Bibliotheks-Code in einer einzelnen Datei zu kombinieren, um die Anzahl der Anfragen in beide Richtungen beim Laden einer Seite zu reduzieren. Zu diesem Zweck können Sie die erforderlichen Bibliotheken in Ihre App-spezifische Client-Bibliothek einbetten. Nutzen Sie dazu die embed-Eigenschaft des cq:ClientLibraryFolder-Knotens.

Pfade in CSS-Dateien paths-in-css-files

Wenn Sie CSS-Dateien einbetten, verwendet der generierte CSS-Code Pfade zu Ressourcen, die relativ zur einbettenden Bibliothek sind. Beispielsweise bettet die öffentlich zugängliche Bibliothek /etc/client/libraries/myclientlibs/publicmain die Client-Bibliothek /apps/myapp/clientlib ein:

Die Datei main.css enthält den folgenden Stil:

body {
  padding: 0;
  margin: 0;
  background: url(images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

Die CSS-Datei, die der publicmain-Knoten generiert, enthält den folgenden Stil mit der URL des Originalbilds:

body {
  padding: 0;
  margin: 0;
  background: url(../../../apps/myapp/clientlib/styles/images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

Anzeigen eingebetteter Dateien in der HTML-Ausgabe see-embedded-files

Wenn Sie den Ursprung von eingebettetem Code nachvollziehen oder sicherstellen möchten, dass eingebettete Client-Bibliotheken die erwarteten Ergebnisse produzieren, können Sie die Namen der Dateien anzeigen, die zur Laufzeit eingebettet werden. Um die Dateinamen anzuzeigen, hängen Sie den Parameter debugClientLibs=true an die URL Ihrer Web-Seite an. Die Bibliothek, die generiert wird, enthält @import-Anweisungen anstelle des eingebetteten Codes.

Im Beispiel im vorherigen Abschnitt Einbetten von Code aus anderen Bibliotheken bettet der Client-Bibliotheksordner /etc/client/libraries/myclientlibs/publicmain den Client-Bibliotheksordner /apps/myapp/clientlib ein. Wenn Sie den Parameter an die Web-Seite anhängen, wird der folgende Link im Quell-Code der Seite erzeugt:

<link rel="stylesheet" href="/etc/clientlibs/mycientlibs/publicmain.css">

Wenn Sie die Datei publicmain.css öffnen, sehen Sie den folgenden Code:

@import url("/apps/myapp/clientlib/styles/main.css");

Verwendung von Präprozessoren using-preprocessors

AEM ist mit austauschbaren Präprozessoren kompatibel und bietet Unterstützung für YUI Compressor für CSS und JavaScript sowie für Google Closure Compiler (GCC) für JavaScript. YUI ist der Standard-Präprozessor in AEM.

Die austauschbaren Präprozessoren bieten flexible Einsatzmöglichkeiten, z. B.:

Nutzung usage

Sie können die Präprozessorkonfiguration pro Client-Bibliothek oder systemweit festlegen.

Eine Präprozessor-Konfiguration im clientlib-Knoten hat Vorrang vor der OSGi-Konfiguration.

Format und Beispiele format-and-examples

Format format

config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;

YUI Compressor für CSS-Minimierung und GCC für JS yui-compressor-for-css-minification-and-gcc-for-js

cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]

Typescript zur Vorverarbeitung und GCC zur Minimierung und Verschleierung typescript-to-preprocess-and-then-gcc-to-minify-and-obfuscate

jsProcessor: [
   "default:typescript",
   "min:typescript",
   "min:gcc;obfuscate=true"
]

Weitere GCC-Optionen additional-gcc-options

failOnWarning (defaults to "false")
languageIn (defaults to "ECMASCRIPT5")
languageOut (defaults to "ECMASCRIPT5")
compilationLevel (defaults to "simple") (can be "whitespace", "simple", "advanced")

Weitere Informationen zu GCC-Optionen finden Sie in der GCC-Dokumentation.

Festlegen des Systemstandard-Minimierers set-system-default-minifier

YUI ist in AEM der Standardminimierer. Um stattdessen GCC festzulegen, führen Sie die folgenden Schritte aus.