Notifiche di eventi a livello di cache

Le notifiche degli eventi a livello di cache vengono attivate quando i dati vengono aggiunti, aggiornati o rimossi dalla cache da client, Cache Loader, Backing Source, ecc. Queste notifiche consentono alle applicazioni di ricevere callback per le modifiche ai dati a livello di cache. Per impostazione predefinita, gli eventi a livello di cache sono disabilitati (ad eccezione dell'operazione di cancellazione della cache) e possono essere abilitati tramite NCache Centro di gestione.

L'evento del livello della cache può essere registrato utilizzando RegisterCacheNotification specificando il callback implementato, il necessario EventType EventDataFilter (Nessuno, Metadati o DataWithMetadata). Qui descriviamo come registrare e annullare la registrazione degli eventi a livello di cache.

Note:

L'applicazione non sarà in grado di ricevere eventi a meno che non si registri nella cache utilizzando la chiamata API di registrazione eventi specifica.

Prerequisiti

Prima di usare il NCache Per le API lato client, assicurarsi che siano soddisfatti i seguenti prerequisiti:

Implementare la richiamata per le notifiche di eventi

È possibile implementare un callback per gli eventi in cui EventType è specificato secondo la logica dell'utente per ItemAdded, ItemUpdatede ItemRemoved eventi. L'esempio seguente implementa un metodo di callback per le notifiche della cache con determinati tipi di evento.

public void OnCacheDataModification(string key, CacheEventArg args)
{
    switch (args.EventType)
    {
        case EventType.ItemAdded:
            Console.WriteLine($"Item with Key '{key}' has been added to cache '{args.CacheName}'");
            break;

        case EventType.ItemUpdated:
            Console.WriteLine($"Item with Key '{key}' has been updated in the cache '{args.CacheName}'");

            // Item can be used if EventDataFilter is DataWithMetadata or Metadata
            if (args.Item != null)
            {
                Product updatedProduct = args.Item.GetValue<Product>();
                Console.WriteLine($"Updated Item is a Product having name '{updatedProduct.ProductName}', price '{updatedProduct.UnitPrice}', and quantity '{updatedProduct.QuantityPerUnit}'");
            }
            break;

        case EventType.ItemRemoved:
            Console.WriteLine($"Item with Key '{key}' has been removed from the cache '{args.CacheName}'");
            break;
    }
}
Note:

Per garantire che l'operazione sia a prova di errore, si consiglia di gestire eventuali potenziali eccezioni all'interno dell'applicazione, come spiegato in Gestione dei guasti.

Registra notifiche cache

Per registrare le notifiche a livello di cache, viene creato un metodo di destinazione che può avere più callback. Il metodo contiene un EventType and EventDataFilter. EventType viene regolato in base al tipo di operazione per la quale l'utente desidera ricevere notifiche. EventDataFilter può assumere uno dei tre valori possibili:

  • None
  • Metadata
  • DataWithMetadata

Gli eventi verranno notificati ai rispettivi listener e gestiti in base all'implementazione dell'utente. L'esempio seguente mostra come creare un metodo che registra callback per le notifiche della cache utilizzando tipi di evento specifici.

Consigli

Migliori EventDataFilter deve essere impostato con cura per evitare un consumo non necessario della larghezza di banda della rete.

Note:

In .NET, EventDataFilter.None viene utilizzato per impostazione predefinita quando il filtro viene omesso. Per le altre API client supportate, specificare esplicitamente il filtro dati evento richiesto.

// Precondition: Cache is already connected

public void RegisterCacheNotificationsForAllOperations()
{
  try
  {
    // Create CacheDataNotificationCallback object
    var dataNotificationCallback = new CacheDataNotificationCallback(OnCacheDataModification);

    // Register cache notification with "ItemAdded", "ItemUpdated", and "ItemRemoved" EventType
    // EventDataFilter "None" means only keys will be returned
    CacheEventDescriptor eventDescriptor = cache.MessagingService.RegisterCacheNotification(dataNotificationCallback, EventType.ItemAdded | EventType.ItemUpdated | EventType.ItemRemoved, EventDataFilter.None);

    if (eventDescriptor.IsRegistered)
    {
        Console.WriteLine("Cache level notifications registered successfully");
    }
  }
  catch (OperationFailedException ex)
  {
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
  }
  catch (Exception ex)
  {
    // Any generic exception like ArgumentException, ArgumentNullException
  }
}

Annulla registrazione notifiche cache

Le notifiche degli eventi a livello di cache precedentemente registrate possono essere annullate quando non sono più necessarie utilizzando UnRegisterCacheNotification metodo. Utilizzando questo metodo, il CacheEventDescriptor È inoltre necessario specificare se annullare la registrazione delle notifiche. Per Java e Node.js, utilizzare l'API Remove Notification Listener. L'esempio seguente mostra come annullare la registrazione delle notifiche utilizzando questo metodo.

// Precondition: Cache is already connected

// Unregister Notifications using the EventDescriptor
cache.MessagingService.UnRegisterCacheNotification(eventDescriptor);
Note:

L'utilizzo di eventi a livello di cache potrebbe influire sulle prestazioni dell'applicazione poiché genera notifiche per tutte le operazioni specificate eseguite sull'intero set di dati della cache. Pertanto, l'utilizzo Eventi a livello di oggetto è l'approccio consigliato per evitare questo problema.

Risorse addizionali

NCache fornisce un'applicazione di esempio per le notifiche di eventi a livello di cache GitHub.

Vedere anche

.NETTO: Alachisoft.NCache.Eventi.di.runtime spazio dei nomi.
Giava: com.alachisoft.ncache.runtime.events pacchetto.
Pitone: eventi di caching di ncache.runtime modulo.
Node.js: EventCacheItem classe.