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

瀏覽器相容性