background

Typ	`Object`
Pflicht	Nein
Manifestversion	2 oder höher
Beispiel	json `"background": { "scripts": ["background.js"] }`

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

Hintergrundskripte sind der Ort, an dem Code platziert wird, der einen langfristigen Zustand aufrechterhalten oder langfristige Operationen unabhängig von der Lebensdauer bestimmter Webseiten oder Browserfenster durchfü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 in dem Skript alle WebExtension-APIs verwenden, wenn Sie die erforderlichen Berechtigungen angefordert haben.

Siehe Hintergrundskripte für weitere Details.

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

page

Wenn Sie spezifische Inhalte 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 HTML-Dokument darstellt, 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 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 denselben window-globalen Kontext.

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 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 der Erweiterung an. Ein Service Worker ist ein Hintergrundskript, das als Hauptereignis-Handler der Erweiterung dient.

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

persistent

Ein boolean-Wert.

Wenn nicht angegeben, ist diese Eigenschaft standardmäßig true in Manifest V2 und false in Manifest V3. Die Einstellung 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 wird, oder der Browser geschlossen wird (das heißt, die Hintergrundseite ist persistent).
false bedeutet, dass die Hintergrundseite aus dem Speicher entladen werden kann, wenn sie im Leerlauf ist, und bei Bedarf neu erstellt wird. Solche Hintergrundseiten werden oft als Ereignisseiten bezeichnet, da sie in den Speicher geladen werden, um der Hintergrundseite das Bearbeiten der Ereignisse zu ermöglichen, zu denen sie Listener hinzugefügt hat. Die Registrierung von Listenern bleibt bestehen, wenn die Seite aus dem Speicher entladen wird, aber andere Werte bleiben nicht persistent. Wenn Sie Daten dauerhaft in einer Ereignisseite speichern möchten, sollten Sie die storage API verwenden.

preferred_environment

Ein array von string, das die bevorzugten Umgebungen in 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 er verwenden soll, falls verfügbar. Siehe Browserunterstützung für Details zu den in den wichtigsten Browsern unterstützten Umgebungen.

document fordert den Browser auf, die Hintergrundskripte der Erweiterung als Dokumente zu verwenden, falls unterstützt.
service_worker fordert den Browser auf, die Hintergrundskripte der Erweiterung als Service Worker auszuführen, falls unterstützt.

Chrome unterstützt nur Service Worker, daher ignoriert es diesen Schlüssel. Wenn nicht angegeben, führt Firefox 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 gibt an, dass die Hintergrundskripte oder Service Worker nicht als ES Module eingeschlossen sind.
module gibt an, dass die Hintergrundskripte oder Service Worker als ES Module eingeschlossen sind. Dies ermöglicht es der Hintergrundseite oder dem Service Worker, Code zu import.

Wenn nicht angegeben, 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 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 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 beides angegeben ist, verwendet es background.scripts (oder background.page), es sei denn, preferred_environment ist auf service_worker gesetzt.

Zum Veranschaulichen ist dies ein Beispiel für eine browserü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:

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 Eigenschaft service_worker verwendet, und ein Service Worker startet, der den Tab öffnet, da Chrome bei einer Manifest V3-Erweiterung nur Service Worker für Hintergrundskripte unterstützt.
in Firefox wird die Eigenschaft scripts verwendet, und ein Skript startet, das den Tab öffnet, da Firefox nur Skripte für Hintergrundskripte unterstützt.
in Safari wird die Eigenschaft service_worker verwendet, und ein Service Worker startet, der den Tab öffnet, da Safari es vorzieht, Service Worker für Hintergrundskripte zu verwenden.

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

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

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