background

Typ Object
Obligatorisch Nein
Manifest-Version 2 oder höher
Beispiel
json
"background": {
  "scripts": ["background.js"]
}

Verwenden Sie den background-Schlüssel, um ein oder mehrere Hintergrundskripte, eine Hintergrundseite oder einen Service-Worker in Ihre Erweiterung einzubinden.

Hintergrundskripte sind der Ort, an dem Code platziert werden sollte, der einen langfristigen Zustand aufrechterhalten muss oder langfristige Operationen unabhängig von der Lebensdauer bestimmter Webseiten oder Browser-Fenster ausführen muss.

Hintergrundskripte werden geladen, sobald die Erweiterung geladen wird, und bleiben geladen, bis die Erweiterung deaktiviert oder deinstalliert wird, es sei denn, persistent ist als false angegeben. Sie können beliebige WebExtension-APIs im Skript verwenden, wenn Sie die notwendigen Berechtigungen angefordert haben.

Siehe Hintergrundskripte für weitere Details.

Der background-Schlüssel ist ein Objekt, das eine dieser Eigenschaften haben muss (für weitere Informationen dazu, wie diese Eigenschaften unterstützt werden, siehe Browser-Unterstützung):

page

Wenn Sie spezifischen Inhalt in der Hintergrundseite benötigen, können Sie eine Seite mit der page-Eigenschaft definieren. Dies ist ein string, der einen Pfad relativ zur manifest.json-Datei zu einem HTML-Dokument darstellt, das in Ihrem Erweiterungsbundle enthalten ist.

Wenn Sie diese Eigenschaft verwenden, können Sie keine Hintergrundskripte mit scripts angeben, aber Sie können Skripte von der Seite einbinden, genau wie bei einer normalen Webseite.

scripts

Ein array von string, von denen jeder ein Pfad zu einer JavaScript-Quelle ist. Der Pfad ist relativ zur manifest.json-Datei selbst. Dies sind die Skripte, die im Hintergrundkontext der Erweiterung ausgeführt werden.

Die Skripte teilen den gleichen globalen Kontext window.

Die Skripte werden in der Reihenfolge geladen, in der sie im Array erscheinen.

Wenn Sie scripts angeben, wird eine leere Seite erstellt, auf der Ihre Skripte ausgeführt werden.

Hinweis: Wenn Sie ein Skript von einem entfernten Standort mit dem <script>-Tag (zum Beispiel <script src = "https://code.jquery.com/jquery-3.6.0.min.js">) abrufen möchten, müssen Sie den content_security_policy -Schlüssel in der manifest.json-Datei Ihrer Erweiterung ändern.

service_worker

Geben Sie eine JavaScript-Datei als Service-Worker der Erweiterung an. Ein Service-Worker ist ein Hintergrundskript, das als Hauptereignis-Handler der Erweiterung fungiert.

Der background-Schlüssel kann auch diese optionale Eigenschaft enthalten:

persistent

Ein boolean-Wert.

Wenn weggelassen, ist diese Eigenschaft standardmäßig true in Manifest V2 und false in Manifest V3. Eine Einstellung auf true in Manifest V3 führt zu einem Fehler.

  • true bedeutet, dass die Hintergrundseite im Speicher gehalten wird, vom Zeitpunkt, an dem die Erweiterung geladen oder der Browser gestartet wird, bis die Erweiterung entladen oder deaktiviert wird oder der Browser geschlossen wird (d.h. die Hintergrundseite ist persistent).
  • false bedeutet, dass die Hintergrundseite bei Inaktivität aus dem Speicher entladen und bei Bedarf neu erstellt werden kann. Solche Hintergrundseiten werden oft als Ereignisseiten bezeichnet, da sie in den Speicher geladen werden, damit die Hintergrundseite die Ereignisse behandeln kann, zu denen sie Listener hinzugefügt hat. Die Registrierung von Listeners ist persistent, wenn die Seite aus dem Speicher entladen wird, andere Werte jedoch nicht. Wenn Sie Daten persistent in einer Ereignisseite speichern möchten, sollten Sie die Speicher-API verwenden.
preferred_environment

Ein array von string, das die bevorzugten Umgebungen in der Reihenfolge der Priorität auflistet.

Wenn background einen service_worker und eine page oder scripts angibt, ermöglicht diese Eigenschaft der Erweiterung, dem Browser mitzuteilen, welchen Hintergrundkontext verwendet werden soll, falls verfügbar. Siehe Browser-Unterstützung für Details zu den in den Hauptbrowsern unterstützten Umgebungen.

  • document fordert, dass der Browser die Hintergrundskripte der Erweiterung als Dokumente verwendet, falls unterstützt.
  • service_worker fordert, dass der Browser die Hintergrundskripte der Erweiterung als Service-Worker ausführt, falls unterstützt.

Chrome unterstützt nur Service-Worker und ignoriert diesen Schlüssel. Wenn weggelassen, führt Firefox und Safari Hintergrundskripte als Dokumente aus. Safari verwendet einen Service-Worker-Kontext, wenn die Erweiterung scripts angibt und preferred_environment auf service_worker gesetzt ist.
type

Ein string-Wert.

Bestimmt, ob die in scripts angegebenen Skripte als ES-Module geladen werden.

  • classic bedeutet, dass die Hintergrundskripte oder Service-Worker nicht als ES-Module enthalten sind.
  • module bedeutet, dass die Hintergrundskripte oder Service-Worker als ES-Module enthalten sind. Dies ermöglicht es der Hintergrundseite oder dem Service-Worker, Code zu importieren.

Wenn weggelassen, ist diese Eigenschaft standardmäßig auf classic gesetzt.

Browser-Unterstützung

Die Unterstützung für die Eigenschaften scripts, page und service_worker variiert zwischen den Browsern wie folgt:

  • Chrome:
    • unterstützt background.service_worker.
    • unterstützt background.scripts (und background.page) nur in Manifest V2-Erweiterungen.
    • vor Chrome 121 lehnt Chrome das Laden einer Manifest V3-Erweiterung mit background.scripts oder background.page ab. Ab Chrome 121 wird ihre Präsenz in einer Manifest V3-Erweiterung ignoriert.
  • Firefox:
    • background.service_worker wird nicht unterstützt (siehe Firefox-Bug 1573659).
    • unterstützt background.scripts (oder background.page), wenn service_worker nicht angegeben ist oder das Service-Worker-Feature deaktiviert ist. Vor Firefox 120 startete Firefox die Hintergrundseite nicht, wenn service_worker vorhanden war (siehe Firefox-Bug 1860304). Ab Firefox 121 startet die Hintergrundseite wie erwartet, unabhängig von der Präsenz von service_worker.
  • Safari:
    • unterstützt background.service_worker.
    • unterstützt background.scripts (oder background.page), wenn service_worker nicht angegeben ist.

Zum Veranschaulichen ist hier ein Beispiel für eine plattformübergreifende Erweiterung, die scripts und service_worker unterstützt. Das Beispiel hat diese manifest.json-Datei:

json
{
  "name": "Demo of service worker + event page",
  "version": "1",
  "manifest_version": 3,
  "background": {
    "scripts": ["background.js"],
    "service_worker": "background.js"
  }
}

Und, background.js enthält:

javascript
if (typeof browser == "undefined") {
  // Chrome does not support the browser namespace yet.
  globalThis.browser = chrome;
}
browser.runtime.onInstalled.addListener(() => {
  browser.tabs.create({ url: "http://example.com/first-run.html" });
});

Wenn die Erweiterung ausgeführt wird, passiert Folgendes:

  • in Chrome wird die service_worker-Eigenschaft verwendet und ein Service-Worker gestartet, der den Tab öffnet, da Chrome in einer Manifest V3-Erweiterung nur Service-Worker für Hintergrundskripte unterstützt.
  • in Firefox wird die scripts-Eigenschaft verwendet und ein Skript gestartet, das den Tab öffnet, da Firefox nur Skripte für Hintergrundskripte unterstützt.
  • in Safari wird die service_worker-Eigenschaft verwendet und ein Service-Worker gestartet, der den Tab öffnet, da Safari die Priorität hat, Service-Worker für Hintergrundskripte zu verwenden.

Beispiele

json
  "background": {
    "scripts": ["jquery.js", "my-background.js"]
  }

Zwei Hintergrundskripte laden.

json
  "background": {
    "page": "my-background.html"
  }

Eine benutzerdefinierte Hintergrundseite laden.

Browser-Kompatibilität