storage.sync

同步数据的存储配额

浏览器对每个扩展在同步区域中允许存储的数据量强制执行限制

如果扩展尝试存储超出这些限制的项目，则调用 storage.sync.set() 将会因错误而被拒绝。扩展可以使用 storage.sync.getBytesInUse() 来了解其配额的多少正在被使用。

同步过程

在 Firefox 中，扩展数据每 10 分钟同步一次，或者在用户选择“立即同步”（位于“设置” > “同步”或从 Mozilla 账户图标处）时进行同步。当浏览器执行同步时，对于存储的每个键，它会

• 将服务器上的值与上次同步时的值进行比较；如果它们不同，则将服务器上的值写入浏览器同步存储中的该键。
• 将浏览器同步存储中的值与服务器上的值进行比较；如果它们不同，则将浏览器中的键值写入服务器。

这意味着，对于每个键，服务器上的更改优先于浏览器同步存储中的更改。

此机制通常适用于用户偏好设置或其他用户更改的全局设置等数据。

然而，一个键的值可能在一个浏览器上更新并同步，然后在第二个浏览器同步之前在第二个浏览器上更新，从而导致本地更新在同步期间被覆盖。因此，此机制不适用于跨设备聚合的数据，例如页面浏览量计数或某个选项的使用次数。要处理此类情况，请使用 storage.sync.onChanged 来监听来自服务器的同步更新（例如，另一个浏览器实例上的页面浏览量计数）。然后，在本地调整该值以考虑远程值（例如，根据远程计数和新的本地计数更新总浏览量）。

方法

sync 对象实现了 storage.StorageArea 类型上定义的那些方法

storage.sync.get()

从存储区域检索一个或多个项目。

storage.sync.getBytesInUse()

获取存储区域中一个或多个项目所使用的存储空间（以字节为单位）。

storage.sync.getKeys()

检索存储区域中所有项目的键。

storage.sync.set()

将一个或多个项目存储到存储区域。如果项目已存在，则更新其值。

storage.sync.remove()

从存储区域中移除一个或多个项目。

storage.sync.clear()

移除存储区域中的所有项目。

事件

sync 对象实现了 storage.StorageArea 类型上定义的那些事件

storage.sync.onChanged

当存储区域中的一个或多个项目发生更改时触发。

扩展程序示例

• favourite-colour

浏览器兼容性