chrome.events

Descrizione

Concetti e utilizzo

Un Event è un oggetto che ti consente di ricevere una notifica quando succede qualcosa di interessante. Ecco un esempio di utilizzo dell'evento chrome.alarms.onAlarm per ricevere una notifica ogni volta che una sveglia è trascorsa:

chrome.alarms.onAlarm.addListener((alarm) => {
  appendToLog(`alarms.onAlarm -- name: ${alarm.name}, scheduledTime: ${alarm.scheduledTime}`);
});

Come mostrato nell'esempio, ti registri per le notifiche utilizzando addListener(). L'argomento di addListener() è sempre una funzione che definisci per gestire l'evento, ma i parametri dipendono dall'evento che gestisci. Controllo della documentazione per alarms.onAlarm in corso... puoi vedere che la funzione ha un singolo parametro: un oggetto alarms.Alarm con dettagli sulla sveglia scaduta.

API di esempio che utilizzano gli eventi: alarms, i18n, identity, runtime. La maggior parte di Chrome le API.

Gestori di eventi dichiarativi

I gestori di eventi dichiarativi forniscono un mezzo per definire regole costituite da condizioni dichiarative e azioni. Le condizioni vengono valutate nel browser anziché nel motore JavaScript che riduce e la latenza di round trip e consente un'efficienza molto elevata.

I gestori di eventi dichiarativi vengono utilizzati, ad esempio, nel API dichiarativa dei contenuti. In questa pagina vengono descritti i concetti di base di tutti gli eventi dichiarativi e i gestori di rete.

Regole

La regola più semplice possibile è composta da una o più condizioni e una o più azioni:

const rule = {
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Se una qualsiasi delle condizioni è soddisfatta, tutte le azioni vengono eseguite.

Oltre alle condizioni e alle azioni, puoi assegnare a ogni regola un identificatore, per semplificare l'annullamento della registrazione di regole registrate in precedenza e una priorità per definire le precedenti tra le regole. Le priorità vengono prese in considerazione solo se le regole sono in conflitto tra loro o devono essere eseguite in un ordine. Le azioni vengono eseguite in ordine decrescente in base alla priorità delle relative regole.

const rule = {
  id: "my rule",  // optional, will be generated if not set.
  priority: 100,  // optional, defaults to 100.
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Oggetti evento

Gli oggetti evento possono supportare regole. Questi oggetti evento non chiamano una funzione di callback quando si verificano, ma verifica se una qualsiasi regola registrata ha almeno una condizione soddisfatta ed esegui le azioni associate a questa regola. Gli oggetti evento che supportano l'API dichiarativa hanno tre metodi pertinenti: events.Event.addRules(), events.Event.removeRules() e events.Event.getRules()

Aggiungi regole

Per aggiungere regole, chiama la funzione addRules() dell'oggetto evento. Prende un array di istanze di regola come primo parametro e una funzione di callback che viene chiamata al completamento.

const rule_list = [rule1, rule2, ...];
addRules(rule_list, (details) => {...});

Se le regole sono state inserite correttamente, il parametro details contiene un array di regole inserite visualizzato nello stesso ordine di quello passato in rule_list, dove i parametri facoltativi id e priority sono stati compilati con i valori generati. Se una qualsiasi regola non è valida, ad esempio perché conteneva una condizione o un'azione non valida, non viene aggiunta alcuna regola e viene utilizzata la variabile runtime.lastError è impostata quando viene richiamata la funzione di callback. Ogni regola in rule_list deve contenere un indirizzo univoco non ancora utilizzato da un'altra regola o da un identificatore vuoto.

Rimuovi regole

Per rimuovere le regole, chiama la funzione removeRules(). Accetta un array facoltativo di identificatori di regola come primo parametro e una funzione di callback come secondo parametro.

const rule_ids = ["id1", "id2", ...];
removeRules(rule_ids, () => {...});

Se rule_ids è un array di identificatori, tutte le regole che hanno identificatori elencati nell'array vengono rimosso. Se rule_ids elenca un identificatore sconosciuto, questo identificatore viene ignorato automaticamente. Se rule_ids è undefined, tutte le regole registrate di questa estensione sono state rimosse. callback() viene richiamata quando le regole sono state rimosse.

Regole di recupero

Per recuperare un elenco di regole registrate, richiama la funzione getRules(). Accetta array facoltativo di identificatori di regole con la stessa semantica di removeRules() e una funzione di callback.

const rule_ids = ["id1", "id2", ...];
getRules(rule_ids, (details) => {...});

Il parametro details passato alla funzione callback() si riferisce a un array di regole, tra cui compilati con parametri facoltativi.

Prestazioni

Per ottenere il massimo rendimento, tieni presente le seguenti linee guida.

Registrare e annullare la registrazione delle regole in blocco. Dopo ogni registrazione o annullamento della registrazione, Chrome deve aggiornare le strutture dei dati interni. Questo aggiornamento è un'operazione costosa.

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1]);
chrome.declarativeWebRequest.onRequest.addRules([rule2]);

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

Preferisci la corrispondenza di sottostringhe alle espressioni regolari in events.UrlFilter. La corrispondenza basata su sottostringhe è estremamente veloce.

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {urlMatches: "example.com/[^?]*foo" }
});

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {hostSuffix: "example.com", pathContains: "foo"}
});

Se esistono più regole che condividono le stesse azioni, uniscile in un'unica regola. Le regole attivano le relative azioni non appena viene soddisfatta una singola condizione. Questo accelera la corrispondenza dei dati e riduce il consumo di memoria per gli insiemi di azioni duplicati.

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule1 = { conditions: [condition1],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
const rule2 = { conditions: [condition2],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule = { conditions: [condition1, condition2],
              actions: [new chrome.declarativeWebRequest.CancelRequest()]
             };
chrome.declarativeWebRequest.onRequest.addRules([rule]);

Eventi filtrati

Gli eventi filtrati sono un meccanismo che consente ai listener di specificare un sottoinsieme di eventi che ti interessa. Un listener che utilizza un filtro non verrà richiamato per gli eventi che non trasmettono che rende il codice di ascolto più dichiarativo ed efficiente. Un service worker ha bisogno non essere svegliato per gestire eventi che non gli interessano.

Gli eventi filtrati hanno lo scopo di consentire una transizione dal codice di filtro manuale.

chrome.webNavigation.onCommitted.addListener((event) => {
  if (hasHostSuffix(event.url, 'google.com') ||
      hasHostSuffix(event.url, 'google.com.au')) {
    // ...
  }
});

chrome.webNavigation.onCommitted.addListener((event) => {
  // ...
}, {url: [{hostSuffix: 'google.com'},
          {hostSuffix: 'google.com.au'}]});

Gli eventi supportano filtri specifici significativi per quell'evento. L'elenco di filtri utilizzati da un evento verranno elencati nella documentazione di quell'evento nella sezione "filtri" .

Nella corrispondenza degli URL (come nell'esempio sopra), i filtri di eventi supportano la stessa corrispondenza degli URL esprimibili con una events.UrlFilter, fatta eccezione per la corrispondenza di schema e porta.