chrome.storage

Description

Autorisations

Pour utiliser l'API Storage, déclarez l'autorisation "storage" dans le fichier manifeste de l'extension. Exemple :

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

Exemples

Les exemples suivants illustrent les zones de stockage local, sync et session :

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

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

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

Pour voir d'autres démonstrations de l'API Storage, explorez l'un des exemples suivants :

• Extension de recherche mondiale
• Extension d'alarme d'eau :

Concepts et utilisation

L'API Storage fournit un moyen spécifique aux extensions de rendre persistantes les données et l'état des utilisateurs. Elle est semblable aux API de stockage de la plate-forme Web (IndexedDB et Storage), mais a été conçue pour répondre aux besoins de stockage des extensions. Voici quelques-unes des principales fonctionnalités :

• Tous les contextes d'extension, y compris le service worker et les scripts de contenu de l'extension, ont accès à l'API Storage.
• Les valeurs sérialisables JSON sont stockées en tant que propriétés d'objet.
• L'API Storage est asynchrone et permet d'effectuer des opérations de lecture et d'écriture groupées.
• Même si l'utilisateur vide le cache et efface l'historique de navigation, les données persistent.
• Les paramètres stockés sont conservés même lorsque vous utilisez la navigation privée fractionnée.
• Inclut un espace de stockage géré exclusif en lecture seule pour les règles d'entreprise.

Les extensions peuvent-elles utiliser les API Web Storage ?

Bien que les extensions puissent utiliser l'interface Storage (accessible depuis window.localStorage) dans certains contextes (pop-up et autres pages HTML), nous ne le recommandons pas pour les raisons suivantes :

• Les service workers d'extension ne peuvent pas utiliser l'API Web Storage.
• Les scripts de contenu partagent l'espace de stockage avec la page hôte.
• Les données enregistrées à l'aide de l'API Web Storage sont perdues lorsque l'utilisateur efface son historique de navigation.

Pour déplacer des données des API de stockage Web vers les API de stockage d'extension à partir d'un service worker :

1. Préparez une page HTML et un fichier de script pour le document hors écran. Le fichier de script doit contenir une routine de conversion et un gestionnaire onMessage.
2. Dans le service worker de l'extension, recherchez vos données dans chrome.storage.
3. Si vos données ne sont pas trouvées, appelez createDocument().
4. Une fois la promesse renvoyée résolue, appelez sendMessage() pour démarrer la routine de conversion.
5. Dans le gestionnaire onMessage du document hors écran, appelez la routine de conversion.

Il existe également certaines nuances concernant le fonctionnement des API de stockage Web dans les extensions. Pour en savoir plus, consultez l'article Stockage et cookies.

Limites de stockage et de limitation du débit

L'API Storage est soumise à des limites d'utilisation :

• Le stockage des données a un coût en termes de performances, et l'API inclut des quotas de stockage. Planifiez les données que vous souhaitez stocker afin de conserver de l'espace de stockage.
• Le stockage peut prendre un certain temps. Structurez votre code pour tenir compte de ce délai.

Pour en savoir plus sur les limites de l'espace de stockage et sur ce qui se passe lorsqu'elles sont dépassées, consultez les informations sur les quotas pour sync, local et session.

Zones de stockage

L'API Storage est divisée en zones de stockage suivantes :

Local

Les données sont stockées localement et effacées lorsque l'extension est supprimée. La limite de stockage est de 10 Mo (5 Mo dans Chrome 113 et versions antérieures), mais elle peut être augmentée en demandant l'autorisation "unlimitedStorage". Nous vous recommandons d'utiliser storage.local pour stocker de plus grandes quantités de données. Par défaut, il est exposé aux scripts de contenu, mais ce comportement peut être modifié en appelant chrome.storage.local.setAccessLevel().

Géré

Le stockage géré est en lecture seule pour les extensions installées par les règles. Il est géré par les administrateurs système à l'aide d'un schéma défini par le développeur et de règles d'entreprise. Les règles sont semblables aux options, mais elles sont configurées par un administrateur système, et non par l'utilisateur. Cela permet de préconfigurer l'extension pour tous les utilisateurs d'une organisation.

Par défaut, storage.managed est exposé aux scripts de contenu, mais ce comportement peut être modifié en appelant chrome.storage.managed.setAccessLevel(). Pour en savoir plus sur les règles, consultez la documentation destinée aux administrateurs. Pour en savoir plus sur la zone de stockage managed, consultez Manifeste pour les zones de stockage.

Session

Le stockage de session conserve les données en mémoire lorsqu'une extension est chargée. L'espace de stockage est effacé si l'extension est désactivée, rechargée ou mise à jour, et lorsque le navigateur redémarre. Par défaut, il n'est pas exposé aux scripts de contenu, mais ce comportement peut être modifié en appelant chrome.storage.session.setAccessLevel(). La limite de stockage est de 10 Mo (1 Mo dans Chrome 111 et versions antérieures).

L'interface storage.session est l'une des nombreuses interfaces que nous recommandons pour les service workers.

Synchroniser

Si l'utilisateur active la synchronisation, les données sont synchronisées avec tous les navigateurs Chrome auxquels il est connecté. Si elle est désactivée, elle se comporte comme storage.local. Chrome stocke les données localement lorsque le navigateur est hors connexion et reprend la synchronisation lorsqu'il est de nouveau en ligne. La limite de quota est d'environ 100 Ko, soit 8 Ko par élément.

Nous vous recommandons d'utiliser storage.sync pour conserver les paramètres utilisateur sur les navigateurs synchronisés. Si vous travaillez avec des données utilisateur sensibles, utilisez plutôt storage.session. Par défaut, storage.sync est exposé aux scripts de contenu, mais ce comportement peut être modifié en appelant chrome.storage.sync.setAccessLevel().

Méthodes et événements

Toutes les zones de stockage implémentent l'interface StorageArea.

get()

La méthode get() vous permet de lire une ou plusieurs clés à partir d'un StorageArea.

getBytesInUse()

La méthode getBytesInUse() vous permet de consulter le quota utilisé par un StorageArea.

getKeys()

La méthode getKeys() vous permet d'obtenir toutes les clés stockées dans un StorageArea.

remove()

La méthode remove() vous permet de supprimer un élément d'un StorageArea.

set()

La méthode set() vous permet de définir un élément dans un StorageArea.

setAccessLevel()

La méthode setAccessLevel() vous permet de contrôler l'accès à un StorageArea.

clear()

La méthode clear() vous permet d'effacer toutes les données d'un StorageArea.

onChanged

L'événement onChanged vous permet de surveiller les modifications apportées à un StorageArea.

Cas d'utilisation

Les sections suivantes présentent des cas d'utilisation courants de l'API Storage.

Répondre aux notifications concernant l'espace de stockage

Pour suivre les modifications apportées au stockage, ajoutez un écouteur à son événement onChanged. Cet événement se déclenche lorsque quelque chose change dans le stockage. L'exemple de code écoute les modifications suivantes :

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

Nous pouvons aller encore plus loin. Dans cet exemple, nous avons une page d'options qui permet à l'utilisateur d'activer ou de désactiver un "mode débogage" (l'implémentation n'est pas montrée ici). La page d'options enregistre immédiatement les nouveaux paramètres dans storage.sync, et le service worker utilise storage.onChanged pour appliquer le paramètre dès que possible.

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

Préchargement asynchrone depuis le stockage

Comme les service workers ne s'exécutent pas en permanence, les extensions Manifest V3 doivent parfois charger de manière asynchrone les données du stockage avant d'exécuter leurs gestionnaires d'événements. Pour ce faire, l'extrait de code suivant utilise un gestionnaire d'événements action.onClicked asynchrone qui attend que la variable globale storageCache soit renseignée avant d'exécuter sa logique.

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

Outils de développement

Vous pouvez afficher et modifier les données stockées à l'aide de l'API dans les outils de développement. Pour en savoir plus, consultez la page Afficher et modifier le stockage des extensions dans la documentation sur les outils de développement.

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