Arka plan veya etkinlik sayfalarını hizmet çalışanıyla değiştirme
Hizmet çalışanı, arka plan kodunun ana iş parçacığının dışında kalmasını sağlamak için uzantının arka plan veya etkinlik sayfasının yerini alır. Bu sayede uzantılar yalnızca gerektiğinde çalışarak kaynak tasarrufu sağlar.
Arka plan sayfaları, kullanıma sunulduklarından beri uzantıların temel bileşenlerinden biri olmuştur. Basitçe ifade etmek gerekirse arka plan sayfaları, diğer pencere veya sekmelerden bağımsız olarak çalışan bir ortam sağlar. Bu sayede uzantılar, etkinlikleri gözlemleyebilir ve bunlara yanıt verebilir.
Bu sayfada, arka plan sayfalarını uzantı hizmet çalışanlarına dönüştürme görevleri açıklanmaktadır. Genel olarak uzantı hizmet çalışanları hakkında daha fazla bilgi için Hizmet çalışanlarıyla etkinlikleri işleme eğitimini ve Uzantı hizmet çalışanları hakkında bölümünü inceleyin.
Arka plan komut dosyaları ile uzantı hizmet çalışanları arasındaki farklar
Bazı bağlamlarda, uzantı hizmet çalışanlarının "arka plan komut dosyaları" olarak adlandırıldığını görürsünüz. Uzantı hizmet çalışanları arka planda çalışsa da bunları arka plan komut dosyaları olarak adlandırmak, aynı özelliklere sahip olduklarını ima ettiği için biraz yanıltıcıdır. Farklar aşağıda açıklanmıştır.
Arka plan sayfalarındaki değişiklikler
Hizmet çalışanlarının arka plan sayfalarıyla ilgili çeşitli farklılıkları vardır.
- Ana mesaj dizisinin dışında çalıştıkları için uzantı içeriğine müdahale etmezler.
- Uzantının kaynağındaki getirme etkinliklerini (ör. araç çubuğu pop-up'ından gelenler) engelleme gibi özel özellikleri vardır.
- Clients arayüzü aracılığıyla diğer bağlamlarla iletişim kurabilir ve etkileşime geçebilirler.
Yapmanız gereken değişiklikler
Arka plan komut dosyaları ile hizmet çalışanlarının işleyiş şekli arasındaki farkları hesaba katmak için kodda birkaç düzenleme yapmanız gerekir. Öncelikle, hizmet çalışanının manifest dosyasında belirtilme şekli, arka plan komut dosyalarının belirtilme şeklinden farklıdır. Ayrıca:
- DOM'a veya
windowarayüzüne erişemedikleri için bu tür çağrıları farklı bir API'ye veya ekran dışı bir dokümana taşımanız gerekir. - Etkinlik işleyiciler, döndürülen vaatlere yanıt olarak veya etkinlik geri çağırmalarının içinde kaydedilmemelidir.
XMLHttpRequest()ile geriye dönük uyumlu olmadıklarından, bu arayüze yapılan çağrılarıfetch()çağrılarıyla değiştirmeniz gerekir.- Kullanılmadığında sonlandırıldıkları için global değişkenlere güvenmek yerine uygulama durumlarını kalıcı hale getirmeniz gerekir. Hizmet çalışanlarını sonlandırmak, zamanlayıcıları da tamamlanmadan sonlandırabilir. Bunları alarmlarla değiştirmeniz gerekir.
Bu sayfada, bu görevler ayrıntılı olarak açıklanmaktadır.
Manifest dosyasındaki "background" alanını güncelleme
Manifest V3'te arka plan sayfalarının yerini bir hizmet çalışanı alır. Manifest değişiklikleri aşağıda listelenmiştir.
manifest.jsoniçinde"background.scripts"yerine"background.service_worker"yazın."service_worker"alanının dize dizisi değil, dize aldığını unutmayın."background.persistent",manifest.jsonlistesinden kaldırılır.
{ ... "background": { "scripts": [ "backgroundContextMenus.js", "backgroundOauth.js" ], "persistent": false }, ... }
{ ... "background": { "service_worker": "service_worker.js", "type": "module" } ... }
"service_worker" alanı tek bir dize alır. "type" alanını yalnızca ES modülleri kullanıyorsanız (import anahtar kelimesini kullanarak) kullanmanız gerekir. Değeri her zaman "module" olur. Daha fazla bilgi için Uzantı hizmet çalışanıyla ilgili temel bilgiler başlıklı makaleyi inceleyin.
DOM ve pencere çağrılarını ekran dışı bir dokümana taşıma
Bazı uzantıların, görsel olarak yeni bir pencere veya sekme açmadan DOM ve pencere nesnelerine erişmesi gerekir. Offscreen API, uzantıyla birlikte paketlenen görüntülenmeyen dokümanları kullanıcı deneyimini kesintiye uğratmadan açıp kapatarak bu kullanım alanlarını destekler. Ekran dışı dokümanlar, mesaj iletme dışında diğer uzantı bağlamlarıyla API paylaşmaz ancak uzantıların etkileşim kurabileceği tam web sayfaları olarak işlev görür.
Offscreen API'yi kullanmak için hizmet çalışanından bir ekran dışı doküman oluşturun.
browser.offscreen.createDocument({
url: browser.runtime.getURL('offscreen.html'),
reasons: ['CLIPBOARD'],
justification: 'testing the offscreen API',
});
Ekran dışı dokümanda, daha önce arka plan komut dosyasında çalıştırdığınız tüm işlemleri gerçekleştirin. Örneğin, ana sayfada seçilen metni kopyalayabilirsiniz.
let textEl = document.querySelector('#text');
textEl.value = data;
textEl.select();
document.execCommand('copy');
Chrome 157'den itibaren, panoya yazmak için ekran dışı bir dokümana ihtiyacınız yoktur. "clipboardWrite" iznine sahip bir uzantı hizmet çalışanı, doğrudan navigator.clipboard.writeText() veya navigator.clipboard.write() yöntemini çağırabilir. Hizmet çalışanları panodan okuma yapamaz.
async function copyToClipboard(data) {
await navigator.clipboard.writeText(data);
}
Mesaj iletimini kullanarak ekran dışı dokümanlar ile uzantı hizmet çalışanları arasında iletişim kurun.
localStorage'ı başka bir türe dönüştürme
Web platformunun Storage arayüzü (window.localStorage üzerinden erişilebilir), hizmet çalışanında kullanılamaz. Bu sorunu gidermek için iki yöntemden birini kullanabilirsiniz. İlk olarak, bunu başka bir depolama mekanizmasına yapılan çağrılarla değiştirebilirsiniz. browser.storage.local ad alanı çoğu kullanım alanına uygundur ancak başka seçenekler de mevcuttur.
Ayrıca, çağrılarını ekran dışı bir dokümana taşıyabilirsiniz. Örneğin, daha önce localStorage içinde depolanan verileri başka bir mekanizmaya taşımak için:
- Dönüştürme rutini ve
runtime.onMessageişleyicisi içeren bir ekran dışı doküman oluşturun. - Ekran dışı dokümana bir dönüşüm rutini ekleyin.
- Uzantı hizmet çalışanında verileriniz için
browser.storagesimgesini kontrol edin. - Verileriniz bulunamazsa ekran dışı bir doküman oluşturun ve dönüşüm rutinini başlatmak için
runtime.sendMessage()yöntemini çağırın. - Ekran dışı belgeye eklediğiniz
runtime.onMessageişleyicisinde dönüşüm rutinini çağırın.
Web Storage API'lerin uzantılarda çalışma şekliyle ilgili bazı farklılıklar da vardır. Daha fazla bilgi için Depolama Alanı ve Çerezler bölümüne bakın.
Dinleyicileri eşzamanlı olarak kaydetme
Dinleyicinin eşzamansız olarak kaydedilmesinin (örneğin, bir promise veya geri çağırma içinde) Manifest V3'te çalışacağı garanti edilmez. Aşağıdaki kodu inceleyin.
browser.storage.local.get(["badgeText"], ({ badgeText }) => {
browser.browserAction.setBadgeText({ text: badgeText });
browser.browserAction.onClicked.addListener(handleActionClick);
});
Bu, kalıcı bir arka plan sayfasıyla çalışır çünkü sayfa sürekli çalışır ve hiçbir zaman yeniden başlatılmaz. Manifest V3'te, etkinlik gönderildiğinde hizmet çalışanı yeniden başlatılır. Bu, etkinlik tetiklendiğinde işleyicilerin kaydedilmeyeceği (eşzamansız olarak eklendikleri için) ve etkinliğin kaçırılacağı anlamına gelir.
Bunun yerine, etkinlik işleyici kaydını komut dosyanızın üst düzeyine taşıyın. Bu sayede Chrome, uzantınız başlangıç mantığını yürütmeyi tamamlamamış olsa bile işleminizin tıklama işleyicisini hemen bulup çağırabilir.
browser.action.onClicked.addListener(handleActionClick);
browser.storage.local.get(["badgeText"], ({ badgeText }) => {
browser.action.setBadgeText({ text: badgeText });
});
XMLHttpRequest() yerine genel fetch() kullanma
XMLHttpRequest(), hizmet çalışanı, uzantı veya başka bir yerden çağrılamaz. Arka plan komut dosyanızdan XMLHttpRequest() için yapılan çağrıları global fetch() için yapılan çağrılarla değiştirin.
const xhr = new XMLHttpRequest(); console.log('UNSENT', xhr.readyState); xhr.open('GET', '/api', true); console.log('OPENED', xhr.readyState); xhr.onload = () => { console.log('DONE', xhr.readyState); }; xhr.send(null);
const response = await fetch('https://www.example.com/greeting.json'') console.log(response.statusText);
Durumları koruma
Hizmet çalışanları geçicidir. Bu nedenle, kullanıcının tarayıcı oturumu sırasında muhtemelen tekrar tekrar başlatılır, çalıştırılır ve sonlandırılır. Ayrıca, önceki bağlam kaldırıldığı için veriler global değişkenlerde hemen kullanılamaz. Bu sorunu çözmek için Storage API'leri doğruluk kaynağı olarak kullanın. Bunun nasıl yapılacağını bir örnekle açıklayalım.
Aşağıdaki örnekte bir adı depolamak için global değişken kullanılmaktadır. Hizmet çalışanında bu değişken, kullanıcının tarayıcı oturumu sırasında birden çok kez sıfırlanabilir.
let savedName = undefined; browser.runtime.onMessage.addListener(({ type, name }) => { if (type === "set-name") { savedName = name; } }); browser.browserAction.onClicked.addListener((tab) => { browser.tabs.sendMessage(tab.id, { name: savedName }); });
Manifest V3 için global değişkeni Storage API çağrısıyla değiştirin.
browser.runtime.onMessage.addListener(({ type, name }) => { if (type === "set-name") { browser.storage.local.set({ name }); } }); browser.action.onClicked.addListener(async (tab) => { const { name } = await browser.storage.local.get(["name"]); browser.tabs.sendMessage(tab.id, { name }); });
Zamanlayıcıları alarma dönüştürme
setTimeout() veya setInterval() yöntemlerini kullanarak gecikmeli ya da periyodik işlemler yapmak yaygın bir uygulamadır. Ancak hizmet çalışanları sonlandırıldığında zamanlayıcılar iptal edildiğinden bu API'ler hizmet çalışanlarında başarısız olabilir.
// 3 minutes in milliseconds const TIMEOUT = 3 * 60 * 1000; setTimeout(() => { browser.action.setIcon({ path: getRandomIconPath(), }); }, TIMEOUT);
Bunun yerine Alarms API'yi kullanın. Diğer dinleyicilerde olduğu gibi alarm dinleyicileri de komut dosyanızın en üst düzeyinde kaydedilmelidir.
async function startAlarm(name, duration) { await browser.alarms.create(name, { delayInMinutes: 3 }); } browser.alarms.onAlarm.addListener(() => { browser.action.setIcon({ path: getRandomIconPath(), }); });
Hizmet çalışanını etkin tutma
Hizmet çalışanları, tanım gereği etkinliğe dayalıdır ve etkinlik olmadığında sonlandırılır. Böylece Chrome, uzantınızın performansını ve bellek tüketimini optimize edebilir. Hizmet çalışanı yaşam döngüsü belgelerimizde daha fazla bilgi edinebilirsiniz. İstisnai durumlarda, hizmet çalışanının daha uzun süre etkin kalmasını sağlamak için ek önlemler alınması gerekebilir.
Uzun süreli bir işlem tamamlanana kadar hizmet çalışanını etkin tutma
Uzantı API'lerini çağırmayan uzun süreli hizmet çalışanı işlemleri sırasında hizmet çalışanı, işlemin ortasında kapanabilir. Örnekler:
- Beş dakikadan uzun sürebilecek bir
fetch()isteği (ör. zayıf olabilecek bir bağlantıda büyük bir indirme işlemi). - 30 saniyeden uzun süren karmaşık bir eşzamansız hesaplama.
Bu gibi durumlarda hizmet çalışanının kullanım ömrünü uzatmak için zaman aşımı sayacını sıfırlamak üzere düzenli olarak önemsiz bir uzantı API'si çağırabilirsiniz. Bu yöntemin yalnızca istisnai durumlar için ayrıldığını ve çoğu durumda aynı sonucu elde etmek için genellikle daha iyi, platforma özgü bir yöntem olduğunu lütfen unutmayın.
Aşağıdaki örnekte, hizmet çalışanınızı belirli bir söz çözümlenene kadar etkin tutan bir waitUntil() yardımcı işlevi gösterilmektedir:
async function waitUntil(promise) {
const keepAlive = setInterval(browser.runtime.getPlatformInfo, 25 * 1000);
try {
await promise;
} finally {
clearInterval(keepAlive);
}
}
waitUntil(someExpensiveCalculation());
Hizmet çalışanını sürekli olarak etkin tutma
Nadir durumlarda, kullanım ömrünün süresiz olarak uzatılması gerekir. Kurumsal ve eğitim alanlarını en büyük kullanım alanları olarak belirledik ve özellikle bu alanlarda izin veriyoruz ancak genel olarak desteklemiyoruz. Bu istisnai durumlarda, hizmet çalışanını etkin tutmak için önemsiz bir uzantı API'si düzenli olarak çağrılabilir. Bu önerinin yalnızca kurumsal veya eğitim amaçlı kullanım alanları için yönetilen cihazlarda çalışan uzantılar için geçerli olduğunu unutmayın. Diğer durumlarda kullanılmasına izin verilmez ve Chrome uzantısı ekibi, gelecekte bu uzantılara karşı işlem yapma hakkını saklı tutar.
Hizmet çalışanınızı etkin tutmak için aşağıdaki kod snippet'ini kullanın:
/**
* Tracks when a service worker was last alive and extends the service worker
* lifetime by writing the current time to extension storage every 20 seconds.
* You should still prepare for unexpected termination - for example, if the
* extension process crashes or your extension is manually stopped at
* chrome://serviceworker-internals.
*/
let heartbeatInterval;
async function runHeartbeat() {
await browser.storage.local.set({ 'last-heartbeat': new Date().getTime() });
}
/**
* Starts the heartbeat interval which keeps the service worker alive. Call
* this sparingly when you are doing work which requires persistence, and call
* stopHeartbeat once that work is complete.
*/
async function startHeartbeat() {
// Run the heartbeat once at service worker startup.
runHeartbeat().then(() => {
// Then again every 20 seconds.
heartbeatInterval = setInterval(runHeartbeat, 20 * 1000);
});
}
async function stopHeartbeat() {
clearInterval(heartbeatInterval);
}
/**
* Returns the last heartbeat stored in extension storage, or undefined if
* the heartbeat has never run before.
*/
async function getLastHeartbeat() {
return (await browser.storage.local.get('last-heartbeat'))['last-heartbeat'];
}