background

Typ	`Object`
Verpflichtend	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, um Code zu platzieren, der einen langfristigen Zustand aufrechterhalten oder langfristige Operationen unabhängig von der Lebensdauer bestimmter Webseiten oder Browserfenster ausführen muss.

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

Details finden Sie unter Hintergrundskripte.

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

page

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

Wenn Sie diese Eigenschaft verwenden, können Sie keine Hintergrundskripte mit scripts angeben, aber Sie können Skripte von der Seite aus 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 sich 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 Ort mit dem <script>-Tag abrufen möchten (z. B. <script src = "https://code.jquery.com/jquery-3.6.0.min.js">), müssen Sie den Schlüssel content_security_policy 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. Das Setzen auf true in Manifest V3 führt zu einem Fehler.

true bedeutet, dass die Hintergrundseite im Speicher gehalten wird, von dem Zeitpunkt an, an dem die Erweiterung geladen wird oder der Browser startet, bis die Erweiterung entladen oder deaktiviert wird, oder der Browser geschlossen wird (d.h. die Hintergrundseite ist persistent).
false bedeutet, dass die Hintergrundseite aus dem Speicher entladen werden kann, wenn sie inaktiv ist und bei Bedarf wieder erstellt wird. Solche Hintergrundseiten werden oft als Ereignisseiten bezeichnet, weil sie in den Speicher geladen werden, um den Hintergrundseiten die Bearbeitung der Ereignisse zu ermöglichen, für die sie Listener hinzugefügt haben. Die Registrierung von Listenern ist persistent, wenn die Seite aus dem Speicher entladen wird, aber andere Werte sind nicht persistent. Wenn Sie Daten persistent in einer Ereignisseite speichern möchten, sollten Sie die Storage-API verwenden.

preferred_environment

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

Wenn background sowohl service_worker als auch page oder scripts spezifiziert, ermöglicht diese Eigenschaft der Erweiterung, dem Browser mitzuteilen, welchen Hintergrundkontext er verwenden soll, falls verfügbar. Siehe Browser-Unterstützung für Details zu den in den großen Browsern 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, daher ignoriert es diesen Schlüssel. Wenn weggelassen, führen Firefox und Safari Hintergrundskripte als Dokumente aus. Safari verwendet einen Service Worker Kontext, wenn die Erweiterung scripts spezifiziert 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-Modul eingebunden sind.
module bedeutet, dass die Hintergrundskripte oder Service Worker als ES-Modul eingebunden sind. Dies ermöglicht, dass die Hintergrundseite oder der Service Worker Code importieren kann.

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

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 verweigert Chrome das Laden einer Manifest V3 Erweiterung mit vorhandenem background.scripts oder background.page. Ab Chrome 121 wird deren Vorhandensein 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 die Service Worker Funktion 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 Anwesenheit von service_worker.
Safari:
- unterstützt background.scripts (oder background.page) und background.service_worker.
- wenn beide angegeben sind, verwendet Safari background.scripts (oder background.page), es sei denn preferred_environment ist auf service_worker gesetzt.
- wenn preferred_environment auf service_worker gesetzt ist und background.service_worker nicht angegeben ist, generiert Safari einen Service Worker von background.scripts, wenn vorhanden.

Cross-Browser Manifest V3 Hintergrundskripte

Um Browser mit unterschiedlichen Implementierungen für Manifest V3 Hintergrundskripte zu unterstützen, geben Sie sowohl scripts als auch service_worker im background-Schlüssel an. Browser, die Service Worker für Hintergrunddienste unterstützen, verwenden service_worker, während Browser, die Ereignisseiten für diesen Fall verwenden, scripts einsetzen.

Sie müssen preferred_environment für dieses Fallback-Verhalten nicht einschließen. Verwenden Sie preferred_environment nur, wenn Sie möchten, dass Safari oder ein anderer Browser, der mehr als eine Hintergrundumgebung unterstützt, service_worker bevorzugt, wo verfügbar.

Dieses Beispiel zeigt die relevanten Teile eines Manifests, das sowohl scripts als auch service_worker enthält:

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:

browser.runtime.onInstalled.addListener(() => {
  browser.tabs.create({ url: "http://example.com/first-run.html" });
});

Mit dieser background-Konfiguration passiert Folgendes:

in Chrome wird die service_worker-Eigenschaft verwendet und ein Service Worker gestartet, da Chrome in einer Manifest V3 Erweiterung nur Service Worker für Hintergrundskripte unterstützt.
in Firefox wird die scripts-Eigenschaft verwendet und eine Ereignisseite gestartet, da Firefox nur Skripte für Hintergrundskripte unterstützt.
in Safari wird standardmäßig die scripts-Eigenschaft verwendet und eine Ereignisseite gestartet.

Beispiele

json

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

Laden Sie zwei Hintergrundskripte.

json

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

Laden Sie eine benutzerdefinierte Hintergrundseite.

Browser-Kompatibilität

Help improve MDN

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden