background

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

Verwenden Sie den background Schlüssel, um ein oder mehrere Hintergrund-Skripte, eine Hintergrundseite oder einen Service Worker in Ihrer Erweiterung einzuschließen.

Hintergrund-Skripte sind der Ort, an dem Code abgelegt wird, der einen langfristigen Zustand aufrechterhalten oder langfristige Operationen unabhängig von der Lebensdauer bestimmter Webseiten oder Browserfenster durchführen muss.

Hintergrund-Skripte werden geladen, sobald die Erweiterung geladen wird und bleiben geladen, bis die Erweiterung deaktiviert oder deinstalliert wird, es sei denn, persistent ist auf false gesetzt. Sie können alle WebExtension APIs im Skript verwenden, wenn Sie die notwendigen Berechtigungen beantragt haben.

Weitere Details finden Sie unter Background scripts.

Der background Schlüssel ist ein Objekt, das eine dieser Eigenschaften haben muss (für weitere Informationen zur Unterstützung dieser Eigenschaften siehe Browser support):

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 darstellt, um ein HTML-Dokument, das in Ihrem Erweiterungspaket enthalten ist.

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

scripts

Ein array von string, von denen jedes 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 denselben 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 content_security_policy Schlüssel in der manifest.json Datei Ihrer Erweiterung ändern.

service_worker

Geben Sie eine JavaScript-Datei als Service Worker-Script 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 ausgelassen, wird dieser Wert standardmäßig auf true in Manifest V2 und false in Manifest V3 gesetzt. Das Festlegen 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 oder der Browser gestartet wird, bis die Erweiterung entladen oder deaktiviert oder der Browser geschlossen wird (d.h. die Hintergrundseite ist persistent).
false bedeutet, dass die Hintergrundseite aus dem Speicher entladen werden kann, wenn sie untätig ist, und bei Bedarf neu erstellt wird. Solche Hintergrundseiten werden oft als Ereignisseiten bezeichnet, weil sie in den Speicher geladen werden, um Ereignisse zu verarbeiten, zu denen die Hintergrundseite Listener hinzugefügt hat. Die Registrierung von Listeners bleibt bestehen, wenn die Seite aus dem Speicher entladen wird, aber andere Werte sind nicht persistent. Wenn Sie Daten auf einer Ereignisseite persistent speichern möchten, sollten Sie die Storage API verwenden.

preferred_environment

Ein array von string, das die bevorzugten Umgebungen in der Reihenfolge der Präzedenz auflistet.

Wenn background sowohl einen service_worker als auch eine page oder scripts spezifiziert, ermöglicht diese Eigenschaft der Erweiterung, dem Browser mitzuteilen, welchen Hintergrundkontext er verwenden soll, falls verfügbar. Siehe Browser support 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 ausgelassen, 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 gibt an, dass die Hintergrundskripte oder Service Worker nicht als ES-Modul enthalten sind.
module gibt an, dass die Hintergrundskripte oder Service Worker als ES-Modul enthalten sind. Dies ermöglicht es der Hintergrundseite oder dem Service Worker, Code zu importieren.

Wenn ausgelassen, wird diese Eigenschaft standardmäßig auf classic gesetzt.

Browser-Kompatibilität

Die Unterstützung für die Eigenschaften scripts, page und service_worker variiert je nach Browser wie folgt:

Chrome:
- unterstützt background.service_worker.
- unterstützt background.scripts (und background.page) nur in Manifest V2-Erweiterungen.
- vor Chrome 121 weigert sich Chrome, eine Manifest V3-Erweiterung mit background.scripts oder background.page zu laden. Ab Chrome 121 wird ihre Anwesenheit 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 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 aus background.scripts, wenn vorhanden.

Zur Veranschaulichung ist dies ein Beispiel für eine Cross-Browser-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:

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, geschieht Folgendes:

in Chrome wird die service_worker Eigenschaft verwendet, und ein Service Worker startet, der die Registerkarte öffnet, da in einer Manifest V3-Erweiterung Chrome nur Service Worker für Hintergrundskripte unterstützt.
in Firefox wird die scripts Eigenschaft verwendet, und ein Skript startet, das die Registerkarte öffnet, weil Firefox nur Skripte für Hintergrundskripte unterstützt.
in Safari wird die service_worker Eigenschaft verwendet, und ein Service Worker startet, der die Registerkarte öffnet, weil Safari Service Worker für Hintergrundskripte priorisiert.

Beispiele

json

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

Zwei Hintergrund-Skripte laden.

json

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

Eine benutzerdefinierte Hintergrundseite laden.

Browser-Kompatibilität

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

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