Verwenden Client-seitiger Bibliotheken

Letzte Aktualisierung: 2023-11-15
  • Themen:
  • Developing
    Weitere Informationen zu diesem Thema
  • Erstellt für:
  • Developer

Moderne Websites beruhen in hohem Maße auf der Client-seitigen Verarbeitung durch einen komplexen JavaScript- und CSS-Code. Die Organisation und Optimierung der Bereitstellung dieses Codes kann äußerst kompliziert sein.

Um dieses Problem zu beheben, bietet AEM Clientseitige Bibliotheksordner, mit dem Sie Ihren clientseitigen Code im Repository speichern, ihn in Kategorien organisieren und definieren können, wann und wie jede Codekategorie dem Client bereitgestellt werden soll. Das Client-seitige Bibliothekssystem übernimmt dann das Erstellen der korrekten Links in der endgültigen Web-Seite, um den korrekten Code zu laden.

Funktionsweise Client-seitiger Bibliotheken in AEM

Client-seitige Bibliotheken (also JS- oder CSS-Dateien) werden meist in den HTML-Code einer Seite integriert, indem ein <script>- oder <link>-Tag in die JSP der Seite eingefügt wird, die den Pfad zur Datei enthält. Beispiel:

...
<head>
   ...
   <script type="text/javascript" src="/etc/clientlibs/granite/jquery/source/1.8.1/jquery-1.8.1.js"></script>
   ...
</head>
...

Dieser Ansatz funktioniert zwar in AEM, kann aber zu Problemen führen, wenn Seiten und ihre Komponenten komplex werden. In solchen Fällen besteht die Gefahr, dass mehrere Kopien derselben JS-Bibliothek in die endgültige HTML-Ausgabe aufgenommen werden. Um dies zu vermeiden und einen logischen Aufbau Client-seitiger Bibliotheken zu ermöglichen, verwendet AEM Client-seitige Bibliotheksordner.

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

Standardmäßig können cq:ClientLibraryFolder-Knoten überall in den Unterbaumstrukturen /apps, /libs und /etc des Repositorys platziert werden (Sie können diese Standardeinstellungen sowie andere Einstellungen im Bedienfeld Adobe Granite HTML Library Manager der Systemkonsole ändern).

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

  • 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).

  • 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.

  • allowProxy: Wenn eine Client-Bibliothek unter /apps abgelegt ist, ermöglicht diese Eigenschaft den Zugriff darauf durch ein Proxy-Servlet. Siehe Finden eines Client-Bibliotheksordners und Verwenden des Proxy-Servlets für Client-Bibliotheken weiter unten.

Referenzieren von Client-seitigen Bibliotheken

Da HTL die bevorzugte Technologie zur Entwicklung von AEM Sites ist, sollte HTL verwendet werden, um Client-seitige Bibliotheken in AEM einzuschließen. Dies ist jedoch auch mit JSP möglich.

Verwenden von HTL

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

  • css – Lädt nur die CSS-Dateien der referenzierten Client-Bibliotheken.
  • js – Lädt nur die JavaScript-Dateien der referenzierten Client-Bibliotheken.
  • all – Lädt alle Dateien der referenzierten Client-Bibliotheken (CSS und JavaScript).

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 und Nutzungsbeispiele finden Sie im Dokument Erste Schritte mit der HTML-Vorlagensprache.

Verwenden von JSP

Fügen Sie Ihrem JSP-Code ein ui:includeClientLib-Tag hinzu, um der generierten HTML-Seite einen Link zu Client-Bibliotheken hinzuzufügen. Nutzen Sie den Wert der categories-Eigenschaft des ui:includeClientLib-Knotens, um die Bibliotheken zu referenzieren.

<%@taglib prefix="ui" uri="https://www.adobe.com/taglibs/granite/ui/1.0" %>
<ui:includeClientLib categories="<%= categories %>" />

Beispiel: Der /etc/clientlibs/foundation/jquery-Knoten hat den Typ cq:ClientLibraryFolder mit dem Wert cq.jquery für die Eigenschaft „categories“. Der folgende Code in einer JSP-Datei verweist auf die Bibliotheken:

<ui:includeClientLib categories="cq.jquery"/>

Die generierte HTML-Seite enthält den folgenden Code:

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

Vollständige Informationen, einschließlich der Attribute zum Filtern von JS-, CSS- oder Designbibliotheken, finden Sie unter ui:includeClientLib.

VORSICHT

<cq:includeClientLib> wurde früher häufig zum Einschließen von Client-Bibliotheken verwendet, wird aber seit AEM 5.6 nicht mehr unterstützt. <ui:includeClientLib> sollte stattdessen wie oben beschrieben verwendet werden.

Erstellen von Client-Bibliotheksordnern

Erstellen Sie einen cq:ClientLibraryFolder-Knoten, um JavaScript- und CSS-Bibliotheken zu definieren und HTML-Seiten zur Verfügung zu stellen. Verwenden Sie die categories-Eigenschaft des Knotens, um festzulegen, zu welchen Bibliothekskategorien er gehört.

Der Knoten enthält eine oder mehrere Quelldateien, die zur Laufzeit zu einer einzelnen JS- und/oder CSS-Datei zusammengeführt werden. 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:

  • Die JS- und/oder CSS-Quelldateien zum Zusammenführen.

  • Ressourcen, die CSS-Styles unterstützen, z. B. Bilddateien.

    Hinweis: Sie können Quelldateien mit Unterordnern organisieren.

  • Eine js.txt- und/oder css.txt-Datei, die die Quelldateien angibt, die in die generierten JS- und/oder CSS Dateien zusammengeführt werden sollen.

clientlibarch

Weitere Informationen zu Anforderungen speziell für Client-Bibliotheken für Widgets finden Sie unter Verwenden und Erweitern von Widgets.

Der Webclient benötigt eine Zugriffsberechtigung für den Knoten cq:ClientLibraryFolder. Sie können auch Bibliotheken aus gesicherten Bereichen des Repositorys verfügbar machen (siehe Einbetten von Code aus anderen Bibliotheken weiter unten).

Überschreiben von Bibliotheken in /lib

Unten befindliche Client-Bibliotheksordner /apps Vorrang vor Ordnern mit demselben Namen haben, die sich in /libs. Beispiel: /apps/cq/ui/widgets hat Vorrang vor /libs/cq/ui/widgets. Wenn diese Bibliotheken derselben Kategorie angehören, wird die Bibliothek unter /apps verwendet.

Finden eines Client-Bibliotheksordners und Verwenden des Proxy-Servlets für Client-Bibliotheken

In früheren Versionen befanden sich Client-Bibliotheksordner unter /etc/clientlibs im Repository. Dies wird weiterhin unterstützt, aber wir empfehlen, die Client-Bibliotheken jetzt unter /apps zu platzieren. So befinden sich die Client-Bibliotheken nahe der anderen Skripte, die in der Regel unter /apps und /libs zu finden sind.

HINWEIS

Statische Ressourcen unter dem Client-Bibliotheksordner müssen sich im Ordner resources befinden. Wenn sich die statischen Ressourcen, z. B. Bilder, nicht im Ordner resources befinden, können sie nicht auf einer Veröffentlichungsinstanz referenziert werden. Im Folgenden finden Sie ein Beispiel: https://localhost:4503/etc.clientlibs/geometrixx/components/clientlibs/resources/example.gif

HINWEIS

Um Code besser von Inhalt und Konfiguration zu isolieren, wird empfohlen, Client-Bibliotheken unter /apps und stellen sie über /etc.clientlibs durch Verwendung von allowProxy -Eigenschaft.

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.

Der Zugriff auf eine statische Ressource ist nur über den Proxy möglich, wenn sie sich unter einer Ressource unter dem Client-Bibliotheksordner befindet.

Beispiel:

  • Sie verfügen über eine Client-seitige Bibliothek unter /apps/myproject/clientlibs/foo.
  • Sie verfügen über ein statisches Bild unter /apps/myprojects/clientlibs/foo/resources/icon.png.

Sie legen die Eigenschaft allowProxy für foo auf „true“ fest.

  • Anschließend können Sie /etc.clientlibs/myprojects/clientlibs/foo.js abfragen.
  • Sie können außerdem das Bild über /etc.clientlibs/myprojects/clientlibs/foo/resources/icon.png referenzieren.
VORSICHT

Wenn Sie Client-Bibliotheken über Proxys verwenden, benötigt die AEM-Dispatcher-Konfiguration möglicherweise ein Update, damit URIs mit der Erweiterung „clientlibs“ zulässig sind.

VORSICHT

Adobe empfiehlt, Client-Bibliotheken unter /apps zu platzieren und mit dem Proxy-Servlet freizugeben. Beachten Sie jedoch, dass gemäß der Best Practice öffentliche Websites keine Inhalte enthalten sollten, die direkt über einen /apps- oder /libs-Pfad bereitgestellt werden.

Erstellen eines Client-Bibliotheksordners

  1. Öffnen Sie CRXDE Lite in einem Webbrowser (https://localhost:4502/crx/de).

  2. Wählen Sie den Ordner aus, in dem Sie den Client-Bibliotheksordner platzieren möchten, und klicken Sie auf Erstellen > Knoten erstellen.

  3. Geben Sie einen Namen für die Bibliotheksdatei ein und wählen Sie in der Typenliste cq:ClientLibraryFolder aus. Klicken Sie auf OK und dann auf Alle speichern.

  4. Um die Kategorien festzulegen, zu denen die Bibliothek gehört, wählen Sie den cq:ClientLibraryFolder-Knoten aus, fügen Sie die folgende Eigenschaft hinzu und klicken Sie auf Alle speichern:

    • Name: categories
    • Typ: String
    • Wert: Der Kategoriename
    • Multi: Auswählen

  5. Fügen Sie auf beliebige Weise Quelldateien zum Bibliotheksordner hinzu. Verwenden Sie beispielsweise einen WebDav-Client, um Dateien zu kopieren, oder erstellen Sie eine Datei und erstellen Sie den Inhalt manuell.

    Hinweis: Sie können Quelldateien bei Bedarf in Unterordnern organisieren.

  6. Wählen Sie den Client-Bibliotheksordner aus und klicken Sie auf Erstellen > Datei erstellen.

  7. Geben Sie in das Dateinamenfeld einen der folgenden Dateinamen ein und klicken Sie auf „OK“:

    • 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.

  8. Öffnen Sie die Datei und geben Sie den folgenden Text ein, um das Stammverzeichnis des Pfads der Quelldateien anzugeben:

    #base=*[root]*

    Ersetzen Sie [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=.

    Der folgende Code legt den Ordner „mobile“ unter dem cq:ClientLibraryFolder-Knoten als Stammverzeichnis fest:

    #base=mobile

  9. Geben Sie in den Zeilen unter #base=[root] die Pfade der Quelldateien relativ zum Stammverzeichnis ein. Geben Sie dabei jeden Dateinamen in einer separaten Zeile ein.

  10. Klicken Sie auf Alle speichern.

Verknüpfen mit Abhängigkeiten

Wenn der Code in Ihrem Client-Bibliotheksordner auf andere Bibliotheken verweist, müssen Sie die anderen Bibliotheken als Abhängigkeiten angeben. In der JSP wird die ui:includeClientLib -Tag, das auf Ihren Client-Bibliotheksordner verweist, führt dazu, dass der HTML-Code einen Link zu Ihrer generierten Bibliotheksdatei und den Abhängigkeiten enthält.

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:

  • Name: dependencies
  • Typ: String[]
  • Werte: Der Wert der categories-Eigenschaft des cq:ClientLibraryFolder-Knotens, von dem der aktuelle Bibliotheksordner abhängig ist.

Beispielsweise weist /etc/clientlibs/myclientlibs/publicmain eine Abhängigkeit von der cq.jquery-Bibliothek auf. Die JSP, die auf die Haupt-Client-Bibliothek verweist, generiert HTML, die 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

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

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 unterhalb von /apps und machen ihn über das Proxy-Servlet zugänglich, wie unter Finden eines Client-Bibliotheksordners und Verwendung des Proxy-Servlets für Client-Bibliotheken beschrieben.

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:

  • Name: embed
  • Typ: String[]
  • Wert: Der Wert der categories-Eigenschaft des cq:ClientLibraryFolder-Knotens, der eingebettet werden soll.

Minimieren von Anfragen durch Einbetten

In einigen Fällen enthält der endgültige HTML-Code, den Ihre Veröffentlichungsinstanz für eine typische Seite generiert, möglicherweise eine recht große Anzahl an <script>-Elementen, insbesondere dann, wenn Ihre Site Client-Kontextinformationen für Analyse oder Targeting verwendet. Beispiel: In einem nicht optimierten Projekt kann die folgende Reihe von <script>-Elementen im HTML-Code einer Seite vorkommen:

<script type="text/javascript" src="/etc/clientlibs/granite/jquery.js"></script>
<script type="text/javascript" src="/etc/clientlibs/granite/utils.js"></script>
<script type="text/javascript" src="/etc/clientlibs/granite/jquery/granite.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/jquery.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/shared.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/personalization/kernel.js"></script>

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.

Die folgenden Client-Bibliothekskategorien sind in AEM enthalten. Sie sollten nur diejenigen einbetten, die für die Funktionsweise Ihrer bestimmten Site erforderlich sind. Allerdings Sie sollten die hier aufgeführte Reihenfolge beibehalten:

  1. browsermap.standard
  2. browsermap
  3. jquery-ui
  4. cq.jquery.ui
  5. personalization
  6. personalization.core
  7. personalization.core.kernel
  8. personalization.clientcontext.kernel
  9. personalization.stores.kernel
  10. personalization.kernel
  11. personalization.clientcontext
  12. personalization.stores
  13. cq.collab.comments
  14. cq.collab.feedlink
  15. cq.collab.ratings
  16. cq.collab.toggle
  17. cq.collab.forum
  18. cq.cleditor

Pfade in CSS-Dateien

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:

screen_shot_2012-05-29at20122pm

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%;
}

Verwenden einer Bibliothek für bestimmte Mobile-Gruppen

Verwenden Sie die Eigenschaft channels eines Client-Bibliotheksordners, um die Mobile-Gruppe zu identifizieren, die die Bibliothek verwendet. Die Eigenschaft channels ist hilfreich, wenn Bibliotheken derselben Kategorie für verschiedene Geräte entwickelt wurden.

Um einen Client-Bibliotheksordner mit einer Gerätegruppe zu verknüpfen, fügen Sie Ihrem cq:ClientLibraryFolder-Knoten eine Eigenschaft mit den folgenden Attributen hinzu:

  • Name: channels
  • Typ: String[]
  • Werte: Der Name der Mobile-Gruppe. Um den Bibliotheksordner aus einer Gruppe auszuschließen, setzen Sie ein Ausrufezeichen („!“) vor den Namen.

Beispiel: Die folgende Tabelle listet den Wert der Eigenschaft channels für jeden Client-Bibliotheksordner der Kategorie cq.widgets auf:

Client-Bibliotheksordner Wert der Eigenschaft "channels"
/libs/cq/analytics/widgets !touch
/libs/cq/analytics/widgets/themes/default !touch
/libs/cq/cloudserviceconfigs/widgets !touch
/libs/cq/touch/widgets touch
/libs/cq/touch/widgets/themes/default touch
/libs/cq/ui/widgets !touch
/libs/cq/ui/widgets/themes/default !touch

Verwendung von Präprozessoren

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.:

  • Definition von ScriptProcessors, die Skriptquellen verarbeiten können
  • Prozessoren sind mit Optionen konfigurierbar
  • Prozessoren können zur Minimierung, aber auch für nicht minimierte Fälle verwendet werden
  • Die Client-Bibliothek kann den zu verwendenden Prozessor festlegen
HINWEIS

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.

VORSICHT

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.

Nutzung

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

  • Fügen Sie die multivalue-Eigenschaften cssProcessor und jsProcessor zum Client-Bibliotheksknoten hinzu.

  • Oder definieren Sie die standardmäßige Systemkonfiguration über die OSGi-Konfiguration im HTML Library Manager

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

Format und Beispiele

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

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

Typescript zur Vorverarbeitung und GCC zur Minimierung und Verschleierung

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

Weitere GCC-Optionen

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

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

  1. Rufen Sie Apache Felix Config Manager unter https://localhost:4502/system/console/configMgr auf.

  2. Suchen und bearbeiten Sie den Adobe Granite HTML Library Manager.

  3. Aktivieren Sie die Option Minimieren (wenn nicht bereits aktiviert).

  4. Setzen Sie den Wert JS-Prozessor-Standardkonfigurationen auf min:gcc.

    Optionen können übergeben werden, wenn sie durch Semikolons getrennt sind, z. B min:gcc;obfuscate=true.

  5. Klicken Sie auf Speichern, um die Änderungen zu speichern.

Debugging-Tools

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

Siehe Eingebettete Dateien

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");

  1. Hängen Sie in der Adressleiste Ihres Webbrowsers den folgenden Text an die URL Ihres HTML-Codes an:

    ?debugClientLibs=true

  2. Öffnen Sie den Seiten-Quell-Code, nachdem die Seite geladen wurde.

  3. Klicken Sie auf den Link, der als href für das Link-Element angegeben ist, um die Datei zu öffnen und den Quell-Code anzuzeigen.

Ermitteln der Client-Bibliotheken

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.

Anzeigen der generierten Ausgabe

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.

  1. Wählen Sie eine der folgenden Methoden, um die Testausgabeseite zu öffnen:

    • Klicken Sie auf der Seite dumplibs.html auf den Link im Text Hier klicken für Ausgabetest.

    • Öffnen Sie die folgende URL in Ihrem Webbrowser (verwenden Sie je nach Bedarf einen anderen Host und Port):

      • http://<host>:<port>/libs/granite/ui/content/dumplibs.html

    Die Standardseite zeigt die Ausgabe für Tags ohne Wert für das categories-Attribut.

  2. Um die Ausgabe einer Kategorie anzuzeigen, geben Sie den Wert der categories-Eigenschaft der Client-Bibliothek ein und klicken Sie auf Abfrage senden.

Konfigurieren des Umgangs mit Bibliotheken für Entwicklung und Produktion

Der HTML Library Manager-Service verarbeitet cq:ClientLibraryFolder-Tags und generiert die Bibliotheken zur Laufzeit. Der Umgebungs-, Entwicklungs- oder Produktionstyp bestimmt, wie der Dienst konfiguriert werden soll:

  • Sicherheit erhöhen: Debugging deaktivieren
  • Verbesserung der Leistung: Entfernen Sie Leerzeichen und komprimieren Sie Bibliotheken.
  • Lesbarkeit verbessern: Fügen Sie Leerzeichen ein und komprimieren Sie diese nicht.

Informationen zum Konfigurieren des Dienstes finden Sie unter HTML Library Manager AEM.

Vorherige Seite
Next page

Auf dieser Seite