Service-Worker-Allowed

Der HTTP-Service-Worker-Allowed-Antwortheader wird verwendet, um die Pfadeinschränkung für den Standard-scope eines Service Workers zu erweitern.

Standardmäßig ist der scope für eine Service-Worker-Registrierung das Verzeichnis, in dem das Service-Worker-Skript abgelegt ist. Beispielsweise kann ein Skript sw.js, das unter /js/sw.js liegt, nur standardmäßig URLs unter /js/ kontrollieren. Server können den Service-Worker-Allowed-Header verwenden, um einem Service Worker zu erlauben, URLs außerhalb seines eigenen Verzeichnisses zu kontrollieren.

Ein Service Worker fängt alle Netzwerk-Anfragen innerhalb seines Geltungsbereichs ab, daher sollten Sie vermeiden, unnötig breite Geltungsbereiche zu verwenden, es sei denn, es ist notwendig.

Header-Typ Antwortheader
Verbotener Header-Name Nein

Syntax

http
Service-Worker-Allowed: <scope>

Direktiven

<scope>

Ein String, der eine URL darstellt, die den Registrierungsbereich eines Service Workers definiert; das heißt, welcher URL-Bereich von einem Service Worker kontrolliert werden kann.

Beispiele

Verwendung von Service-Worker-Allowed zur Erweiterung des Service-Worker-Geltungsbereichs

Das untenstehende JavaScript-Beispiel ist in example.com/product/index.html enthalten und versucht, einen Service Worker mit einem Geltungsbereich zu registrieren, der auf alle Ressourcen unter example.com/ zutrifft.

js
navigator.serviceWorker.register("./sw.js", { scope: "/" }).then(
  (registration) => {
    console.log("Install succeeded, scoped to '/'", registration);
  },
  (error) => {
    console.error(`Service worker registration failed: ${error}`);
  },
);

Die HTTP-Antwort auf die Skriptressourcenanfrage des Service Workers (./sw.js) enthält den Service-Worker-Allowed-Header, der auf / gesetzt ist:

http
HTTP/1.1 200 OK
Date: Mon, 16 Dec 2024 14:37:20 GMT
Service-Worker-Allowed: /

// sw.js contents…

Wenn der Server den Header nicht setzt, wird die Registrierung des Service Workers fehlschlagen, da die scope-Option ({ scope: "/" }) einen breiteren Geltungsbereich anfordert als das Verzeichnis, in dem sich das Service-Worker-Skript befindet (/product/sw.js).

Spezifikationen

Specification
Service Workers
# service-worker-allowed

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch