Now.js Framework Documentation
ServiceWorkerManager
ServiceWorkerManager
ภาพรวม
ServiceWorkerManager คือระบบจัดการ Service Worker ใน Now.js Framework รองรับ caching, offline support และ push notifications
ใช้เมื่อ:
- ต้องการ offline support
- ต้องการ cache static products
- ต้องการ push notifications
- ต้องการ background sync
ทำไมต้องใช้:
- ✅ Automatic caching
- ✅ Multiple caching strategies
- ✅ Push notification support
- ✅ Update management
- ✅ Precache configuration
การใช้งานพื้นฐาน
Initialization
await ServiceWorkerManager.init({
enabled: true,
serviceWorkerPath: '/service-worker.js',
cacheName: 'my-app-cache-v1',
debug: true
});With Push Notifications
await ServiceWorkerManager.init({
enabled: true,
push: {
enabled: true,
publicKey: 'YOUR_VAPID_PUBLIC_KEY'
}
});การตั้งค่า
ServiceWorkerManager.init({
// Enable/disable
enabled: true,
// Service worker file path
serviceWorkerPath: '/service-worker.js',
// Scope
scope: '/',
// Version for cache busting
version: '1.0.0',
// Cache name
cacheName: 'now-js-cache',
// Debug logging
debug: false,
// Update check interval (ms)
updateInterval: 24 * 60 * 60 * 1000, // 24 hours
// URLs to precache
precache: [
'/index.html',
'/css/styles.css',
'/js/app.js'
],
// ต่อ feature bundle ของ Now.js (Now.featureUrls()) ที่ยังไม่อยู่ใน cache ท้าย precache
// หน้าที่ต้องใช้ bundle จึงทำงานออฟไลน์ได้แม้ไม่เคยเปิดตอนออนไลน์ — false = ไม่ต่อ
precacheFeatures: true,
// Caching strategies by path
strategies: {
'/api/': 'network-first',
'/images/': 'cache-first',
'/static/': 'cache-only'
},
// วินาทีที่คำตอบ API ใน cache ยังแสดงตอนออฟไลน์ได้ (0 = ไม่จำกัด) — ค่าเริ่มต้น 86400
// เท่าอายุ access token: เก่ากว่านี้ไม่ถูกส่ง และถูกลบออกจาก cache
apiCacheMaxAge: 86400,
// Push notification config
push: {
enabled: false,
publicKey: null
}
});Caching Strategies
strategy ที่ service-worker.js ของแอปใช้ (กำหนดต่อ path ผ่าน strategies หรือเลือกเองตามลำดับข้างล่าง)
| Strategy | ทำอะไร |
|---|---|
cache-first |
ตอบจาก cache ก่อน ไม่มีจึงโหลดแล้วเก็บ · ไฟล์ที่ไม่มี ?v= โหลดตัวใหม่เก็บไว้เบื้องหลังสำหรับครั้งถัดไป · ไฟล์ที่ติด ?v= ไม่โหลดซ้ำจนกว่า ?v= จะเปลี่ยน |
network-first |
โหลดจาก network ก่อน ล้มจึงตอบจาก cache (หน้า HTML ที่ไม่มีใน cache ได้ app shell) — ชื่อ strategy อื่นที่ไม่รู้จักทำแบบนี้ |
network-only |
ไม่ผ่าน cache |
ลำดับที่ใช้เลือกเมื่อไม่ได้กำหนด: ไม่ใช่ GET / ข้าม origin / นอก scope / ตรง excludeFromCache / API ของการล็อกอิน → network-only ·
API อื่น → network-first · ตรง networkFirst → network-first · ตรง cachePatterns → cache-first · หน้า HTML → network-first
pattern (cachePatterns, networkFirst, excludeFromCache) เทียบกับ URL เต็ม และ URL ที่ตัด query ออก —
'\\.js$' จึงตรงกับ now.core.min.js?v=12 ด้วย
คำตอบ API (/api/) ที่เก็บไว้มีเงื่อนไขเพิ่ม เพราะเป็นข้อมูลของผู้ใช้ที่ล็อกอินอยู่:
คำตอบที่มี Cache-Control: no-store ไม่ถูกเก็บ · API ตอบ 401 → ลบคำตอบ API ที่เก็บไว้ทั้งหมด (ไฟล์อยู่ต่อ) ·
ตอนออฟไลน์คำตอบที่เก่ากว่า apiCacheMaxAge ไม่ถูกส่ง
API อ้างอิง
ServiceWorkerManager.init(options)
Initialize service worker
Returns: Promise<ServiceWorkerManager>
ServiceWorkerManager.isSupported()
ตรวจสอบว่าเบราว์เซอร์รองรับ Service Worker หรือไม่ ('serviceWorker' in navigator)
ใช้ตัวนี้ก่อนเรียก init() — ครอบคลุมเฉพาะการแคชเพื่อทำงานออฟไลน์
ไม่เกี่ยวกับ push notification
Returns: boolean
if (ServiceWorkerManager.isSupported()) {
await ServiceWorkerManager.init({ enabled: true });
}ServiceWorkerManager.isPushSupported()
ตรวจสอบว่าเบราว์เซอร์รองรับ Push Notification หรือไม่
('serviceWorker' in navigator && 'PushManager' in window)
ใช้ตัวนี้ก่อนเรียก subscribeToPush() ไม่ใช่ isSupported()
ทำไมต้องแยกกัน: iOS Safari รองรับ service worker มาตั้งแต่ 11.3 แต่เปิด
PushManagerให้เฉพาะตอนที่ติดตั้งเป็นเว็บแอป (เพิ่มลงหน้าโฮม) เท่านั้น
การเช็ครวมกันจึงคืนfalseกับผู้ใช้ iPhone ที่เปิดผ่านเบราว์เซอร์ตามปกติทุกคน
แล้วปิดการแคชออฟไลน์ให้เขาไปเงียบ ๆ — ทั้งที่เป็นกลุ่มผู้ใช้ที่แอปแบบ offline-first
ตั้งใจทำมาเพื่อพอดี เดิมisSupported()เช็คทั้งสองอย่างรวมกัน
แอปที่ใช้มันเป็นเงื่อนไขของinit()จึงจะเริ่มแคชบน iOS หลังอัปเกรด ซึ่งเป็นผลที่ตั้งใจ
Returns: boolean
if (ServiceWorkerManager.isPushSupported()) {
await ServiceWorkerManager.subscribeToPush(vapidPublicKey);
}ServiceWorkerManager.cacheUrls(urls)
Cache URLs ที่กำหนด
| Parameter | Type | Description |
|---|---|---|
urls |
array | Array of URLs |
Returns: Promise<boolean>
await ServiceWorkerManager.cacheUrls([
'/offline.html',
'/images/logo.png'
]);ServiceWorkerManager.clearCache()
ล้าง cache ทั้งหมด
Returns: Promise<boolean>
await ServiceWorkerManager.clearCache();ServiceWorkerManager.clearApiCache()
ทิ้งเฉพาะคำตอบ API ที่ service worker เก็บไว้ (ไฟล์และหน้ายังอยู่ แอปจึงยังเปิดออฟไลน์ได้)
AuthManager เรียกเมื่อโปรไฟล์ออฟไลน์เก่าเกิน offlineSessionMaxAge
Returns: Promise<boolean> — มี worker รับข้อความหรือไม่
ServiceWorkerManager.update()
Force update service worker
Returns: Promise<boolean>
await ServiceWorkerManager.update();ServiceWorkerManager.skipWaiting()
Force activate waiting worker
Returns: Promise<boolean>
await ServiceWorkerManager.skipWaiting();ServiceWorkerManager.isOfflineReady()
ตรวจสอบ offline readiness
Returns: boolean
Push Notifications
Subscribe
const subscription = await ServiceWorkerManager.subscribePush();
// Send subscription to server
await fetch('/api/push/subscribe', {
method: 'POST',
body: JSON.stringify(subscription)
});Unsubscribe
await ServiceWorkerManager.unsubscribePush();Check Status
if (ServiceWorkerManager.isPushEnabled()) {
console.log('Push enabled');
}เหตุการณ์
| Event | เมื่อเกิด | Detail |
|---|---|---|
serviceworker:registered |
ลงทะเบียน service worker สำเร็จ | {registration} |
serviceworker:unregistered |
ถอนการลงทะเบียน | ไม่มี |
serviceworker:update-found |
พบเวอร์ชันใหม่กำลังติดตั้ง | {registration} |
serviceworker:state-change |
สถานะ worker เปลี่ยน | {state, status} |
serviceworker:offline-ready |
แคชครบแล้ว ใช้งานออฟไลน์ได้ | ไม่มี |
serviceworker:message |
ได้ข้อความจาก service worker | data (ส่งตรง ไม่ห่อ) |
serviceworker:push-subscribed |
สมัครรับ push สำเร็จ | {subscription} |
serviceworker:push-unsubscribed |
ยกเลิกรับ push | ไม่มี |
serviceworker:error |
เกิดข้อผิดพลาด | errorInfo (ส่งตรง ไม่ห่อ) |
// Offline ready
EventManager.on('serviceworker:offline-ready', () => {
console.log('App ready for offline');
});
// Update available
EventManager.on('serviceworker:update-found', () => {
if (confirm('Update available. Reload?')) {
window.location.reload();
}
});ตัวอย่างการใช้งานจริง
Progressive Web App
// app.js
if ('serviceWorker' in navigator) {
await ServiceWorkerManager.init({
enabled: true,
cacheName: 'my-pwa-v1',
precache: [
'/',
'/manifest.json',
'/css/app.css',
'/js/app.js',
'/images/icons/icon-192.png'
],
strategies: {
'/api/': 'network-first',
'/images/': 'cache-first'
}
});
}With Push Notifications
await ServiceWorkerManager.init({
enabled: true,
push: {
enabled: true,
publicKey: process.env.VAPID_PUBLIC_KEY
}
});
// Subscribe button
document.getElementById('notify-btn').onclick = async () => {
const subscription = await ServiceWorkerManager.subscribePush();
await fetch('/api/push/register', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(subscription)
});
NotificationManager.success('Notifications enabled!');
};Update Prompt
EventManager.on('sw:update-available', () => {
const toast = NotificationManager.show({
message: 'New version available',
type: 'info',
duration: 0, // Persistent
actions: [
{
label: 'Update',
callback: () => {
ServiceWorkerManager.skipWaiting();
window.location.reload();
}
}
]
});
});Service Worker File
ใช้ service-worker.js ของ adminframework (ไฟล์เดียวกันทุกแอป วางไว้ที่ root ของแอป) — คุยกับ ServiceWorkerManager ด้วย
UPDATE_CONFIG, CACHE_URLS, CLEAR_CACHE, SKIP_WAITING และตอบ CONFIG_UPDATED, CACHE_UPDATED, OFFLINE_READY, LOG
- ชื่อ cache มาจาก scope (
now-js-cache@<scope>#v1) แอปที่อยู่ origin เดียวกันจึงไม่ลบ cache ของกัน - config ถูกเก็บไว้ใน cache — เบราว์เซอร์หยุด worker ที่ว่างแล้วเริ่มใหม่เมื่อมี request worker ที่เพิ่งเริ่มอ่าน config
กลับมาก่อนตอบ (เดิมไม่มี pattern จนกว่าหน้าจะส่งมาใหม่ เปิดแอปตอนออฟไลน์จึงโหลด script ไม่ได้) - precache โหลดเฉพาะที่ยังไม่มี — ทุกหน้าส่ง config มา เดิม worker โหลดทุกไฟล์ในรายการใหม่ทุกครั้งที่เปิดหน้า
- ไฟล์ที่ติด
?v=ไม่เปลี่ยน — ตอบจาก cache โดยไม่โหลดซ้ำ และเมื่อเก็บตัวที่?v=ใหม่ (deploy) ตัวเก่าของไฟล์เดียวกันถูกลบ
cache จึงไม่โตขึ้นทุก release ?v=ต้องเปลี่ยนเมื่อไฟล์เปลี่ยน — index.php ของแอปใช้reversion.<เวลาแก้ไขล่าสุดของไฟล์>(Now/dist, Now/css, css, js,
admin.js และ styles.css ของโมดูล) เลขเดียวทุกไฟล์ ไฟล์ที่ sync หรืออัปโหลดใหม่จึงได้ URL ใหม่เอง ไม่ต้องบันทึกการตั้งค่า
(reversion อย่างเดียวเคยทำให้ผู้ใช้ได้ไฟล์เดิมจาก cache ของเบราว์เซอร์นานถึง 1 สัปดาห์ และจาก service worker ตลอดไป)- รายการ
precacheต้องเป็น URL ที่หน้าขอจริง — สิ่งที่ index.php โหลดพร้อม?v=ต้องอยู่ในรายการพร้อม?v=เดียวกัน
(js/main.jsของแอปใช้versionedUrl()) ส่วนไฟล์ที่ถูก@importโดยไม่มี query (fonts/sarabun.css) ใส่แบบไม่มี query
feature bundle ของ Now.js ไม่ต้องใส่ —precacheFeaturesใส่ให้
ข้อควรระวัง
⚠️ 1. HTTPS Required
// ❌ ไม่ทำงานบน HTTP (ยกเว้น localhost)
// Service Workers require HTTPS
// ✅ ใช้ HTTPS
https://example.com⚠️ 2. Check Support First
// ❌ ไม่ตรวจสอบ support
ServiceWorkerManager.init({ enabled: true });
// ✅ ตรวจสอบก่อน
if (ServiceWorkerManager.isSupported()) {
ServiceWorkerManager.init({ enabled: true });
}เอกสารที่เกี่ยวข้อง
- StorageManager - Storage
- NotificationManager - Notifications