このページは Cloud Translation API によって翻訳されました。

バックグラウンドスクリプトでイベントを管理する

拡張機能は、Chrome のブラウジング環境を変更または強化するために使用されるイベントベースのプログラムです。イベントは、新しいページに移動する、ブックマークを削除する、タブを閉じるなどのブラウザによるトリガーです。拡張機能は、バックグラウンドスクリプトでこれらのイベントを監視し、指定された命令で対応します。

バックグラウンドページは、必要に応じて読み込まれ、アイドル状態になるとアンロードされます。たとえばイベントには次のようなものがあります。

拡張機能は最初にインストールされるか、新しいバージョンに更新されます。
バックグラウンドページがイベントをリッスンし、イベントがディスパッチされました。
コンテンツスクリプトやその他の拡張機能がメッセージを送信
拡張機能の別のビュー（ポップアップなど）では、runtime.getBackgroundPage を呼び出します。

一度読み込まれると、バックグラウンドページはアクションを実行している間、実行され続けます。ネットワークリクエストの発行などの操作が含まれます。またバックグラウンドページはすべての可視ビューとすべてのメッセージポートが閉じるまで、アンロードされません。ビューを開くと、イベントページの読み込みを引き起こさず、読み込み後に閉じないようにするだけです。

効果的なバックグラウンドスクリプトは、火災のリッスンしているイベントが発生するまで休止状態を維持し、アンロードします。

バックグラウンドスクリプトを登録する

バックグラウンドスクリプトは、マニフェストの "background" フィールドに登録されます。内容は次のとおりです。 "scripts" キーの後に配列にリストされます。"persistent" には false を指定する必要があります。

{
  "name": "Awesome Test Extension",
  ...
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  ...
}

モジュール化されたコード用に、複数のバックグラウンドスクリプトを登録できます。

{
    "name": "Awesome Test Extension",
    ...
    "background": {
      "scripts": [
        "backgroundContextMenus.js",
        "backgroundOmniBox.js",
        "backgroundOauth.js"
      ],
      "persistent": false
    },
    ...
  }

警告: バックグラウンドスクリプトを永続的にアクティブにするのは、拡張機能でネットワークリクエストをブロックまたは変更する chrome.webRequest APIwebRequest API に互換性がないバックグラウンドページと一緒に使用できますデフォルトでは、"persistent" は true に設定されています。

拡張機能が永続的なバックグラウンドページを現在使用している場合は、バックグラウンド移行を参照非永続モデルに切り替える方法については、ガイドをご覧ください。

拡張機能を初期化する

runtime.onInstalled イベントをリッスンして、インストール時に拡張機能を初期化します。使用するイベント（コンテキストメニューなど）を使用して、状態を設定するか 1 回限りの初期化を行います。

chrome.runtime.onInstalled.addListener(function() {
  chrome.contextMenus.create({
    "id": "sampleContextMenu",
    "title": "Sample Context Menu",
    "contexts": ["selection"]
  });
});

リスナーを設定する

拡張機能が依存するイベントを中心にバックグラウンドスクリプトを構築します。機能的関連性の定義イベントによって、バックグラウンドスクリプトがイベントが発生するまで休止状態になり、重要なトリガーの欠落を防ぐことができます。

リスナーはページの最初から同期して登録する必要があります。

chrome.runtime.onInstalled.addListener(function() {
  chrome.contextMenus.create({
    "id": "sampleContextMenu",
    "title": "Sample Context Menu",
    "contexts": ["selection"]
  });
});

// This will run when a bookmark is created.
chrome.bookmarks.onCreated.addListener(function() {
  // do something
});

リスナーを非同期で登録しないでください。正しくトリガーされません。

chrome.runtime.onInstalled.addListener(function() {
  // ERROR! Events must be registered synchronously from the start of
  // the page.
  chrome.bookmarks.onCreated.addListener(function() {
    // do something
  });
});

拡張機能は、removeListener を呼び出すことで、バックグラウンドスクリプトからリスナーを削除できます。すべてイベントリスナーが削除されると、Chrome は拡張機能のバックグラウンドスクリプトを表示されます。

chrome.runtime.onMessage.addListener(function(message, sender, reply) {
    chrome.runtime.onMessage.removeListener(event);
});

イベントをフィルタ

イベントフィルタをサポートする API を使用して、拡張機能が関係するケースにのみリスナーを制限する表示されます。拡張機能が tabs.onUpdated イベントをリッスンしている場合は、フィルタを含む webNavigation.onCompleted イベント（Tabs API でサポートされていません）フィルタできます。

chrome.webNavigation.onCompleted.addListener(function() {
    alert("This is my favorite website!");
}, {url: [{urlMatches : 'https://www.google.com/'}]});

リスナーにリアクションする

イベントが発生したときに機能をトリガーするためのリスナーが存在します。イベントに反応するには、リスナーイベント内で希望するリアクションを指定できます。

chrome.runtime.onMessage.addListener(function(message, callback) {
  if (message.data == "setAlarm") {
    chrome.alarms.create({delayInMinutes: 5})
  } else if (message.data == "runLogic") {
    chrome.tabs.executeScript({file: 'logic.js'});
  } else if (message.data == "changeColor") {
    chrome.tabs.executeScript(
        {code: 'document.body.style.backgroundColor="orange"'});
  };
});

バックグラウンドスクリプトのアンロード

延長時に重要な情報が失われないように、データは定期的に保持する必要がありますがクラッシュする。onSuspendそのためには、storage API を使用します。

chrome.storage.local.set({variable: variableInformation});

拡張機能でメッセージの受け渡しを使用している場合は、すべてのポートが閉じられていることを確認してください。バックグラウンドスクリプトがすべてのメッセージポートがシャットダウンするまでアンロードされません。runtime.Port.onDisconnect イベントをリッスンするオープンポートが閉じるタイミングがわかります。手動で閉じます。 runtime.Port.disconnect。

chrome.runtime.onMessage.addListener(function(message, callback) {
  if (message == 'hello') {
    sendResponse({greeting: 'welcome!'})
  } else if (message == 'goodbye') {
    chrome.runtime.Port.disconnect();
  }
});

バックグラウンドスクリプトの存続期間は、拡張機能のエントリがいつ追加されたかをモニタリングすることで監視できます。 Chrome のタスクマネージャーに表示されなくなります。

ALT_TEXT_HERE

Chrome メニューをクリックし、他のツールにカーソルを合わせて [Tasks] を選択して、タスクマネージャーを開きます。表示されます。

バックグラウンドスクリプトは、数秒間操作がないと自動的にアンロードされます。土壇場でのクリーンアップが必要な場合必要な場合は、runtime.onSuspend イベントをリッスンします。

chrome.runtime.onSuspend.addListener(function() {
  console.log("Unloading.");
  chrome.browserAction.setBadgeText({text: ""});
});

ただし、runtime.onSuspend ではなく、永続データを使用することをおすすめします。いいえクリーンアップは必要なだけ行ってください。クラッシュの場合には役立ちません。

バックグラウンド スクリプトでイベントを管理する

バックグラウンド スクリプトを登録する

拡張機能を初期化する

リスナーを設定する

イベントをフィルタ

リスナーにリアクションする

バックグラウンド スクリプトのアンロード

バックグラウンドスクリプトでイベントを管理する

バックグラウンドスクリプトを登録する

バックグラウンドスクリプトのアンロード