Ta strona została przetłumaczona przez Cloud Translation API.

chrome.storage

Opis

Użyj interfejsu chrome.storage API, aby przechowywać, pobierać i śledzić zmiany w danych użytkowników.

Uprawnienia

storage

Aby korzystać z interfejsu Storage API, zadeklaruj uprawnienie "storage" w pliku manifestu rozszerzenia. Na przykład:

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

Przykłady

Poniższe przykłady pokazują obszary pamięci local, sync i session:

Przykład (lokalny)

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

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

Przykład (synchronizacja)

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

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

Przykład (sesja)

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

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

Aby zobaczyć inne wersje demonstracyjne interfejsu Storage API, zapoznaj się z tymi przykładami:

Pojęcia i zastosowanie

Interfejs Storage API zapewnia sposób na utrwalanie danych i stanu użytkownika w sposób specyficzny dla rozszerzenia. Jest podobny do interfejsów API pamięci masowej platformy internetowej (IndexedDB i Storage), ale został zaprojektowany z myślą o potrzebach rozszerzeń w zakresie przechowywania danych. Oto kilka najważniejszych funkcji:

Wszystkie konteksty rozszerzeń, w tym skrypt usługi rozszerzenia i skrypty treści, mają dostęp do interfejsu Storage API.
Wartości, które można serializować do formatu JSON, są przechowywane jako właściwości obiektu.
Interfejs Storage API jest asynchroniczny i umożliwia zbiorcze operacje odczytu i zapisu.
Nawet jeśli użytkownik wyczyści pamięć podręczną i historię przeglądania, dane pozostaną.
Zapisane ustawienia są zachowywane nawet podczas korzystania z podzielonego trybu incognito.
Obejmuje ekskluzywny obszar zarządzanej pamięci tylko do odczytu na potrzeby zasad przedsiębiorstwa.

Czy rozszerzenia mogą korzystać z interfejsów Web Storage API?

Rozszerzenia mogą w niektórych kontekstach (wyskakujące okienko i inne strony HTML) korzystać z interfejsu Storage (dostępnego z window.localStorage), ale nie zalecamy tego z tych powodów:

Skrypty service worker rozszerzeń nie mogą używać interfejsu Web Storage API.
Skrypty treści współdzielą pamięć masową ze stroną hostującą.
Dane zapisane za pomocą interfejsu Web Storage API są tracone, gdy użytkownik wyczyści historię przeglądania.

Aby przenieść dane z interfejsów API pamięci internetowej do interfejsów API pamięci rozszerzeń z poziomu skryptu service worker:

Przygotuj stronę HTML dokumentu poza ekranem i plik skryptu. Plik skryptu powinien zawierać procedurę konwersji i procedurę obsługi onMessage.
W procesie roboczym usługi rozszerzenia sprawdź chrome.storage pod kątem swoich danych.
Jeśli nie znajdziesz swoich danych, zadzwoń pod numer createDocument().
Po rozwiązaniu zwróconego obiektu Promise wywołaj funkcję sendMessage(), aby rozpocząć procedurę konwersji.
W obsłudze onMessage dokumentu poza ekranem wywołaj procedurę konwersji.

Istnieją też pewne niuanse dotyczące działania interfejsów API pamięci internetowej w rozszerzeniach. Więcej informacji znajdziesz w artykule Miejsce na dane i pliki cookie.

Limity miejsca na dane i ograniczania

Interfejs Storage API ma ograniczenia użytkowania:

Przechowywanie danych wiąże się z kosztami związanymi z wydajnością, a interfejs API obejmuje limity miejsca na dane. Zaplanuj dane, które chcesz przechowywać, aby zachować miejsce na dane.
Przenoszenie danych może zająć trochę czasu. Zorganizuj kod tak, aby uwzględniał ten czas.

Szczegółowe informacje o ograniczeniach obszaru pamięci i o tym, co się dzieje po ich przekroczeniu, znajdziesz w informacjach o limitach dla sync, local i session.

Obszary przechowywania

Interfejs Storage API jest podzielony na te obszary pamięci:

Lokalne

Dane są przechowywane lokalnie i usuwane po usunięciu rozszerzenia. Limit miejsca na dane wynosi 10 MB (5 MB w Chrome w wersji 113 i starszych), ale można go zwiększyć, prosząc o uprawnienie "unlimitedStorage". Do przechowywania większych ilości danych zalecamy używanie storage.local. Domyślnie jest ona udostępniana skryptom treści, ale można to zmienić, wywołując funkcję chrome.storage.local.setAccessLevel().

Zarządzane

Pamięć zarządzana jest przeznaczona tylko do odczytu w przypadku rozszerzeń zainstalowanych zgodnie z zasadami. Zarządzają nim administratorzy systemów przy użyciu zdefiniowanego przez dewelopera schematu i zasad firmy. Zasady są podobne do opcji, ale konfiguruje je administrator systemu, a nie użytkownik. Dzięki temu rozszerzenie może być wstępnie skonfigurowane dla wszystkich użytkowników w organizacji.

Domyślnie storage.managed jest udostępniana skryptom treści, ale można to zmienić, wywołując chrome.storage.managed.setAccessLevel(). Informacje o zasadach znajdziesz w dokumentacji dla administratorów. Więcej informacji o obszarze pamięci managed znajdziesz w artykule Manifest dla obszarów pamięci.

Sesja

Pamięć sesji przechowuje dane w pamięci, gdy rozszerzenie jest wczytane. Pamięć jest czyszczona, gdy rozszerzenie jest wyłączane, ponownie ładowane lub aktualizowane oraz gdy przeglądarka jest ponownie uruchamiana. Domyślnie nie jest ona udostępniana skryptom treści, ale można to zmienić, wywołując funkcję chrome.storage.session.setAccessLevel(). Limit miejsca na dane wynosi 10 MB (1 MB w Chrome 111 i starszych wersjach).

Interfejsstorage.session jest jednym z kilku zalecanych przez nas w przypadku skryptów service worker.

Synchronizacja

Jeśli użytkownik włączy synchronizację, dane będą synchronizowane z każdą przeglądarką Chrome, w której jest zalogowany. Jeśli jest wyłączona, działa jak storage.local. Gdy przeglądarka jest offline, Chrome zapisuje dane lokalnie i wznawia synchronizację po ponownym połączeniu z internetem. Limit wynosi około 100 KB, czyli 8 KB na element.

Zalecamy używanie storage.sync, aby zachować ustawienia użytkownika w synchronizowanych przeglądarkach. Jeśli pracujesz z poufnych danymi użytkownika, użyj storage.session. Domyślnie storage.sync jest udostępniana skryptom treści, ale można to zmienić, wywołując chrome.storage.sync.setAccessLevel().

Metody i zdarzenia

Wszystkie obszary pamięci implementują interfejs StorageArea.

get()

Metoda get() umożliwia odczytanie co najmniej 1 klucza z StorageArea.

getBytesInUse()

Metoda getBytesInUse() umożliwia sprawdzenie limitu wykorzystanego przez StorageArea.

getKeys()

Metoda getKeys() umożliwia pobranie wszystkich kluczy przechowywanych w StorageArea.

remove()

Metoda remove() umożliwia usunięcie elementu z StorageArea.

set()

Metoda set() pozwala ustawić element w StorageArea.

setAccessLevel()

Metoda setAccessLevel() pozwala kontrolować dostęp do StorageArea.

clear()

Metoda clear() pozwala wyczyścić wszystkie dane z StorageArea.

onChanged

Zdarzenie onChanged umożliwia monitorowanie zmian w StorageArea.

Przypadki użycia

W sekcjach poniżej znajdziesz typowe przypadki użycia interfejsu Storage API.

Reagowanie na aktualizacje miejsca na dane

Aby śledzić zmiany wprowadzone w pamięci, dodaj detektor do zdarzenia onChanged. Gdy w pamięci zmieni się cokolwiek, to zdarzenie zostanie wywołane. Przykładowy kod nasłuchuje tych zmian:

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}".`
    );
  }
});

Możemy pójść o krok dalej. W tym przykładzie mamy stronę opcji, która umożliwia użytkownikowi włączenie i wyłączenie „trybu debugowania” (implementacja nie jest tu pokazana). Strona opcji natychmiast zapisuje nowe ustawienia w storage.sync, a service worker używa storage.onChanged, aby jak najszybciej zastosować ustawienie.

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);
  }
});

Asynchroniczne wstępne wczytywanie z pamięci

Ponieważ skrypty service worker nie działają cały czas, rozszerzenia w wersji Manifest V3 czasami muszą asynchronicznie wczytywać dane z pamięci, zanim wykonają swoje procedury obsługi zdarzeń. W tym celu poniższy fragment kodu używa asynchronicznego modułu obsługi zdarzeń action.onClicked, który czeka na wypełnienie obiektu globalnego storageCache, zanim wykona swoją logikę.

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);
});

Narzędzia deweloperskie

Dane przechowywane za pomocą interfejsu API możesz wyświetlać i edytować w Narzędziach deweloperskich. Więcej informacji znajdziesz na stronie Wyświetlanie i edytowanie pamięci rozszerzenia w dokumentacji Narzędzi deweloperskich.

Typy

AccessLevel

Chrome 102 lub nowsza

Poziom dostępu do obszaru pamięci.

Typ wyliczeniowy

„TRUSTED_CONTEXTS”
Określa konteksty pochodzące z samego rozszerzenia.

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
Określa konteksty pochodzące spoza rozszerzenia.

StorageChange

Właściwości

newValue

dowolny opcjonalny

Nowa wartość elementu, jeśli taka istnieje.
oldValue

dowolny opcjonalny

Stara wartość produktu, jeśli taka istniała.

Właściwości

local

Elementy w obszarze pamięci local są lokalne dla każdego urządzenia.

Typ

StorageArea i obiekt

Właściwości

QUOTA_BYTES

10485760

Maksymalna ilość danych (w bajtach), które można przechowywać w pamięci lokalnej, mierzona za pomocą serializacji JSON każdej wartości oraz długości każdego klucza. Ta wartość zostanie zignorowana, jeśli rozszerzenie ma uprawnienie unlimitedStorage. Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, jeśli używasz wywołania zwrotnego, lub odrzuconą obietnicę, jeśli używasz funkcji async/await.

managed

Elementy w obszarze pamięci managed są ustawiane przez zasady firmy skonfigurowane przez administratora domeny i są tylko do odczytu dla rozszerzenia. Próba zmodyfikowania tej przestrzeni nazw powoduje błąd. Informacje o konfigurowaniu zasad znajdziesz w artykule Manifest obszarów pamięci.

Typ

StorageArea

session

Chrome 102 lub nowszy MV3 lub nowszy

Elementy w obszarze pamięci session są przechowywane w pamięci i nie są zapisywane na dysku.

Typ

StorageArea i obiekt

Właściwości

QUOTA_BYTES

10485760

Maksymalna ilość danych (w bajtach), które można przechowywać w pamięci. Jest ona mierzona na podstawie szacunkowego wykorzystania pamięci przydzielanej dynamicznie dla każdej wartości i każdego klucza. Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używany jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.

sync

Elementy w obszarze pamięci sync są synchronizowane za pomocą Synchronizacji Chrome.

Typ

StorageArea i obiekt

Właściwości

MAX_ITEMS

512

Maksymalna liczba elementów, które można przechowywać w pamięci synchronizacji. Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używany jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.
MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

1000000

Wycofano

Interfejs storage.sync API nie ma już limitu trwałej operacji zapisu.
MAX_WRITE_OPERATIONS_PER_HOUR

1800

Maksymalna liczba operacji set, remove lub clear, które można wykonać w ciągu godziny. Jest to 1 na 2 sekundy, czyli niższy limit niż krótkoterminowy limit większej liczby zapisów na minutę.

Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używany jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.
MAX_WRITE_OPERATIONS_PER_MINUTE

120

Maksymalna liczba operacji set, remove lub clear, które można wykonać w ciągu minuty. Wynosi ona 2 operacje na sekundę, co zapewnia większą przepustowość niż operacje zapisu na godzinę w krótszym okresie.

Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używany jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.
QUOTA_BYTES

102400

Maksymalna łączna ilość danych (w bajtach), które można przechowywać w pamięci synchronizacji. Jest ona mierzona na podstawie serializacji JSON każdej wartości oraz długości każdego klucza. Aktualizacje, które spowodowałyby przekroczenie tego limitu, natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używany jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.
QUOTA_BYTES_PER_ITEM

8192

Maksymalny rozmiar (w bajtach) każdego elementu w pamięci synchronizacji, mierzony jako ciąg znaków JSON reprezentujący jego wartość plus długość klucza. Aktualizacje zawierające elementy większe niż ten limit natychmiast się nie powiodą i ustawią wartość runtime.lastError, gdy używane jest wywołanie zwrotne lub gdy obietnica zostanie odrzucona.

Wydarzenia

onChanged

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

Wywoływane, gdy zmieni się co najmniej 1 element.

Parametry

callback

funkcja

Parametr callback wygląda tak:
```
(changes: object, areaName: string) => void
```
- poniższych zmian
  
  obiekt
- areaName
  
  ciąg znaków

chrome.storage Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Opis

Uprawnienia

Przykłady

Przykład (lokalny)

Przykład (synchronizacja)

Przykład (sesja)

Pojęcia i zastosowanie

Czy rozszerzenia mogą korzystać z interfejsów Web Storage API?

Limity miejsca na dane i ograniczania

Obszary przechowywania

Lokalne

Zarządzane

Sesja

Synchronizacja

Metody i zdarzenia

get()

getBytesInUse()

getKeys()

remove()

set()

setAccessLevel()

clear()

onChanged

Przypadki użycia

Reagowanie na aktualizacje miejsca na dane

Asynchroniczne wstępne wczytywanie z pamięci

Narzędzia deweloperskie

Typy

AccessLevel

Typ wyliczeniowy

StorageChange

Właściwości

Właściwości

local

Typ

Właściwości

managed

Typ

session

Typ

Właściwości

sync

Typ

Właściwości

Wydarzenia

onChanged

Parametry

chrome.storage