chrome.storage

Deskripsi

Gunakan chrome.storage API untuk menyimpan, mengambil, dan melacak perubahan pada data pengguna.

Izin

storage

Untuk menggunakan storage API, deklarasikan izin "storage" di manifes ekstensi. Contoh:

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

Konsep dan penggunaan

Storage API menyediakan cara khusus ekstensi untuk mempertahankan data dan status pengguna. API ini mirip dengan API penyimpanan platform web (IndexedDB, dan Storage), tetapi dirancang untuk memenuhi kebutuhan penyimpanan ekstensi. Berikut adalah beberapa fitur utamanya:

  • Semua konteks ekstensi, termasuk pekerja layanan ekstensi dan skrip konten memiliki akses ke Storage API.
  • Nilai JSON yang dapat diserialisasi disimpan sebagai properti objek.
  • Storage API bersifat asinkron dengan operasi baca dan tulis massal.
  • Meskipun pengguna menghapus cache dan histori penjelajahan, data akan tetap ada.
  • Setelan yang disimpan akan tetap ada meskipun menggunakan mode Samaran terpisah.
  • Menyertakan area penyimpanan terkelola eksklusif hanya baca untuk kebijakan perusahaan.

Dapatkah ekstensi menggunakan API penyimpanan web?

Meskipun ekstensi dapat menggunakan antarmuka Storage (dapat diakses dari window.localStorage) dalam beberapa konteks (popup dan halaman HTML lainnya), sebaiknya jangan gunakan antarmuka ini karena alasan berikut:

  • Service worker ekstensi tidak dapat menggunakan Web Storage API.
  • Skrip konten berbagi penyimpanan dengan halaman host.
  • Data yang disimpan menggunakan Web Storage API akan hilang saat pengguna menghapus histori penjelajahan mereka.

Untuk memindahkan data dari API penyimpanan web ke API penyimpanan ekstensi dari pekerja layanan:

  1. Siapkan halaman html dokumen di balik layar dan file skrip. File skrip harus berisi rutinitas konversi dan pengendali onMessage.
  2. Di pekerja layanan ekstensi, periksa chrome.storage untuk data Anda.
  3. Jika data Anda tidak ditemukan, panggil createDocument().
  4. Setelah Promise yang ditampilkan diselesaikan, panggil sendMessage() untuk memulai rutinitas konversi.
  5. Di dalam pengendali onMessage dokumen di balik layar, panggil rutinitas konversi.

Ada juga beberapa nuansa tentang cara kerja API penyimpanan web di ekstensi. Pelajari lebih lanjut di artikel Penyimpanan dan Cookie.

Area penyimpanan

Storage API dibagi menjadi area penyimpanan berikut:

storage.local
Data disimpan secara lokal dan dihapus saat ekstensi dihapus. Batas penyimpanan adalah 10 MB (5 MB di Chrome 113 dan yang lebih lama), tetapi dapat ditingkatkan dengan meminta izin "unlimitedStorage". Sebaiknya gunakan storage.local untuk menyimpan data dalam jumlah yang lebih besar.
storage.managed
Penyimpanan terkelola adalah penyimpanan hanya baca untuk ekstensi yang diinstal kebijakan dan dikelola oleh administrator sistem menggunakan skema yang ditentukan developer dan kebijakan perusahaan. Kebijakan serupa dengan opsi, tetapi dikonfigurasi oleh administrator sistem, bukan pengguna, sehingga ekstensi dapat dikonfigurasi sebelumnya untuk semua pengguna organisasi. Untuk informasi tentang kebijakan, lihat Dokumentasi untuk Administrator. Untuk mempelajari area penyimpanan managed lebih lanjut, lihat Manifes untuk area penyimpanan.
storage.session
Menyimpan data dalam memori selama durasi sesi browser. Secara default, ini tidak diekspos ke skrip konten, tetapi perilaku ini dapat diubah dengan menetapkan chrome.storage.session.setAccessLevel(). Batas penyimpanan adalah 10 MB (1 MB di Chrome 111 dan yang lebih lama). Antarmukastorage.session adalah salah satu dari beberapa yang kami rekomendasikan untuk pekerja layanan.
storage.sync
Jika sinkronisasi diaktifkan, data akan disinkronkan ke browser Chrome yang digunakan pengguna untuk login. Jika dinonaktifkan, perilakunya akan seperti storage.local. Chrome menyimpan data secara lokal saat browser offline dan melanjutkan sinkronisasi saat kembali online. Batasan kuota adalah sekitar 100 KB, 8 KB per item. Sebaiknya gunakan storage.sync untuk mempertahankan setelan pengguna di seluruh browser yang disinkronkan. Jika Anda menangani data pengguna yang sensitif, gunakan storage.session sebagai gantinya.

Batas penyimpanan dan throttling

Storage API memiliki batasan penggunaan berikut:

  • Menyimpan data sering kali disertai dengan biaya performa, dan API menyertakan kuota penyimpanan. Sebaiknya berhati-hatilah dengan data yang Anda simpan agar Anda tidak kehilangan kemampuan untuk menyimpan data.
  • Penyimpanan dapat memerlukan waktu untuk diselesaikan. Pastikan untuk menyusun kode Anda agar memperhitungkan waktu tersebut.

Untuk mengetahui detail tentang batasan area penyimpanan dan hal yang akan terjadi jika batasan tersebut terlampaui, lihat informasi kuota untuk sync, local, dan session.

Kasus penggunaan

Bagian berikut menunjukkan kasus penggunaan umum untuk Storage API.

Respons sinkron terhadap pembaruan penyimpanan

Untuk melacak perubahan yang dilakukan pada penyimpanan, tambahkan pemroses ke peristiwa onChanged-nya. Saat ada perubahan di penyimpanan, peristiwa tersebut akan diaktifkan. Kode contoh mendeteksi perubahan ini:

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

Kita dapat mengembangkan ide ini lebih jauh lagi. Dalam contoh ini, kita memiliki halaman opsi yang memungkinkan pengguna mengalihkan "mode debug" (penerapan tidak ditampilkan di sini). Halaman opsi segera menyimpan setelan baru ke storage.sync, dan pekerja layanan menggunakan storage.onChanged untuk menerapkan setelan sesegera mungkin.

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

Pemuatan data secara asinkron dari penyimpanan

Karena pekerja layanan tidak selalu berjalan, ekstensi Manifest V3 terkadang perlu memuat data secara asinkron dari penyimpanan sebelum mengeksekusi pengendali peristiwanya. Untuk melakukannya, cuplikan berikut menggunakan pengendali peristiwa action.onClicked asinkron yang menunggu storageCache global diisi sebelum menjalankan logikanya.

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

Contoh

Contoh berikut menunjukkan area penyimpanan local, sync, dan session:

Lokal

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

Sinkronisasi

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

Sesi

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

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

Untuk melihat demo Storage API lainnya, jelajahi salah satu contoh berikut:

Jenis

AccessLevel

Chrome 102+

Tingkat akses area penyimpanan.

Enum

"TRUSTED_CONTEXTS"
Menentukan konteks yang berasal dari ekstensi itu sendiri.

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
Menentukan konteks yang berasal dari luar ekstensi.

StorageArea

Properti

  • onChanged

    Peristiwa<functionvoidvoid>

    Chrome 73+

    Diaktifkan saat satu atau beberapa item berubah.

    Fungsi onChanged.addListener terlihat seperti: 

    (callback: function) => {...}

    • callback

      fungsi

      Parameter callback terlihat seperti: 

      (changes: object) => void

      • perubahan

        objek

  • hapus

    void

    Promise

    Menghapus semua item dari penyimpanan.

    Fungsi clear terlihat seperti: 

    (callback?: function) => {...}

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      () => void

    • akan menampilkan

      Promise<void>

      Chrome 88+

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • get

    void

    Promise

    Mendapatkan satu atau beberapa item dari penyimpanan.

    Fungsi get terlihat seperti: 

    (keys?: string | string[] | object, callback?: function) => {...}

    • kunci

      string | string[] | object opsional

      Satu kunci yang akan diambil, daftar kunci yang akan diambil, atau kamus yang menentukan nilai default (lihat deskripsi objek). Daftar atau objek kosong akan menampilkan objek hasil kosong. Teruskan null untuk mendapatkan seluruh konten penyimpanan.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      (items: object) => void

      • item

        objek

        Objek dengan item dalam pemetaan nilai kuncinya.

    • akan menampilkan

      Promise<object>

      Chrome 88+

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • getBytesInUse

    void

    Promise

    Mendapatkan jumlah ruang (dalam byte) yang digunakan oleh satu atau beberapa item.

    Fungsi getBytesInUse terlihat seperti: 

    (keys?: string | string[], callback?: function) => {...}

    • kunci

      string | string[] opsional

      Satu kunci atau daftar kunci untuk mendapatkan total penggunaan. Daftar kosong akan menampilkan 0. Teruskan null untuk mendapatkan total penggunaan semua penyimpanan.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      (bytesInUse: number) => void

      • bytesInUse

        angka

        Jumlah ruang yang digunakan dalam penyimpanan, dalam byte.

    • akan menampilkan

      Promise<number>

      Chrome 88+

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • getKeys

    void

    Promise Chrome 130+

    Mendapatkan semua kunci dari penyimpanan.

    Fungsi getKeys terlihat seperti: 

    (callback?: function) => {...}

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      (keys: string[]) => void

      • kunci

        string[]

        Array dengan kunci yang dibaca dari penyimpanan.

    • akan menampilkan

      Promise<string[]>

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • hapus

    void

    Promise

    Menghapus satu atau beberapa item dari penyimpanan.

    Fungsi remove terlihat seperti: 

    (keys: string | string[], callback?: function) => {...}

    • kunci

      string | string[]

      Satu kunci atau daftar kunci untuk item yang akan dihapus.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      () => void

    • akan menampilkan

      Promise<void>

      Chrome 88+

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • set

    void

    Promise

    Menetapkan beberapa item.

    Fungsi set terlihat seperti: 

    (items: object, callback?: function) => {...}

    • item

      objek

      Objek yang memberikan setiap pasangan nilai kunci untuk memperbarui penyimpanan. Pasangan nilai kunci lainnya dalam penyimpanan tidak akan terpengaruh.

      Nilai primitif seperti angka akan diserialisasi seperti yang diharapkan. Nilai dengan typeof "object" dan "function" biasanya akan diserialisasi ke {}, dengan pengecualian Array (diserialisasi seperti yang diharapkan), Date, dan Regex (diserialisasi menggunakan representasi String-nya).

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      () => void

    • akan menampilkan

      Promise<void>

      Chrome 88+

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

  • setAccessLevel

    void

    Promise Chrome 102+

    Menetapkan tingkat akses yang diinginkan untuk area penyimpanan. Secara default, hanya konteks tepercaya yang akan digunakan.

    Fungsi setAccessLevel terlihat seperti: 

    (accessOptions: object, callback?: function) => {...}

    • accessOptions

      objek

      • accessLevel

        AccessLevel

        Tingkat akses area penyimpanan.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      () => void

    • akan menampilkan

      Promise<void>

      Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

StorageChange

Properti

  • newValue

    apa pun opsional

    Nilai baru item, jika ada nilai baru.

  • oldValue

    apa pun opsional

    Nilai lama item, jika ada nilai lama.

Properti

local

Item di area penyimpanan local bersifat lokal untuk setiap mesin.

Jenis

StorageArea & objek

Properti

  • QUOTA_BYTES

    10485760

    Jumlah maksimum (dalam byte) data yang dapat disimpan di penyimpanan lokal, seperti yang diukur dengan stringifikasi JSON dari setiap nilai ditambah panjang setiap kunci. Nilai ini akan diabaikan jika ekstensi memiliki izin unlimitedStorage. Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau Promise yang ditolak jika menggunakan asinkron/menunggu.

managed

Item di area penyimpanan managed ditetapkan oleh kebijakan perusahaan yang dikonfigurasi oleh administrator domain, dan bersifat hanya baca untuk ekstensi; mencoba mengubah namespace ini akan menyebabkan error. Untuk informasi tentang cara mengonfigurasi kebijakan, lihat Manifes untuk area penyimpanan.

Jenis

StorageArea

session

Chrome 102+ MV3+

Item di area penyimpanan session disimpan dalam memori dan tidak akan dipertahankan ke disk.

Jenis

StorageArea & objek

Properti

  • QUOTA_BYTES

    10485760

    Jumlah maksimum (dalam byte) data yang dapat disimpan dalam memori, seperti yang diukur dengan memperkirakan penggunaan memori yang dialokasikan secara dinamis dari setiap nilai dan kunci. Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

sync

Item di area penyimpanan sync disinkronkan menggunakan Sinkronisasi Chrome.

Jenis

StorageArea & objek

Properti

  • MAX_ITEMS

    512

    Jumlah maksimum item yang dapat disimpan di penyimpanan sinkronisasi. Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

  • MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

    1000000

    Tidak digunakan lagi

    storage.sync API tidak lagi memiliki kuota operasi tulis yang berkelanjutan.

  • MAX_WRITE_OPERATIONS_PER_HOUR

    1800

    Jumlah maksimum operasi set, remove, atau clear yang dapat dilakukan setiap jam. Batas ini adalah 1 setiap 2 detik, batas yang lebih rendah daripada batas operasi tulis per menit yang lebih tinggi dalam jangka pendek.

    Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

  • MAX_WRITE_OPERATIONS_PER_MINUTE

    120

    Jumlah maksimum operasi set, remove, atau clear yang dapat dilakukan setiap menit. Nilai ini adalah 2 per detik, yang memberikan throughput yang lebih tinggi daripada operasi tulis per jam selama jangka waktu yang lebih singkat.

    Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

  • QUOTA_BYTES

    102400

    Jumlah total maksimum (dalam byte) data yang dapat disimpan di penyimpanan sinkronisasi, seperti yang diukur dengan stringifikasi JSON dari setiap nilai ditambah panjang setiap kunci. Update yang akan menyebabkan batas ini terlampaui akan segera gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

  • QUOTA_BYTES_PER_ITEM

    8192

    Ukuran maksimum (dalam byte) setiap item dalam penyimpanan sinkronisasi, seperti yang diukur dengan stringifikasi JSON nilainya ditambah panjang kuncinya. Update yang berisi item yang lebih besar dari batas ini akan langsung gagal dan menetapkan runtime.lastError saat menggunakan callback, atau saat Promise ditolak.

Acara

onChanged

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

Diaktifkan saat satu atau beberapa item berubah.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

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

    • perubahan

      objek

    • areaName

      string