AMP

Wandle deine AMP Website in eine PWA um

Important: this documentation is not applicable to your currently selected format stories!

Progressive Web Apps nutzen die Leistung von Service Workern, um über verschiedene Netzwerkstärken hinweg umfassende Offlinefunktionen und konsistente Benutzererfahrungen zu ermöglichen. Durch das Zwischenspeichern von Ressourcen im Browser kann eine PWA den Benutzern Daten, Assets und Offlineseiten bereitstellen, um sie zu unterhalten und zu informieren.

In diesem Tutorial erfährst du, wie du eine AMP Website in eine installierbare PWA mit Offlinefunktionen verwandelst, indem du ein Webmanifest und einen vom AMP Service Worker unterstützten Service Worker hinzufügst.

Lade den Startercode herunter und führe ihn aus

Lade hier den Startercode herunter.

Verwende einen lokalen Webserver, um eine Vorschau der Website anzuzeigen.

TIPP: Um schnell einen Webserver zu erstellen, führe einfach python -m SimpleHTTPServer aus.

You should be able to view the landing page for Lyrical Lyghtning, the Mobile Music Magic festival. It has one link on the homepage to view the schedule and which stage the bands are on.

Bild der PWA

Benutzer unserer Website könnten beim Event eine schlechte Netzwerkverbindung haben, gerade wenn sie auf das Festivalprogramm zugreifen wollen. Es bietet sich an, eine PWA daraus zu machen, die auf dem Startbildschirm unserer Benutzer installiert werden kann und auch offline alle kritischen Funktionen bietet.

Erstelle ein Web App Manifest

Das Web App Manifest ist eine einfache JSON Datei, die dem Browser Informationen zu deiner Webanwendung und deren Verhalten liefert, wenn sie auf dem mobilen Gerät oder Desktop der Benutzer 'installiert' wird. Viele Browser benötigen ein Manifest, um die Eingabeaufforderung 'Zum Startbildschirm hinzufügen' anzeigen zu können.

Füge deinem Repository eine Datei mit dem Titel manifest.json hinzu. Verwende dazu den folgenden Code:

{
"short_name": "LyLy",
"name": "Lyrical Lyghtning",
"icons": [
{
"src": "./images/amplogo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "./images/amplogo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": "/index.html",
"background_color": "#222325",
"display": "standalone",
"scope": "/",
"theme_color": "#222325"
}

Füge den AMP Service Worker hinzu

Ein Service Worker ist ein Skript, das dein Browser – unabhängig von einer Webseite – im Hintergrund ausführt und das die Browserfunktionen erweitert. Auf diese Weise werden Anfragen zwischengespeichert, um die Leistung zu verbessern und Offlinefunktionen bereitzustellen. Die Neuentwicklung eines Service Workers ist möglich, aber zeitaufwendig. Bibliotheken wie z. B. Workbox sind hilfreich, aber AMP geht mit dem AMP Service Worker noch einen Schritt weiter: Viele Schritte werden automatisiert, einschließlich der Zwischenspeicherung von AMP Skripten, Assets und Dokumenten sowie der Implementierung gängiger Best Practices wie dem Vorladen der Navigation.

Der AMP Service Worker führt nach seiner Installation automatisch die Zwischenspeicherung von AMP Skripten und Dokumenten durch, sobald Benutzer diese anfordern. Wir beginnen mit dem Hinzufügen des grundlegenden AMP Service Workers.

Erstelle die Service Worker Datei

Erstelle eine Datei mit dem Namen sw.js und füge den folgenden Code hinzu:

importScripts('https://cdn.ampproject.org/sw/amp-sw.js');
AMP_SW.init();

Mit nur zwei Codezeilen wird der AMP Service Worker in deinen Service Worker importiert und initialisiert.

Installiere deinen Service Worker automatisch auf deinen AMP Seiten

AMP Websites verwenden die Komponente <amp-install-serviceworker>, um den Service Worker im Hintergrund des Browsers zu installieren, während der Benutzer deine Inhalte genießt.

Platziere das erforderliche Tag "script" im Head von index.html und das Element <amp-install-serviceworker> im <body>:

<script async custom-element="amp-install-serviceworker" src="https://cdn.ampproject.org/v0/amp-install-serviceworker-0.1.js"></script>

…
...
<amp-install-serviceworker src="/sw.js"
           data-iframe-src="install-sw.html"
           layout="nodisplay">
</amp-install-serviceworker>

</body>

Wichtig: Der Service Worker sollte aus dem Stammverzeichnis (/sw.js) bereitgestellt werden, damit der gesamte Inhalt deiner Website zwischengespeichert werden kann.

Der <amp-install-serviceworker> installiert den Service Worker, indem er ein iframe erstellt und die Datei data-iframe-src ausführt. Erstelle die Datei install-sw.html und füge den folgenden Code hinzu:

<!doctype html>
<title>installing service worker</title>
<script type='text/javascript'>
 if('serviceWorker' in navigator) {
   navigator.serviceWorker.register('./sw.js');
 };
</script>

Das iframe registriert die AMP Service Worker Datei im Browser.

Passe an, was zwischengespeichert wird

Der AMP Service Worker bietet bereits integrierte Funktionen und ermöglicht darüber hinaus optionale Felder, die du konfigurieren kannst, um sie an die Anforderungen deiner App anzupassen.

Unsere Musikfestival App führt die Zwischenspeicherung unserer Bildressourcen durch, ruft den Veranstaltungslink vorher ab und gibt eine Offlineseite an.

Zwischenspeichern von Assets

Du kannst den AMP Service Worker so konfigurieren, dass Assets zwischengespeichert werden, z. B. Bilder, Videos und Schriftarten. Wir verwenden ihn, um unser Hintergrundbild und das AMP Logo zwischenzuspeichern. Öffne die Datei sw.js und aktualisiere sie mit dem folgenden Code:

importScripts('https://cdn.ampproject.org/sw/amp-sw.js');
AMP_SW.init({
assetCachingOptions: [{
regexp: /\.(png|jpg)/,
cachingStrategy: 'CACHE_FIRST'
}]
});

Als Cachingstrategie haben wir Cache first festgelegt. Das bedeutet, dass die App zuerst versucht, Bilder aus dem Cache bereitzustellen, bevor sie etwas aus dem Netzwerk anfordert. Das ist für diese App besonders nützlich, da wir unser Hintergrundbild oder das AMP Logo nicht aktualisieren.

Der AMP Service Worker ruft vorab Links mit dem Attribut data-rel=prefetch ab. Dadurch können Benutzer Seiten offline anzeigen, auch wenn sie sie noch nicht besucht haben. Wir fügen das Attribut zu unserem Linktag für lineup.html hinzu.

...
<a href="/lineup.html" data-rel="prefetch">See Full Lineup</a>
...

Zeige eine Offlineseite an

Um auf unerwartete Fälle oder Linkklicks zu Seiten zu reagieren, die wir nicht vorab abgerufen haben, fügen wir eine Offlineseite hinzu, um eine konsistente, "markentreue" Benutzererfahrung zu bieten, anstatt die standardmäßige Offlineseite des Browsers anzuzeigen. Lade offline.html hier herunter und aktualisiere sw.js mit dem folgenden Code:

importScripts('https://cdn.ampproject.org/sw/amp-sw.js');
AMP_SW.init({
assetCachingOptions: [{
regexp: /\.(png|jpg)/,
cachingStrategy: 'CACHE_FIRST'
}],
offlinePageOptions: {
url: '/offline.html',
assets: []
}
});

Teste deine PWA

Mit Chrome DevTools kannst du testen, ob dein AMP Service Worker die erforderlichen Assets zwischenspeichert und eine ideale Offlinelösung bereitstellt.

Wir testen Lyrical Lyghtning, indem wir das Bedienfeld des DevTools öffnen: unter Windows mit Strg + Umschalt + I oder unter Mac mit Cmd + Opt + I. Du kannst auch mit der rechten Maustaste auf die Seite klicken und den Menüpunkt Untersuchen auswählen. Wähle dann Application, um die Registrierung deines Service Workers anzuzeigen.

Aktiviere das Kontrollkästchen offline, um in den Offlinemodus zu wechseln. Klicke auf den Link see full lineup und navigiere zu offline.html, um zu überprüfen, ob die Assets ordnungsgemäß zwischengespeichert und vorabgerufen wurden.

Tipp: Führe das Google Lighthouse Tool aus, um die Funktionen einer Progressive Web App gründlich zu analysieren und einen Bericht zu erhalten.

Gratulation!

Du hast erfolgreich eine PWA mit AMP erstellt! In diesem Tutorial hast du gelernt,

Lies mehr über Service Worker und Überlegungen zu Offline UX. Erfahre, wie du das Engagement mittels Analytics verfolgen kannst. Sieh dir das Tutorial an, das zeigt, wie du fundamentale Analyseprozesse für deine AMP Seiten konfigurieren kannst.