chrome.storage

refresh date: 2026-09-25 robots: noindex

说明

使用 chrome.storage API 存储、检索和跟踪用户数据的更改。

权限

storage

概览

Storage API 提供了一种特定于扩展程序的方式来保留用户数据和状态。它类似于 Web 平台的存储 API（IndexedDB 和 Storage），但旨在满足扩展程序的存储需求。以下是一些关键功能：

  • 所有扩展程序上下文（包括扩展程序 Service Worker 和内容脚本）都可以访问 Storage API。
  • 可序列化的 JSON 值会存储为对象属性。
  • Storage API 是异步的，支持批量读写操作。
  • 即使用户清除缓存和浏览记录，这些数据也会保留。
  • 即使使用拆分无痕模式，存储的设置也会保留。
  • 包含一个专供企业政策使用的只读受管理存储区域。

虽然扩展程序可以在某些上下文（弹出式窗口和其他 HTML 页面）中使用 [Storage][mdn-storage] 接口（可通过 window.localStorage 访问），但我们不建议这样做，原因如下：

  • 扩展程序的 Service Worker 无法访问 Storage。
  • 内容脚本与托管网页共享存储空间。
  • 当用户清除其浏览记录时，使用 Storage 接口保存的数据会丢失。

如需从 Service Worker 将数据从 Web 存储空间 API 移至扩展程序存储空间 API，请执行以下操作：

  1. 使用转换例程和 [onMessage][on-message] 处理程序创建屏幕外文档。
  2. 向屏幕外文档添加转换例程。
  3. 在扩展程序 Service Worker 中，检查 chrome.storage 是否有您的数据。
  4. 如果未找到您的数据，请 [创建][create-offscreen] 一个屏幕外文档，并调用 [sendMessage()][send-message] 来启动转换例程。
  5. 在屏幕外文档的 onMessage 处理程序中，调用转换例程。

此外，Web 存储 API 在扩展程序中的运作方式也存在一些细微差别。如需了解详情，请参阅 [存储空间和 Cookie][storage-and-cookies] 一文。

存储区域

Storage API 分为以下四个存储分区（“存储区域”）：

storage.local
数据存储在本地，在扩展程序被移除时会被清除。配额限制约为 10 MB，但可以通过请求 "unlimitedStorage" 权限来提高。建议使用它来存储大量数据。
storage.sync
如果启用了同步功能，数据会同步到用户登录的所有 Chrome 浏览器。如果停用，其行为将类似于 storage.local。当浏览器处于离线状态时，Chrome 会将数据存储在本地，并在恢复在线状态后继续同步。配额限制约为 100 KB，每项 8 KB。建议使用此 API 在已同步的浏览器之间保留用户设置。
storage.session
在浏览器会话期间将数据保存在内存中。默认情况下，它不会向内容脚本公开，但可以通过设置 chrome.storage.session.setAccessLevel() 来更改此行为。配额限制约为 10 MB。建议使用它来存储跨 Service Worker 运行的全局变量。
storage.managed
管理员可以使用架构和企业政策在受管理的环境中配置支持性扩展程序的设置。此存储区域为只读。

清单

如需使用 Storage API，请在扩展程序清单中声明 "storage" 权限。例如：

{
  "name": "My extension",
  ...
  "permissions": [
    "storage"
  ],
  ...
}

用法

以下示例演示了 local、sync 和 session 存储区域：

storage.local

chrome.storage.local.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.local.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.sync

chrome.storage.sync.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.sync.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.session

chrome.storage.session.set({ key: value }).then(() => {
  console.log("Value was set");
});

chrome.storage.session.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

如需详细了解 managed 存储区域，请参阅存储区域清单。

存储空间和限制

不要将向 Storage API 添加内容视为将物品放入大卡车。您可以将向存储空间添加内容想象成将物品放入管道。管道中可能已经有物料，甚至可能已经装满。始终假设从您添加到存储空间到实际记录之间存在延迟。

如需详细了解存储区域限制以及超出限制时会发生什么情况，请参阅 sync、local 和 session 的配额信息。

使用场景

以下部分演示了 Storage API 的常见应用场景。

对存储空间更新的同步响应

如需跟踪对存储空间所做的更改，您可以向其 onChanged 事件添加监听器。当存储空间发生任何变化时，该事件就会触发。示例代码会监听以下更改：

background.js:

chrome.storage.onChanged.addListener((changes, namespace) => {
  for (let [key, { oldValue, newValue }] of Object.entries(changes)) {
    console.log(
      `Storage key "${key}" in namespace "${namespace}" changed.`,
      `Old value was "${oldValue}", new value is "${newValue}".`
    );
  }
});

我们还可以进一步拓展这一思路。在此示例中，我们有一个选项页面，可让用户切换“调试模式”（此处未显示实现）。选项页面会立即将新设置保存到 storage.sync，而 Service Worker 会使用 storage.onChanged 尽快应用该设置。

options.html:

<!-- type="module" allows you to use top level await -->
<script defer src="options.js" type="module"></script>
<form id="optionsForm">
  <label for="debug">
    <input type="checkbox" name="debug" id="debug">
    Enable debug mode
  </label>
</form>

options.js:

// In-page cache of the user's options
const options = {};
const optionsForm = document.getElementById("optionsForm");

// Immediately persist options changes
optionsForm.debug.addEventListener("change", (event) => {
  options.debug = event.target.checked;
  chrome.storage.sync.set({ options });
});

// Initialize the form with the user's option settings
const data = await chrome.storage.sync.get("options");
Object.assign(options, data.options);
optionsForm.debug.checked = Boolean(options.debug);

background.js:

function setDebugMode() { /* ... */ }

// Watch for changes to the user's options & apply them
chrome.storage.onChanged.addListener((changes, area) => {
  if (area === 'sync' && changes.options?.newValue) {
    const debugMode = Boolean(changes.options.newValue.debug);
    console.log('enable debug mode?', debugMode);
    setDebugMode(debugMode);
  }
});

从存储空间异步预加载

由于 Service Worker 并非始终运行，因此 Manifest V3 扩展程序有时需要在执行事件处理脚本之前，从存储空间异步加载数据。为此，以下代码段使用了一个异步 action.onClicked 事件处理脚本，该脚本会等待 storageCache 全局变量填充完毕，然后再执行其逻辑。

background.js:

// Where we will expose all the data we retrieve from storage.sync.
const storageCache = { count: 0 };
// Asynchronously retrieve data from storage.sync, then cache it.
const initStorageCache = chrome.storage.sync.get().then((items) => {
  // Copy the data retrieved from storage into storageCache.
  Object.assign(storageCache, items);
});

chrome.action.onClicked.addListener(async (tab) => {
  try {
    await initStorageCache;
  } catch (e) {
    // Handle error that occurred during storage initialization.
  }

  // Normal action handler logic.
  storageCache.count++;
  storageCache.lastTabId = tab.id;
  chrome.storage.sync.set(storageCache);
});

扩展程序示例

如需查看 Storage API 的其他演示，请探索以下任一示例：

类型

AccessLevel

Chrome 102 及更高版本

存储区域的访问权限级别。

枚举

"TRUSTED_CONTEXTS"
指定源自扩展程序本身的上下文。

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
指定源自扩展程序外部的上下文。

StorageChange

属性

  • newValue

    any 可选

    该项的新值（如果有）。

  • oldValue

    any 可选

    该项的旧值（如果有）。

属性

local

local 存储区中的内容仅存储在每台机器的本地。

类型

StorageArea 和对象

属性

  • QUOTA_BYTES

    10485760

    本地存储空间中可存储的数据量上限（以字节为单位），通过每个值的 JSON 字符串化加上每个键的长度来衡量。如果扩展程序具有 unlimitedStorage 权限，系统将忽略此值。如果更新会导致超出此限制，则会立即失败，并在使用回调时设置 runtime.lastError，或在使用 async/await 时返回被拒绝的 Promise。

managed

managed 存储区域中的内容由网域管理员配置的企业政策设置，对扩展程序而言是只读的；尝试修改此命名空间会导致错误。如需了解如何配置政策，请参阅存储区域清单。

类型

StorageArea

sync

sync 存储区域中的内容会通过 Chrome 同步功能进行同步。

类型

StorageArea 和对象

属性

  • MAX_ITEMS

    512

    同步存储区中可存储的最大项数。如果更新会导致超出此限制，则会立即失败，并在使用回调时或 Promise 被拒绝时设置 runtime.lastError。

  • MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

    1000000

    已弃用

    storage.sync API 不再有持续写入操作配额。

  • MAX_WRITE_OPERATIONS_PER_HOUR

    1800

    每小时可执行的 set、remove 或 clear 操作的数量上限。即每 2 秒 1 次，低于短期内较高的每分钟写入次数上限。

    如果更新会导致超出此限制，则会立即失败，并在使用回调时或 Promise 被拒绝时设置 runtime.lastError。

  • MAX_WRITE_OPERATIONS_PER_MINUTE

    120

    每分钟可执行的 set、remove 或 clear 操作数上限。此限制为每秒 2 次，在较短的时间内提供比每小时写入次数更高的吞吐量。

    如果更新会导致超出此限制，则会立即失败，并在使用回调时或 Promise 被拒绝时设置 runtime.lastError。

  • QUOTA_BYTES

    102400

    同步存储空间中可存储的数据总量上限（以字节为单位），通过每个值的 JSON 字符串化加上每个键的长度来衡量。如果更新会导致超出此限制，则会立即失败，并在使用回调时或 Promise 被拒绝时设置 runtime.lastError。

  • QUOTA_BYTES_PER_ITEM

    8192

    同步存储区中每个单独项的大小上限（以字节为单位），通过其值的 JSON 字符串化加上其键长度来衡量。如果更新包含大于此限制的项，则会立即失败，并在使用回调时或 Promise 被拒绝时设置 runtime.lastError。

事件

onChanged

chrome.storage.onChanged.addListener(
  callback: function,
)

当一个或多个内容发生更改时触发。

参数

  • callback

    函数

    callback 参数如下所示： 

    (changes: object, areaName: string) => void

    • 更改

      对象

    • areaName

      字符串