Browser Extensions Development (Chrome & Edge) · 课时

组件之间的双向消息传递

掌握使用消息传递实现更复杂的双向通信，以便在扩展的不同部分之间进行请求-响应交互

组件之间的双向消息传递 是 CoddyKit 上的免费 Browser Extensions Development (Chrome & Edge) 课时。这是第 2 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Browser Extensions Development (Chrome & Edge) 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Browser Extensions Development (Chrome & Edge) 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

Two-Way Messaging Intro

Welcome! In this lesson, you'll master two-way messaging, a powerful way for different parts of your browser extension to communicate effectively.

Unlike one-way messages, two-way messaging allows a sender to not only send a request but also to receive a specific response back from the receiver.

The Request-Response Model

Two-way communication follows a simple request-response model:

A component (e.g., a popup) sends a message (the request).
Another component (e.g., the background script) receives and processes it.
The receiving component then sends a message back (the response).
The original sender receives this response and acts on it.

Sending a Request with Callback

To send a request and expect a response, you use chrome.runtime.sendMessage() with an optional callback function. This callback will execute once the response is received.

Try running this example from a popup or content script:

/* popup.js or content-script.js */
console.log("Sending request to background...");

chrome.runtime.sendMessage({type: "fetchSettings", key: "theme"},
  function(response) {
    if (chrome.runtime.lastError) {
      console.error("Error sending message:", chrome.runtime.lastError.message);
      return;
    }
    if (response && response.status === "success") {
      console.log("Received setting:", response.value);
    } else {
      console.error("Failed to get setting:", response.error);
    }
  }
);

Receiving & Responding (Sync)

The receiving component (often your background service worker) listens for messages using chrome.runtime.onMessage.addListener(). This listener receives the request, sender, and a special sendResponse function.

To send a synchronous response, simply call sendResponse() with your data. The message channel will then close.

/* service-worker.js (background script) */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    console.log("Background received request:", request.type);

    if (request.type === "fetchSettings") {
      // Simulate fetching a setting synchronously
      const settings = {theme: "dark", notifications: true};
      const value = settings[request.key];

      if (value !== undefined) {
        sendResponse({status: "success", value: value});
      } else {
        sendResponse({status: "error", error: "Setting not found"});
      }
    }
    // No 'return true;' needed for synchronous response
  }
);

Handling Async Responses

What if your response depends on an asynchronous operation, like fetching data from an API or local storage? If you call sendResponse() inside an async callback, the message channel might close before your response is ready.

To prevent this, return true from your onMessage.addListener callback. This tells Chrome to keep the channel open, allowing you to call sendResponse() later.

/* service-worker.js (background script) */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    if (request.type === "fetchAsyncData") {
      console.log("Processing async request...");
      // Simulate an async data fetch
      setTimeout(() => {
        const data = {id: 'unique123', content: 'Fetched after delay'};
        sendResponse({status: "success", data: data});
      }, 500); // Wait 500ms

      return true; // IMPORTANT: Keeps the message channel open
    }
  }
);

Popup to Content Script

You can also establish two-way communication directly between a popup and a content script running on the active tab. For this, the popup uses chrome.tabs.sendMessage(), specifying the tab ID.

The content script then uses chrome.runtime.onMessage.addListener(), just like a background script.

/* popup.js */
console.log("Sending message to active tab...");

chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
  if (tabs.length > 0) {
    chrome.tabs.sendMessage(tabs[0].id, {action: "getSelection"},
      function(response) {
        if (chrome.runtime.lastError) {
          console.error("Error from content script:", chrome.runtime.lastError.message);
          return;
        }
        if (response && response.selectedText) {
          console.log("Selected text:", response.selectedText);
        } else {
          console.log("No text selected.");
        }
      }
    );
  }
});

Content Script Responds

Here's how the content script on the web page would receive the message from the popup and send back the currently selected text.

Remember, the content script also uses chrome.runtime.onMessage.addListener() and can use sendResponse().

/* content.js */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    console.log("Content script received action:", request.action);

    if (request.action === "getSelection") {
      const selectedText = window.getSelection().toString();
      sendResponse({selectedText: selectedText});
    }
    // For synchronous response, no 'return true;' is needed
  }
);

Error Handling Tips

Robust error handling is crucial:

Check chrome.runtime.lastError: After sendMessage(), always check this property to catch errors like disconnected ports (e.g., if the receiving script isn't active).
Include status in response: Design your response objects with a status field (e.g., 'success', 'error') and an optional message or error field for details.
Handle undefined responses: The callback might be called with an undefined response if the receiver doesn't call sendResponse().

Best Practices for Two-Way

To ensure smooth and maintainable two-way messaging:

Define clear message types: Use a type or action field in your message objects (e.g., {type: "getData"}) to easily identify intent.
Keep messages simple: Pass only necessary, JSON-serializable data. Avoid complex objects or DOM elements.
Centralize listener logic: If possible, use a single onMessage.addListener in your background script and route requests based on their type.
Document message contracts: Clearly define what each message type expects and what response it returns.

Check Your Understanding

Test your knowledge of two-way messaging!

Recap & Next Steps

You've mastered two-way messaging!

You learned how to send requests using chrome.runtime.sendMessage() and receive responses via a callback.
You can now use chrome.runtime.onMessage.addListener() with sendResponse() to reply to messages, handling both synchronous and asynchronous scenarios.
You also saw how to enable communication between popups and content scripts using chrome.tabs.sendMessage().

Next, you'll explore how to persist data using the chrome.storage API, which often works hand-in-hand with messaging!

常见问题解答

「组件之间的双向消息传递」课时是免费的吗？

是的 — 「组件之间的双向消息传递」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Browser Extensions Development (Chrome & Edge) 课程的其余内容，请升级到 CoddyKit PRO。 Browser Extensions Development (Chrome & Edge) 课程共包含 4 节课。

「组件之间的双向消息传递」这节课中我会学到什么？

掌握使用消息传递实现更复杂的双向通信，以便在扩展的不同部分之间进行请求-响应交互你通过在浏览器中直接运行的动手代码来练习 Browser Extensions Development (Chrome & Edge)，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Browser Extensions Development (Chrome & Edge) 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Browser Extensions Development (Chrome & Edge) 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 2 节课，共 4 节。

「组件之间的双向消息传递」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Browser Extensions Development (Chrome & Edge) 课中编写并运行代码吗？

能。每节 Browser Extensions Development (Chrome & Edge) 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Browser Extensions Development (Chrome & Edge)