hộp công việc-broadcast-update

Khi phản hồi các yêu cầu bằng các mục nhập đã lưu vào bộ nhớ đệm, mặc dù tốc độ nhanh nhưng nó đi kèm với sự đánh đổi là người dùng có thể gặp phải dữ liệu lỗi thời.

Gói workbox-broadcast-update cung cấp cách thức tiêu chuẩn để thông báo cho Window Client về việc một phản hồi được lưu vào bộ nhớ đệm đã được cập nhật. Chiến lược này thường được dùng nhất cùng với chiến lược StaleWhileRevalidate.

Bất cứ khi nào bước "xác thực lại" của chiến lược đó truy xuất phản hồi từ mạng khác với phản hồi đã được lưu vào bộ nhớ đệm trước đó, mô-đun này sẽ gửi một thông báo (thông qua postMessage()) đến tất cả Ứng dụng cửa sổ trong phạm vi của trình chạy dịch vụ hiện tại.

Ứng dụng cửa sổ có thể theo dõi thông tin cập nhật và thực hiện hành động thích hợp, chẳng hạn như tự động hiển thị thông báo cho người dùng để cho họ biết rằng đã có bản cập nhật.

Các bản cập nhật được xác định như thế nào?

So sánh một số tiêu đề nhất định của đối tượng Response đã lưu vào bộ nhớ đệm và đối tượng mới, nếu bất kỳ tiêu đề nào có giá trị khác nhau, thì đó được coi là một bản cập nhật.

Theo mặc định, các tiêu đề Content-Length, ETag và Last-Modified sẽ được so sánh.

Workbox sử dụng các giá trị tiêu đề thay vì so sánh các nội dung phản hồi theo từng byte để đạt hiệu quả cao hơn, đặc biệt là đối với các phản hồi có thể lớn

Sử dụng bản cập nhật truyền phát

Bạn có thể dùng thư viện này cùng với chiến lược lưu vào bộ nhớ đệm StaleWhileRevalidate, vì chiến lược đó liên quan đến việc trả về ngay một phản hồi lưu vào bộ nhớ đệm, đồng thời cung cấp cơ chế cập nhật bộ nhớ đệm một cách không đồng bộ.

Để truyền tin cập nhật, bạn chỉ cần thêm broadcastUpdate.BroadcastUpdatePlugin vào các tuỳ chọn chiến lược.

import {registerRoute} from 'workbox-routing';
import {StaleWhileRevalidate} from 'workbox-strategies';
import {BroadcastUpdatePlugin} from 'workbox-broadcast-update';

registerRoute(
  ({url}) => url.pathname.startsWith('/api/'),
  new StaleWhileRevalidate({
    plugins: [new BroadcastUpdatePlugin()],
  })
);

Trong ứng dụng web, trước khi sự kiện DOMContentLoaded kích hoạt, bạn có thể theo dõi các sự kiện sau như sau:

navigator.serviceWorker.addEventListener('message', async event => {
  // Optional: ensure the message came from workbox-broadcast-update
  if (event.data.meta === 'workbox-broadcast-update') {
    const {cacheName, updatedURL} = event.data.payload;

    // Do something with cacheName and updatedURL.
    // For example, get the cached content and update
    // the content on the page.
    const cache = await caches.open(cacheName);
    const updatedResponse = await cache.match(updatedURL);
    const updatedText = await updatedResponse.text();
  }
});

Định dạng thư

Khi trình nghe sự kiện message được gọi trong ứng dụng web, thuộc tính event.data sẽ có định dạng sau:

{
  type: 'CACHE_UPDATED',
  meta: 'workbox-broadcast-update',
  // The two payload values vary depending on the actual update:
  payload: {
    cacheName: 'the-cache-name',
    updatedURL: 'https://example.com/'
  }
}

Tuỳ chỉnh tiêu đề để kiểm tra

Bạn có thể tuỳ chỉnh tiêu đề để kiểm tra bằng cách đặt thuộc tính headersToCheck.

import {registerRoute} from 'workbox-routing';
import {StaleWhileRevalidate} from 'workbox-strategies';
import {BroadcastUpdatePlugin} from 'workbox-broadcast-update';

registerRoute(
  ({url}) => url.pathname.startsWith('/api/'),
  new StaleWhileRevalidate({
    plugins: [
      new BroadcastUpdatePlugin({
        headersToCheck: ['X-My-Custom-Header'],
      }),
    ],
  })
);

Cách sử dụng nâng cao

Mặc dù hầu hết các nhà phát triển sẽ sử dụng workbox-broadcast-update làm trình bổ trợ của một chiến lược cụ thể như trình bày ở trên, nhưng bạn vẫn có thể sử dụng logic cơ bản trong mã trình chạy dịch vụ.

import {BroadcastCacheUpdate} from 'workbox-broadcast-update';

const broadcastUpdate = new BroadcastCacheUpdate({
  headersToCheck: ['X-My-Custom-Header'],
});

const cacheName = 'api-cache';
const request = new Request('https://example.com/api');

const cache = await caches.open(cacheName);
const oldResponse = await cache.match(request);
const newResponse = await fetch(request);

broadcastUpdate.notifyIfUpdated({
  cacheName,
  oldResponse,
  newResponse,
  request,
);

workbox-broadcast-update.responsesAreSame(
  firstResponse: Response,
  secondResponse: Response,
  headersToCheck: string[],
)