หน้านี้ได้รับการแปลโดย Cloud Translation API

chrome.storage

คำอธิบาย

ใช้ chrome.storage API เพื่อจัดเก็บ เรียก และติดตามการเปลี่ยนแปลงข้อมูลผู้ใช้

สิทธิ์

storage

ภาพรวม

Storage API มีวิธีเฉพาะส่วนขยายในการคงข้อมูลและสถานะของผู้ใช้ ซึ่งคล้ายกับ Storage API ของแพลตฟอร์มเว็บ (IndexedDB และ Storage) แต่ได้รับการออกแบบมาเพื่อตอบสนองความต้องการด้านพื้นที่เก็บข้อมูลของส่วนขยาย ฟีเจอร์หลักบางส่วนมีดังนี้

บริบทส่วนขยายทั้งหมด รวมถึง Service Worker ของส่วนขยายและสคริปต์เนื้อหามีสิทธิ์เข้าถึง Storage API
ค่าที่แปลงเป็น JSON ได้จะจัดเก็บเป็นพร็อพเพอร์ตี้ของออบเจ็กต์
Storage API เป็นแบบอะซิงโครนัสที่มีการอ่านและการเขียนแบบกลุ่ม
แม้ว่าผู้ใช้จะล้างแคชและประวัติการท่องเว็บแล้ว แต่ข้อมูลจะยังคงอยู่
การตั้งค่าที่จัดเก็บไว้จะยังคงอยู่แม้จะใช้โหมดไม่ระบุตัวตนแบบแยกก็ตาม
มีพื้นที่เก็บข้อมูลที่มีการจัดการแบบอ่านอย่างเดียวเฉพาะสำหรับนโยบายขององค์กร

แม้ว่าส่วนขยายจะใช้อินเทอร์เฟซ [Storage][mdn-storage] (เข้าถึงได้จาก window.localStorage) ในบางบริบท (ป๊อปอัปและหน้า HTML อื่นๆ) ได้ แต่เราไม่แนะนำให้ใช้ด้วยเหตุผลต่อไปนี้

Service Worker ของส่วนขยายเข้าถึง Storage ไม่ได้
สคริปต์เนื้อหาจะแชร์พื้นที่เก็บข้อมูลกับหน้าโฮสต์
ข้อมูลที่บันทึกโดยใช้Storageจะหายไปเมื่อผู้ใช้ล้างประวัติการท่องเว็บ

วิธีย้ายข้อมูลจาก Web Storage API ไปยัง Extension Storage API จาก Service Worker

สร้างเอกสารนอกหน้าจอด้วยกิจวัตรการแปลงและตัวแฮนเดิล [onMessage][on-message]
เพิ่มกิจวัตรการแปลงลงในเอกสารนอกหน้าจอ
ใน Service Worker ของส่วนขยาย ให้ตรวจสอบ chrome.storage สำหรับข้อมูลของคุณ
หากไม่พบข้อมูล ให้[สร้าง][create-offscreen] เอกสารนอกหน้าจอและเรียกใช้ [sendMessage()][send-message] เพื่อเริ่มกิจวัตรการแปลง
ภายในแฮนเดิลอร์ onMessage ของเอกสารนอกหน้าจอ ให้เรียกใช้กิจวัตรการแปลง

นอกจากนี้ ยังมีรายละเอียดบางอย่างเกี่ยวกับวิธีการทำงานของ Web Storage API ในส่วนขยายด้วย ดูข้อมูลเพิ่มเติมได้ในบทความ[พื้นที่เก็บข้อมูลและคุกกี้][storage-and-cookies]

พื้นที่เก็บข้อมูล

Storage API แบ่งออกเป็น 4 กลุ่ม ("พื้นที่เก็บข้อมูล") ดังนี้

storage.local: ระบบจะจัดเก็บข้อมูลไว้ในเครื่องและล้างข้อมูลเมื่อนำส่วนขยายออก โควต้าที่จำกัดมีขนาดประมาณ 10 MB แต่สามารถเพิ่มได้โดยขอ"unlimitedStorage"สิทธิ์ โปรดพิจารณาใช้เพื่อจัดเก็บข้อมูลจำนวนมากขึ้น

storage.sync: หากเปิดใช้การซิงค์ไว้ ระบบจะซิงค์ข้อมูลกับเบราว์เซอร์ Chrome ที่ผู้ใช้เข้าสู่ระบบ หากปิดใช้ ลักษณะการทำงานจะเป็นเหมือน storage.local Chrome จะจัดเก็บข้อมูลไว้ในเครื่องเมื่อเบราว์เซอร์ออฟไลน์ และจะกลับมาซิงค์อีกครั้งเมื่อเบราว์เซอร์กลับมาออนไลน์ โควต้าที่จำกัดคือประมาณ 100 KB หรือ 8 KB ต่อรายการ โปรดพิจารณาใช้เพื่อรักษาการตั้งค่าของผู้ใช้ในเบราว์เซอร์ที่ซิงค์

คำเตือน: พื้นที่เก็บข้อมูลในเครื่องและพื้นที่เก็บข้อมูลที่ซิงค์ไม่ควรจัดเก็บข้อมูลผู้ใช้ที่เป็นความลับเนื่องจากไม่ได้เข้ารหัส เมื่อทำงานกับข้อมูลที่ละเอียดอ่อน ให้พิจารณาใช้sessionพื้นที่เก็บข้อมูลเพื่อเก็บค่าไว้ในหน่วยความจำจนกว่าจะปิดเบราว์เซอร์

storage.session: เก็บข้อมูลไว้ในหน่วยความจำตลอดระยะเวลาของเซสชันเบราว์เซอร์ โดยค่าเริ่มต้น ระบบจะไม่แสดงต่อสคริปต์เนื้อหา แต่คุณเปลี่ยนลักษณะการทำงานนี้ได้โดยการตั้งค่า chrome.storage.session.setAccessLevel() โควต้าจะจำกัดอยู่ที่ประมาณ 10 MB ลองใช้เพื่อจัดเก็บตัวแปรร่วมในการเรียกใช้ Service Worker

storage.managed: ผู้ดูแลระบบสามารถใช้สคีมาและนโยบายระดับองค์กรเพื่อกำหนดค่าการตั้งค่าของส่วนขยายที่รองรับในสภาพแวดล้อมที่มีการจัดการ พื้นที่เก็บข้อมูลนี้เป็นแบบอ่านอย่างเดียว

ไฟล์ Manifest

หากต้องการใช้ Storage API ให้ประกาศสิทธิ์ "storage" ในไฟล์ Manifest ของส่วนขยาย เช่น

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

การใช้งาน

ตัวอย่างต่อไปนี้แสดงพื้นที่เก็บข้อมูล local, sync และ session

storage.local

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

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

storage.sync

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

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

storage.session

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

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับmanagedพื้นที่เก็บข้อมูลได้ที่ไฟล์ Manifest สำหรับพื้นที่เก็บข้อมูล

ขีดจำกัดของพื้นที่เก็บข้อมูลและการควบคุม

อย่าคิดว่าการเพิ่มลงใน Storage API เป็นการใส่สิ่งต่างๆ ลงในรถบรรทุกขนาดใหญ่ การเพิ่มข้อมูลลงใน ที่เก็บข้อมูลก็เหมือนกับการใส่สิ่งต่างๆ ลงในท่อ ท่ออาจมีวัสดุอยู่แล้วและอาจเต็มไปด้วยวัสดุ โปรดทราบว่าอาจมีความล่าช้าระหว่างเวลาที่คุณเพิ่มลงในพื้นที่เก็บข้อมูลกับเวลาที่ระบบ บันทึกจริง

ดูรายละเอียดเกี่ยวกับข้อจำกัดของพื้นที่เก็บข้อมูลและสิ่งที่เกิดขึ้นเมื่อใช้พื้นที่เก็บข้อมูลเกินโควต้าได้ในข้อมูลโควต้าสำหรับ sync, local และ session

กรณีการใช้งาน

ส่วนต่อไปนี้แสดง Use Case ทั่วไปสำหรับ Storage API

การตอบกลับแบบซิงโครนัสต่อการอัปเดตพื้นที่เก็บข้อมูล

หากต้องการติดตามการเปลี่ยนแปลงที่เกิดขึ้นกับพื้นที่เก็บข้อมูล คุณสามารถเพิ่ม Listener ลงในเหตุการณ์ onChanged ของพื้นที่เก็บข้อมูลได้ เมื่อมีการเปลี่ยนแปลงใดๆ ในพื้นที่เก็บข้อมูล ระบบจะทริกเกอร์เหตุการณ์นั้น โค้ดตัวอย่างจะรอการเปลี่ยนแปลงต่อไปนี้

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

เราสามารถนำแนวคิดนี้ไปใช้ได้ไกลกว่านั้น ในตัวอย่างนี้ เรามีหน้าตัวเลือกที่อนุญาตให้ผู้ใช้เปิด/ปิด "โหมดแก้ไขข้อบกพร่อง" (ไม่ได้แสดงการติดตั้งใช้งานที่นี่) หน้าตัวเลือกจะบันทึกการตั้งค่าใหม่ลงใน storage.sync ทันที และ Service Worker จะใช้ storage.sync เพื่อใช้การตั้งค่าโดยเร็วที่สุดstorage.onChanged

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

การโหลดล่วงหน้าแบบไม่พร้อมกันจากที่เก็บข้อมูล

เนื่องจาก Service Worker ไม่ได้ทำงานอยู่เสมอไป บางครั้งส่วนขยาย Manifest V3 จึงต้อง โหลดข้อมูลจากพื้นที่เก็บข้อมูลแบบไม่พร้อมกันก่อนที่จะเรียกใช้ตัวแฮนเดิลเหตุการณ์ โดย ข้อมูลโค้ดต่อไปนี้ใช้ตัวแฮนเดิลเหตุการณ์ action.onClicked แบบไม่พร้อมกันซึ่งรอให้ระบบป้อนข้อมูลstorageCache ส่วนกลางก่อนที่จะเรียกใช้ตรรกะ

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

ตัวอย่างส่วนขยาย

หากต้องการดูการสาธิตอื่นๆ ของ Storage API ให้ดูตัวอย่างต่อไปนี้

ประเภท

AccessLevel

Chrome 102 ขึ้นไป

ระดับการเข้าถึงพื้นที่เก็บข้อมูล

ค่าแจกแจง

"TRUSTED_CONTEXTS"
ระบุบริบทที่มาจากส่วนขยายเอง

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
ระบุบริบทที่มาจากภายนอกส่วนขยาย

StorageChange

พร็อพเพอร์ตี้

newValue

ไม่บังคับ

ค่าใหม่ของสินค้า หากมีค่าใหม่
oldValue

ไม่บังคับ

ค่าเดิมของสินค้า หากมีค่าเดิม

พร็อพเพอร์ตี้

local

รายการในพื้นที่เก็บข้อมูล local จะอยู่ในเครื่องแต่ละเครื่อง

ประเภท

StorageArea และออบเจ็กต์

พร็อพเพอร์ตี้

QUOTA_BYTES

10485760

จำนวนข้อมูลสูงสุด (เป็นไบต์) ที่จัดเก็บได้ในพื้นที่เก็บข้อมูลภายใน ซึ่งวัดจากสตริง JSON ของค่าทุกค่าบวกกับความยาวของคีย์ทุกคีย์ ระบบจะละเว้นค่านี้หากส่วนขยายมีunlimitedStorage permission การอัปเดตที่จะทำให้เกินขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับ หรือ Promise ที่ถูกปฏิเสธหากใช้ async/await

managed

รายการในmanagedพื้นที่เก็บข้อมูลจะได้รับการตั้งค่าโดยนโยบายขององค์กรที่กำหนดค่าโดยผู้ดูแลระบบโดเมน และเป็นแบบอ่านอย่างเดียวสำหรับส่วนขยาย การพยายามแก้ไขเนมสเปซนี้จะทำให้เกิดข้อผิดพลาด ดูข้อมูลเกี่ยวกับการกำหนดค่านโยบายได้ที่ไฟล์ Manifest สำหรับพื้นที่เก็บข้อมูล

ประเภท

StorageArea

sync

รายการในsyncพื้นที่เก็บข้อมูลจะซิงค์โดยใช้การซิงค์ของ Chrome

ประเภท

StorageArea และออบเจ็กต์

พร็อพเพอร์ตี้

MAX_ITEMS

512

จำนวนรายการสูงสุดที่จัดเก็บได้ในที่เก็บข้อมูลการซิงค์ การอัปเดตที่จะทำให้เกินขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับหรือเมื่อมีการปฏิเสธ Promise
MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

1000000

เลิกใช้งานแล้ว

API storage.sync ไม่มีโควต้าการดำเนินการเขียนที่ต่อเนื่องอีกต่อไป
MAX_WRITE_OPERATIONS_PER_HOUR

1800

จำนวนสูงสุดของโอเปอเรชัน set, remove หรือ clear ที่ดำเนินการได้ในแต่ละชั่วโมง ซึ่งเท่ากับ 1 ทุกๆ 2 วินาที ซึ่งเป็นขีดจำกัดที่ต่ำกว่าขีดจำกัดการเขียนต่อนาทีที่สูงกว่าในระยะสั้น

การอัปเดตที่จะทำให้เกินขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับ หรือเมื่อ Promise ถูกปฏิเสธ
MAX_WRITE_OPERATIONS_PER_MINUTE

120

จำนวนสูงสุดของการดำเนินการ set, remove หรือ clear ที่ทำได้ในแต่ละนาที ซึ่งเท่ากับ 2 รายการต่อวินาที ทำให้อัตราการส่งข้อมูลสูงกว่าการเขียนต่อชั่วโมงในช่วงเวลาที่สั้นกว่า

การอัปเดตที่จะทำให้เกินขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับ หรือเมื่อ Promise ถูกปฏิเสธ
QUOTA_BYTES

102400

จำนวนข้อมูลทั้งหมดสูงสุด (เป็นไบต์) ที่จัดเก็บได้ในที่เก็บข้อมูลการซิงค์ ซึ่งวัดโดยการแปลงค่าทุกค่าและคีย์ทุกคีย์เป็นสตริง JSON การอัปเดตที่จะทำให้เกินขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับ หรือเมื่อ Promise ถูกปฏิเสธ
QUOTA_BYTES_PER_ITEM

8192

ขนาดสูงสุด (เป็นไบต์) ของแต่ละรายการในที่เก็บข้อมูลการซิงค์ ซึ่งวัดโดยการแปลงค่าเป็นสตริง JSON บวกกับความยาวของคีย์ การอัปเดตที่มีรายการซึ่งมีขนาดใหญ่กว่าขีดจำกัดนี้จะล้มเหลวทันทีและตั้งค่า runtime.lastError เมื่อใช้การเรียกกลับหรือเมื่อมีการปฏิเสธ Promise

กิจกรรม

onChanged

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

ทริกเกอร์เมื่อมีการเปลี่ยนแปลงรายการอย่างน้อย 1 รายการ

พารามิเตอร์

callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(changes: object, areaName: string) => void
```
- การเปลี่ยนแปลง
  
  ออบเจ็กต์
- areaName
  
  สตริง

chrome.storage จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

คำอธิบาย

สิทธิ์

ภาพรวม

พื้นที่เก็บข้อมูล

ไฟล์ Manifest

การใช้งาน

storage.local

storage.sync

storage.session

ขีดจำกัดของพื้นที่เก็บข้อมูลและการควบคุม

กรณีการใช้งาน

การตอบกลับแบบซิงโครนัสต่อการอัปเดตพื้นที่เก็บข้อมูล

การโหลดล่วงหน้าแบบไม่พร้อมกันจากที่เก็บข้อมูล

ตัวอย่างส่วนขยาย

ประเภท

AccessLevel

ค่าแจกแจง

StorageChange

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้

local

ประเภท

พร็อพเพอร์ตี้

managed

ประเภท

sync

ประเภท

พร็อพเพอร์ตี้

กิจกรรม

onChanged

พารามิเตอร์

chrome.storage