Code aktualisieren

Updates, die nichts mit anderen Problemen zu tun haben

Dies ist der erste von drei Abschnitten, in denen Änderungen beschrieben werden, die für Code erforderlich sind, der nicht Teil des Erweiterungs-Service-Workers ist. In diesem Abschnitt finden Sie erforderliche Codeänderungen, die nicht mit anderen Problemen zusammenhängen. In den nächsten beiden Abschnitten geht es um das Ersetzen blockierter Webanfragen und die Verbesserung der Sicherheit.

Ersetzen Sie „tabs.executeScript()“ durch „scripting.executeScript()“.

In Manifest V3 wird executeScript() von der tabs API zur scripting API verschoben. Dazu sind nicht nur Änderungen am Code, sondern auch Änderungen an den Berechtigungen in der Manifestdatei erforderlich.

Für die Methode executeScript() benötigen Sie Folgendes:

• Die Berechtigung "scripting".
• Entweder Hostberechtigungen oder die Berechtigung "activeTab".

Die Methode scripting.executeScript() funktioniert ähnlich wie bei tabs.executeScript(). Es gibt jedoch einige Unterschiede.

• Während die alte Methode nur eine einzelne Datei verarbeiten konnte, kann die neue Methode ein Array von Dateien verarbeiten.
• Außerdem übergeben Sie ein ScriptInjection-Objekt anstelle von InjectDetails. Es gibt mehrere Unterschiede zwischen den beiden. Zum Beispiel wird tabId jetzt als Element von ScriptInjection.target und nicht als Methodenargument übergeben.

Das Beispiel zeigt, wie das geht.

async function getCurrentTab() {/* ... */}
let tab = await getCurrentTab();

chrome.tabs.executeScript(
  tab.id,
  {
    file: 'content-script.js'
  }
);

async function getCurrentTab()
let tab = await getCurrentTab();

chrome.scripting.executeScript({
  target: {tabId: tab.id},
  files: ['content-script.js']
});

Ersetzen Sie „tabs.insertCSS()“ und „tabs.removeCSS()“ durch „scripting.insertCSS()“ und „scripting.removeCSS()“.

In Manifest V3 werden insertCSS() und removeCSS() von der tabs API zur scripting API verschoben. Dazu sind nicht nur Codeänderungen, sondern auch Änderungen an den Berechtigungen in der Manifestdatei erforderlich:

• Die Berechtigung "scripting".
• Entweder Hostberechtigungen oder die Berechtigung "activeTab".

Die Funktionen der scripting API ähneln denen von tabs. Es gibt jedoch einige Unterschiede.

• Wenn Sie diese Methoden aufrufen, übergeben Sie anstelle von InjectDetails ein CSSInjection-Objekt.
• tabId wird jetzt als Mitglied von CSSInjection.target und nicht als Methodenargument übergeben.

Das Beispiel zeigt, wie das für insertCSS() geht. Die Vorgehensweise für removeCSS() ist identisch.

chrome.tabs.insertCSS(tabId, injectDetails, () => {
  // callback code
});

const insertPromise = await chrome.scripting.insertCSS({
  files: ["style.css"],
  target: { tabId: tab.id }
});
// Remaining code. 

Browseraktionen und Seitenaktionen durch Aktionen ersetzen

Browseraktionen und Seitenaktionen waren in Manifest V2 unterschiedliche Konzepte. Obwohl sie mit unterschiedlichen Rollen begannen, nahmen die Unterschiede zwischen ihnen mit der Zeit ab. In Manifest V3 werden diese Konzepte in der Action API zusammengefasst. Dazu sind Änderungen an Ihrem manifest.json und Ihrem Erweiterungscode erforderlich, die sich von den Angaben in Ihrem Manifest V2-Hintergrundskript unterscheiden.

Aktionen in Manifest V3 ähneln am ehesten Browseraktionen. Die action API bietet jedoch keine hide() und show() wie die pageAction API. Wenn Sie weiterhin Seitenaktionen benötigen, können Sie diese entweder mithilfe von deklarativen Inhalten emulieren oder enable() oder disable() mit einer Tab-ID aufrufen.

„browser_action“ und „page_action“ durch „action“ ersetzen

Ersetzen Sie in manifest.json die Felder "browser_action" und "page_action" durch das Feld "action". Weitere Informationen zum Feld "action"

{
  ...
  "page_action": { ... },
  "browser_action": {
    "default_popup": "popup.html"
   }
  ...
}

{
  ...
  "action": {
    "default_popup": "popup.html"
  }

  ...
}

Die browserAction- und pageAction-APIs durch die action-API ersetzen

Wenn in Ihrem Manifest V2 die APIs browserAction und pageAction verwendet wurden, sollten Sie jetzt die action API verwenden.

chrome.browserAction.onClicked.addListener(tab => { ... });
chrome.pageAction.onClicked.addListener(tab => { ... });

chrome.action.onClicked.addListener(tab => { ... });

Callbacks durch Promises ersetzen

In Manifest V3 geben viele Erweiterungs-API-Methoden Promise zurück. Ein Promise ist ein Proxy oder Platzhalter für einen Wert, der von einer asynchronen Methode zurückgegeben wird. Wenn Sie Promises noch nie verwendet haben, können Sie sich auf MDN darüber informieren. Auf dieser Seite erfahren Sie, was Sie wissen müssen, um sie in einer Chrome-Erweiterung zu verwenden.

Aus Gründen der Abwärtskompatibilität unterstützen viele Methoden weiterhin Callbacks, auch nachdem Promise-Unterstützung hinzugefügt wurde. Sie können beide nicht für denselben Funktionsaufruf verwenden. Wenn Sie einen Callback übergeben, gibt die Funktion kein Versprechen zurück. Wenn Sie ein Versprechen zurückgeben möchten, übergeben Sie keinen Callback. Für einige API-Funktionen wie Event-Listener sind weiterhin Callbacks erforderlich. Suchen Sie nach dem „Promise“, um zu prüfen, ob eine Methode Promise unterstützt. in seiner API-Referenz.

Wenn du einen Callback in ein Promise konvertieren möchtest, entferne den Callback und verarbeite das zurückgegebene Promise. Das folgende Beispiel stammt aus dem Beispiel für optionale Berechtigungen, insbesondere newtab.js. Die Callback-Version zeigt, wie der Aufruf von request() im Beispiel mit einem Callback aussehen würde. Die Promise-Version könnte mit „async“ und „await“ umgeschrieben werden.

chrome.permissions.request(newPerms, (granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});

const newPerms = { permissions: ['topSites'] };
chrome.permissions.request(newPerms)
.then((granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});

Funktionen ersetzen, die einen Manifest V2-Hintergrundkontext erwarten

Andere Erweiterungskontexte können nur per Nachrichtenweitergabe mit Erweiterungs-Service-Workern interagieren. Daher müssen Sie Aufrufe ersetzen, für die ein Hintergrundkontext erforderlich ist, insbesondere:

• chrome.runtime.getBackgroundPage()
• chrome.extension.getBackgroundPage()
• chrome.extension.getExtensionTabs()

Ihre Erweiterungsskripts sollten Nachrichtenweitergabe für die Kommunikation zwischen einem Service Worker und anderen Teilen Ihrer Erweiterung verwenden. Derzeit ist dies möglich, indem Sie sendMessage() verwenden und chrome.runtime.onMessage in Ihrem Erweiterungs-Dienst-Worker implementieren. Langfristig sollten Sie diese Aufrufe durch postMessage() und den Nachrichtenereignis-Handler eines Service Workers ersetzen.

Nicht unterstützte APIs ersetzen

Die unten aufgeführten Methoden und Eigenschaften müssen in Manifest V3 geändert werden.