Hier sehen Sie, welche Navigationen nicht über den Back/Forward-Cache ausgeführt werden konnten und warum.
Die Property notRestoredReasons, die der Klasse PerformanceNavigationTiming hinzugefügt wurde, gibt Informationen darüber, ob Frames im Dokument bei der Navigation daran gehindert wurden, den bfcache zu verwenden, und warum. Entwickler können diese Informationen verwenden, um Seiten zu identifizieren, die aktualisiert werden müssen, um sie bfcache-kompatibel zu machen und so die Websiteleistung zu verbessern.
Aktueller Status
Die notRestoredReasons API ist ab Chrome 123 verfügbar und wird nach und nach eingeführt.
Konzepte und Nutzung
Moderne Browser bieten eine Optimierungsfunktion für die Navigation im Verlauf, den sogenannten Back-Forward-Cache (bfcache). Dadurch wird die Seite sofort geladen, wenn Nutzer zu einer bereits besuchten Seite zurückkehren. Seiten können aus verschiedenen Gründen nicht in den bfcache aufgenommen oder aus dem bfcache entfernt werden. Einige Gründe sind durch eine Spezifikation vorgegeben, andere sind spezifisch für Browserimplementierungen.
Bisher gab es für Entwickler keine Möglichkeit, herauszufinden, warum ihre Seiten im Feld nicht den Back/Forward Cache verwenden konnten, obwohl es einen Test in den Chrome-Entwicklertools gab. Um das Monitoring im Feld zu ermöglichen, wurde die Klasse PerformanceNavigationTiming um die Property notRestoredReasons erweitert. Dadurch wird ein Objekt mit zugehörigen Informationen zum obersten Frame und allen im Dokument vorhandenen iFrames zurückgegeben:
- Gründe, warum sie nicht im Back-Forward-Cache gespeichert werden konnten.
Details wie Frame
idundname, um iFrames im HTML-Code zu identifizieren.So können Entwickler Maßnahmen ergreifen, um diese Seiten bfcache-kompatibel zu machen und so die Websiteleistung zu verbessern.
Beispiele
Eine PerformanceNavigationTiming-Instanz kann über Funktionen wie Performance.getEntriesByType() und PerformanceObserver abgerufen werden.
Sie können beispielsweise die folgende Funktion aufrufen, um alle PerformanceNavigationTiming-Objekte in der Leistungszeitachse zurückzugeben und ihre notRestoredReasons zu protokollieren:
function returnNRR() {
const navEntries = performance.getEntriesByType("navigation");
for (let< i = 0; i navEntries.length; i++) {
console.log(`Navigation entry ${i}`);
let navEntry = navEntries[i];
console.log(navEntry.notRestoredReasons);
}
}
Bei der Navigation im Verlauf gibt das Attribut PerformanceNavigationTiming.notRestoredReasons ein Objekt mit der folgenden Struktur zurück, die den blockierten Status des Frames auf oberster Ebene darstellt:
{
children: [],
id: null,
name: null,
reasons: [
{"reason", "unload-listener"}
],
src: null,
url: "https://www.example.com/page/"
}
Die Properties sind:
children- Ein Array von Objekten, die den Blockierungsstatus aller Frames mit demselben Ursprung darstellen, die im Frame der obersten Ebene eingebettet sind. Jedes Objekt hat dieselbe Struktur wie das übergeordnete Objekt. So kann eine beliebige Anzahl von Ebenen eingebetteter Frames rekursiv im Objekt dargestellt werden. Wenn der Frame keine untergeordneten Elemente hat, ist das Array leer.
id- Ein String, der den Attributwert
iddes Frames darstellt (z. B.<iframe id="foo" src="...">). Wenn der Frame keinidhat, ist der Wertnull. Für die Seite der obersten Ebene ist diesnull. name- Ein String, der den Attributwert
namedes Frames darstellt (z. B.<iframe name="bar" src="...">). Wenn der Frame keinennamehat, ist der Wert ein leerer String. Für die Seite der obersten Ebene ist diesnull. reasons- Ein Array von Strings, die jeweils einen Grund dafür darstellen, warum die aufgerufene Seite nicht den bfcache verwenden konnte. Es gibt viele verschiedene Gründe, warum eine Blockierung auftreten kann. Weitere Informationen finden Sie im Abschnitt Gründe für die Blockierung.
src- Ein String, der den Pfad zur Quelle des Frames darstellt (z. B.
<iframe src="b.html">). Wenn der Frame keinsrchat, ist der Wert ein leerer String. Für die Seite der obersten Ebene ist diesnull. url- Ein String, der die URL der aufgerufenen Seite oder des aufgerufenen iFrames darstellt.
Bei PerformanceNavigationTiming-Objekten, die keine Verlaufsnavigationen darstellen, gibt das Attribut notRestoredReasons den Wert null zurück.
Beachten Sie, dass notRestoredReasons auch null zurückgibt, wenn es keine Gründe für eine Blockierung gibt. Wenn dieser Wert null ist, ist das also kein Indikator dafür, ob der bfcache verwendet wurde oder nicht. Dazu müssen Sie die Property event.persisted verwenden.
bfcache-Blockierung in Same-Origin-Frames melden
Wenn auf einer Seite Frames mit derselben Herkunft eingebettet sind, enthält der zurückgegebene notRestoredReasons-Wert ein Objekt innerhalb des Attributs children, das den blockierten Status jedes eingebetteten Frames darstellt.
Beispiel:
{
children: [
{
children: [],
id: "iframe-id",
name: "iframe-name",
reasons: [],
src: "./index.html",
url: "https://www.example.com/"
},
{
children: [],
id: "iframe-id2",
name: "iframe-name2",
reasons: [
{"reason": "unload-listener"}
],
src: "./unload-examples.html",
url: "https://www.example.com/unload-examples.html"
},
],
id: null,
name: null,
reasons: [],
src: null,
url:"https://www.example.com"
}
bfcache-Blockierung in ursprungsübergreifenden Frames melden
Wenn auf einer Seite ursprungsübergreifende Frames eingebettet sind, beschränken wir die Menge der Informationen, die über sie weitergegeben werden, um zu verhindern, dass ursprungsübergreifende Informationen preisgegeben werden. Wir fügen nur Informationen hinzu, die der äußeren Seite bereits bekannt sind, und ob der ursprungsübergreifende Unterbaum den bfcache blockiert hat oder nicht. Wir geben keine Blockierungsgründe oder Informationen zu niedrigeren Ebenen des Unterbaums an (auch wenn einige Unterebenen denselben Ursprung haben).
Beispiel:
{
children: [
{
children: [],
id: "iframe-id",
name: "iframe-name",
reasons: [],
src: "./index.html",
url: "https://www.example2.com/"
}
],
id: null,
name: null,
reasons: [
{"reason": "masked"}
],
src: null,
url:"https://www.example.com"
}
Für alle ursprungsübergreifenden iFrames wird null für den Wert reasons des Frames gemeldet. Für den Frame auf oberster Ebene wird der Grund "masked" angezeigt. Beachten Sie, dass "masked" auch aus User-Agent-spezifischen Gründen verwendet werden kann und daher nicht immer auf ein Problem in einem iFrame hinweist.
Weitere Informationen zu Sicherheits- und Datenschutzaspekten finden Sie im Abschnitt Sicherheit und Datenschutz in der Erläuterung.
Gründe für die Blockierung
Wie bereits erwähnt, gibt es viele verschiedene Gründe, warum eine Blockierung auftreten kann:
Im Folgenden finden Sie einige der häufigsten Gründe, warum der bfcache nicht verwendet werden kann:
unload-listener: Auf der Seite wird einunload-Handler registriert, der die Verwendung des bfcache in bestimmten Browsern verhindert. Beachten Sie, dass Chrome diesen Grund ab Chrome 155 nicht mehr ausgibt, es sei denn, Websites haben sich wieder fürunload-Ereignisse entschieden. Weitere Informationen finden Sie unter Deprecating the unload event.response-cache-control-no-store: Auf der Seite wirdno-storealscache-control-Wert verwendet.related-active-contents: Die Seite wurde von einer anderen Seite aus geöffnet (entweder über „Tab duplizieren“), die noch einen Verweis auf diese Seite enthält.
Feedback
Das Chromium-Team möchte gern mehr über Ihre Erfahrungen mit der bfcache-API (notRestoredReasons) erfahren.
Erzählen Sie uns etwas über das API-Design.
Gibt es etwas an der API, das nicht wie erwartet funktioniert? Oder fehlen Methoden oder Properties, die Sie für die Umsetzung Ihrer Idee benötigen? Haben Sie eine Frage oder einen Kommentar zum Sicherheitsmodell? Melde ein Problem mit der Spezifikation im entsprechenden GitHub-Repository oder füge deine Gedanken zu einem bestehenden Problem hinzu.
Problem mit der Implementierung melden
Haben Sie einen Fehler in der Chromium-Implementierung gefunden? Oder unterscheidet sich die Implementierung von der Spezifikation?
Melden Sie einen Fehler in unserem Issue Tracker. Geben Sie so viele Details wie möglich an, einschließlich einer Anleitung zum Reproduzieren, und geben Sie die Komponente als UI > Browser > Navigation > BFCache an.
Unterstützung für die API zeigen
Planen Sie, die bfcache-API notRestoredReasons zu verwenden? Ihre öffentliche Unterstützung hilft dem Chromium-Team, Funktionen zu priorisieren, und zeigt anderen Browseranbietern, wie wichtig es ist, sie zu unterstützen.
Sende einen Tweet an @ChromiumDev mit dem Hashtag #NotRestoredReasons und teile uns mit, wo und wie du die Funktion verwendest.