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.
Frontend-Entwicklerinnen und -Entwickler, die CSS und JavaScript für AEM-Projekte verwenden, sollten sich auch mit dem AEM-Projektarchetyp und seinem automatisierten Frontend-Build-Mechanismus vertraut machen.
Für Sites sind JavaScript und CSS sowie statische Ressourcen wie Symbole und Webfonts erforderlich, um eine Client-seitige Verarbeitung zu ermöglichen. Eine clientlib ist AEM Mechanismus zum Verweisen (bei Bedarf nach Kategorie) und zur Bereitstellung solcher Ressourcen.
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.
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 verwenden, 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.
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
cq:ClientLibraryFolder
-Knoten können an einer beliebigen Stelle innerhalb der /apps
-Unterstruktur des Repositorys platziert werden.categories
-Eigenschaft des Knotens, um festzulegen, zu welchen Bibliothekskategorien er gehört.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:
allowProxy
: Da alle Client-seitigen Bibliotheken unter apps
gespeichert werden müssen, ermöglicht diese Eigenschaft den Zugriff auf Client-Bibliotheken über das Proxy-Servlet. Siehe Finden eines Client-Bibliotheksordners und Verwendung des Proxy-Servlets für Client-Bibliotheken weiter unten.categories
: Gibt die Kategorien der Gruppe von JS- und/oder CSS-Dateien in diesem cq:ClientLibraryFolder
an. Da die categories
-Eigenschaft ggf. mehrere Werte aufweist, kann ein Bibliotheksordner zu mehreren Kategorien gehören (weiter unten sehen Sie, warum dies nützlich sein kann).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:
js.txt
und/oder css.txt
, die die Quelldateien angibt, die in den generierten JS- und/oder CSS Dateien zusammengeführt werden sollenClient-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.
https://<host>:<port>/crx/de
)./apps
aus und klicken Sie auf Erstellen > Knoten erstellen.cq:ClientLibraryFolder
aus. Klicken Sie auf OK und dann auf Alle speichern.cq:ClientLibraryFolder
-Knoten aus, fügen Sie die folgende Eigenschaft hinzu und klicken Sie auf Alle speichern:
categories
/etc.clientlibs
zugreifen zu können, wählen Sie den cq:ClientLibraryFolder
-Knoten aus, fügen Sie die folgende Eigenschaft hinzu und klicken Sie dann auf Alle speichern:
allowProxy
true
resources
unter dem Client-Bibliotheksordner.
resources
, können sie nicht in einer Veröffentlichungsinstanz referenziert werden.js.txt
: Verwenden Sie diesen Dateinamen, um eine JavaScript-Datei zu erzeugen.css.txt
: Verwenden Sie diesen Dateinamen, um ein Cascading Style Sheet zu erzeugen.#base=*[root]*
[root]
durch den Pfad zum Ordner, der die Quelldateien enthält, relativ zur TXT-Datei. Verwenden Sie beispielsweise den folgenden Text, wenn sich die Quelldateien im selben Ordner wie die TXT-Datei befinden:
#base=.
cq:ClientLibraryFolder
-Knoten als Stammverzeichnis fest:
#base=mobile
#base=[root]
die Pfade der Quelldateien relativ zum Stammverzeichnis ein. Geben Sie dabei jeden Dateinamen in einer separaten Zeile ein.Sobald Ihr Client-Bibliotheksordner wie erforderlich konfiguriert ist, können Ihre Client-seitige Bibliotheken über einen Proxy angefordert werden. Beispiel:
/apps/myproject/clientlibs/foo
./apps/myprojects/clientlibs/foo/resources/icon.png
.Die allowProxy
-Eigenschaft können Sie Folgendes anfordern:
/etc.clientlibs/myprojects/clientlibs/foo.js
/etc.clientlibs/myprojects/clientlibs/foo/resources/icon.png
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.
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.
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.
AEM bietet eine Vielzahl von Tools zum Debuggen und Testen von Client-Bibliotheksordnern an.
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
Zu den Informationen gehören der Bibliothekspfad und -typ (CSS oder JS) sowie die Werte der Bibliotheksattribute, wie z. B. Kategorien und Abhängigkeiten. Nachfolgende Tabellen auf der Seite zeigen die Bibliotheken in jeder Kategorie und jedem Kanal.
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.
dumplibs.html
auf den Link im Text Hier klicken für Ausgabetest.http://<host>:<port>/libs/granite/ui/content/dumplibs.html
categories
-Eigenschaft der Client-Bibliothek ein und klicken Sie auf Abfrage senden.Es gibt mehrere weitere Funktionen, die von Client-Bibliotheksordnern in AEM unterstützt werden. Diese sind jedoch nicht für AEM as a Cloud Service erforderlich und werden daher nicht empfohlen. Sie werden hier der Vollständigkeit halber aufgelistet.
Diese zusätzlichen Funktionen für Client-Bibliotheksordner sind jedoch für AEM as a Cloud Service nicht erforderlich und werden daher nicht empfohlen. Sie werden hier der Vollständigkeit halber aufgelistet.
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.
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:
dependencies
: Eine Liste anderer Client-Bibliothekskategorien, von denen dieser Bibliotheksordner abhängt. Beispiel: Wenn bei zwei cq:ClientLibraryFolder
-Knoten F
und G
eine Datei in F
eine andere Datei in G
benötigt, muss mindestens eine der categories
von G
in den dependencies
von F
aufgeführt sein, um eine ordnungsgemäße Funktionsweise sicherzustellen.embed
: Wird zum Einbetten von Code aus anderen Bibliotheken verwendet. Wenn der Knoten F
die Knoten G
und H
einbettet, enthält die resultierende HTML-Ausgabe Inhalte aus den Knoten G
und H
.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">
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.
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 /apps
verweigern. 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:
cq:ClientLibraryFolder
-Knotens, der eingebettet werden soll.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.
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%;
}
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");
?debugClientLibs=true
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.:
Standardmäßig verwendet AEM den YUI Compressor. In der GitHub-Dokumentation zum YUI Compressor finden Sie eine Liste bekannter Probleme. Ein Wechsel zum GCC Compressor für bestimmte Client-Bibliotheken kann einige Probleme beheben, die mit YUI auftreten.
Platzieren Sie eine minimierte Bibliothek nicht in einer Client-Bibliothek. Stellen Sie stattdessen die Rohbibliothek bereit. Wenn eine Minimierung erforderlich ist, können Sie die Möglichkeiten der Präprozessoren verwenden.
Sie können die Präprozessorkonfiguration pro Client-Bibliothek oder systemweit festlegen.
cssProcessor
und jsProcessor
zum Client-Bibliotheksknoten hinzu.Eine Präprozessor-Konfiguration im clientlib-Knoten hat Vorrang vor der OSGi-Konfiguration.
config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;
cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]
jsProcessor: [
"default:typescript",
"min:typescript",
"min:gcc;obfuscate=true"
]
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 unter GCC-Dokumentation.
YUI ist in AEM der Standardminimierer. Um stattdessen GCC festzulegen, führen Sie die folgenden Schritte aus.
http://<host>:<portY/system/console/configMgr
auf.min:gcc
.
min:gcc;obfuscate=true
.