(0) exportieren Drucken
Alle erweitern
Dieser Artikel wurde manuell übersetzt. Bewegen Sie den Mauszeiger über die Sätze im Artikel, um den Originaltext anzuzeigen. Weitere Informationen
Übersetzung
Original

Beobachterentwurfsmuster

Mit dem Entwurfsmuster Beobachter kann sich ein Abonnent bei einem Anbieter registrieren und Benachrichtigungen von diesem empfangen. Es ist für jedes Szenario geeignet, das pushbasierte Benachrichtigungen erfordert. Das Muster definiert einen Anbieter (auch als Antragssteller oder Observable bezeichnet) und keinen, einen oder mehrere Beobachter. Beobachter registrieren sich beim Anbieter, und sobald eine vordefinierte Bedingung, ein Ereignis oder eine Zustandsänderung stattfindet, benachrichtigt der Anbieter automatisch alle Beobachter, indem er eine ihrer Methoden aufruft. In diesem Methodenaufruf kann der Anbieter den Beobachtern auch aktuelle Zustandsinformationen bereitstellen. In .NET Framework wird das Entwurfsmuster Beobachter angewendet, indem die generischen Schnittstellen System.IObserver<T> und System.IObservable<T> implementiert werden. Der generische Typparameter stellt den Typ dar, der Benachrichtigungsinformationen bereitstellt.

Das Entwurfsmuster Beobachter ist für verteilte pushbasierte Benachrichtigungen geeignet, da es eine saubere Trennung zwischen zwei verschiedenen Komponenten bzw. Anwendungsebenen erlaubt, z. B. zwischen einer Datenquellenebene (Geschäftslogik) und einer Benutzeroberflächenebene (Anzeige). Das Muster kann immer dann implementiert werden, wenn ein Anbieter Rückrufe verwendet, um seinen Clients aktuelle Informationen bereitzustellen.

Für eine Implementierung des Musters wird Folgendes benötigt:

  • Ein Anbieter oder Antragsteller, der das Objekt darstellt, das Benachrichtigungen an die Beobachter sendet. Ein Anbieter ist eine Klasse oder eine Struktur, die die IObservable<T>-Schnittstelle implementiert. Der Anbieter muss eine einzelne IObservable<T>.Subscribe-Methode implementieren, die von Beobachtern aufgerufen wird, die Benachrichtigungen vom Anbieter erhalten möchten.

  • Ein Beobachter, bei dem es sich um ein Objekt handelt, das Benachrichtigungen von einem Anbieter empfängt. Ein Beobachter ist eine Klasse oder eine Struktur, die die IObserver<T>-Schnittstelle implementiert. Der Beobachter muss drei Methoden implementieren, die alle vom Anbieter aufgerufen werden:

  • Ein Mechanismus, mit dem der Anbieter Beobachter verwalten kann. In der Regel verwendet der Anbieter ein Containerobjekt, z. B. ein System.Collections.Generic.List<T>-Objekt, um Verweise auf die IObserver<T>-Implementierungen zu speichern, die Benachrichtigungen abonniert haben. Durch das Verwenden eines Speichercontainers zu diesem Zweck kann der Anbieter eine beliebige Anzahl von Beobachtern behandeln. Die Reihenfolge, in der Beobachter Benachrichtigungen empfangen, ist nicht definiert. Der Anbieter kann die Methode zum Bestimmen der Reihenfolge frei wählen.

  • Eine IDisposable-Implementierung, die es dem Anbieter ermöglicht, Beobachter zu entfernen, wenn die Benachrichtigungen abgeschlossen wurden. Beobachter erhalten einen Verweis auf die IDisposable-Implementierung der Subscribe-Methode, sodass sie die IDisposable.Dispose-Methode ebenfalls aufrufen können, um das Abonnement zu kündigen, bevor der Anbieter das Senden von Benachrichtigungen abgeschlossen hat.

  • Ein Objekt, das die Daten enthält, die vom Anbieter an die Beobachter gesendet werden. Der Typ des Objekts entspricht dem generischen Typparameter der Schnittstellen IObservable<T> und IObserver<T>. Obwohl dieses Objekt vom selben Typ sein kann wie die IObservable<T>-Implementierung, handelt es sich in den meisten Fällen um einen separaten Typ.

Hinweis Hinweis

Zusätzlich zum Implementieren des Entwurfsmusters Beobachter sind Sie ggf. an einer ausführlichen Untersuchung von Bibliotheken interessiert, die mithilfe der Schnittstellen IObservable<T> und IObserver<T> erstellt werden. Zum Reagierende Erweiterungen für .NET (Rx) Beispiel besteht Sie aus einem Satz von Erweiterungsmethoden und LINQ-Standardsequenzoperatoren für eine Unterstützung, um asynchrone Programmierung.

Im folgenden Beispiel wird das Entwurfsmuster Beobachter verwendet, um ein Informationssystem für die Flughafengepäckausgabe zu implementieren. Eine BaggageInfo-Klasse stellt Informationen über ankommende Flüge und über die Laufbänder bereit, von denen das Gepäck jedes Flugs abgeholt werden kann. Dies wird im folgenden Beispiel gezeigt.


using System;
using System.Collections.Generic;

public class BaggageInfo
{
   private int flightNo;
   private string origin;
   private int location;

   internal BaggageInfo(int flight, string from, int carousel)
   {
      this.flightNo = flight;
      this.origin = from;
      this.location = carousel;
   }

   public int FlightNumber {
      get { return this.flightNo; }
   }

   public string From {
      get { return this.origin; }
   }

   public int Carousel {
      get { return this.location; }
   }
}


Eine BaggageHandler-Klasse ist für den Empfang von Informationen über ankommende Flüge und die Gepäckausgabebänder verantwortlich. Intern werden zwei Auflistungen verwaltet:

  • observers - Eine Auflistung der Clients, die aktualisierte Informationen erhalten.

  • flights - Eine Auflistung der Flüge und zugewiesenen Laufbänder.

Beide Auflistungen werden von generischen List<T>-Objekten dargestellt, die im BaggageHandler-Klassenkonstruktor instanziiert werden. Der Quellcode für die BaggageHandler-Klasse wird im folgenden Beispiel gezeigt.


public class BaggageHandler : IObservable<BaggageInfo>
{
   private List<IObserver<BaggageInfo>> observers;
   private List<BaggageInfo> flights;

   public BaggageHandler()
   {
      observers = new List<IObserver<BaggageInfo>>();
      flights = new List<BaggageInfo>();
   }

   public IDisposable Subscribe(IObserver<BaggageInfo> observer)
   {
      // Check whether observer is already registered. If not, add it
      if (! observers.Contains(observer)) {
         observers.Add(observer);
         // Provide observer with existing data.
         foreach (var item in flights)
            observer.OnNext(item);
      }
      return new Unsubscriber<BaggageInfo>(observers, observer);
   }

   // Called to indicate all baggage is now unloaded.
   public void BaggageStatus(int flightNo)
   {
      BaggageStatus(flightNo, String.Empty, 0);
   }

   public void BaggageStatus(int flightNo, string from, int carousel)
   {
      var info = new BaggageInfo(flightNo, from, carousel);

      // Carousel is assigned, so add new info object to list.
      if (carousel > 0 && ! flights.Contains(info)) {
         flights.Add(info);
         foreach (var observer in observers)
            observer.OnNext(info);
      }
      else if (carousel == 0) {
         // Baggage claim for flight is done
         var flightsToRemove = new List<BaggageInfo>();
         foreach (var flight in flights) {
            if (info.FlightNumber == flight.FlightNumber) {
               flightsToRemove.Add(flight);
               foreach (var observer in observers)
                  observer.OnNext(info);
            }
         }
         foreach (var flightToRemove in flightsToRemove)
            flights.Remove(flightToRemove);

         flightsToRemove.Clear();
      }
   }

   public void LastBaggageClaimed()
   {
      foreach (var observer in observers)
         observer.OnCompleted();

      observers.Clear();
   }
}


Clients, die aktualisierte Informationen erhalten möchten, rufen die BaggageInfo.Subscribe-Methode auf. Wenn sich der Client zuvor noch nicht für Benachrichtigungen registriert hat, wird der observers-Auflistung ein Verweis auf die IObserver<T>-Implementierung des Clients hinzugefügt.

Die überladene BaggageHandler.BaggageStatus-Methode kann aufgerufen werden, um anzugeben, dass Gepäck aus einem Flug entweder entladen oder nicht mehr entladen wird. Im ersten Fall wird der Methode eine Flugnummer – der Flughafen, von dem der Flug gestartet ist – und das Laufband übergeben, auf dem das Gepäck entladen wird. Im zweiten Fall wird der Methode nur eine Flugnummer übergeben. Für Gepäck, das entladen wird, überprüft die Methode, ob die BaggageInfo-Informationen, die an die Methode übergeben wurden, in der flights-Auflistung vorhanden sind. Ist dies nicht der Fall, fügt die Methode die Informationen hinzu und ruft die OnNext-Methode jedes Beobachters auf. Für Flüge, deren Gepäck nicht mehr entladen wird, überprüft die Methode, ob Informationen zu diesem Flug in der flights-Auflistung gespeichert sind. Wenn dies der Fall ist, ruft die Methode die OnNext-Methode jedes Beobachters auf und entfernt das BaggageInfo-Objekt aus der flights-Auflistung.

Wenn der letzte Flug des Tages gelandet ist und sein Gepäck verarbeitet wurde, wird die BaggageHandler.LastBaggageClaimed-Methode aufgerufen. Diese Methode ruft die OnCompleted-Methode jedes Beobachters auf, um anzuzeigen, dass alle Benachrichtigungen abgeschlossen wurden, und löscht dann die observers-Auflistung.

Die Subscribe-Methode des Anbieters gibt eine IDisposable-Implementierung zurück, mit der die Beobachter den Empfang von Benachrichtigungen beenden können, bevor die OnCompleted-Methode aufgerufen wird. Der Quellcode für diese Unsubscriber(Of BaggageInfo)-Klasse wird im folgenden Beispiel gezeigt. Wenn die Klasse in der BaggageHandler.Subscribe-Methode instanziiert wird, werden ein Verweis auf die observers-Auflistung und ein Verweis auf den Beobachter übergeben, der der Auflistung hinzugefügt wird. Diese Verweise werden lokalen Variablen zugewiesen. Wenn die Dispose-Methode des Objekts aufgerufen wird, überprüft sie, ob der Beobachter noch in der observers-Auflistung vorhanden ist, und entfernt in diesem Fall den Beobachter.


internal class Unsubscriber<BaggageInfo> : IDisposable
{
   private List<IObserver<BaggageInfo>> _observers;
   private IObserver<BaggageInfo> _observer;

   internal Unsubscriber(List<IObserver<BaggageInfo>> observers, IObserver<BaggageInfo> observer)
   {
      this._observers = observers;
      this._observer = observer;
   }

   public void Dispose() 
   {
      if (_observers.Contains(_observer))
         _observers.Remove(_observer);
   }
}


Im folgenden Beispiel wird eine IObserver<T>-Implementierung mit dem Namen ArrivalsMonitor gezeigt. Dies ist eine Basisklasse, die Informationen für die Gepäckausgabe anzeigt. Die Informationen werden alphabetisch sortiert nach dem Namen der Stadt angezeigt, aus der der Flug kam. Die Methoden von ArrivalsMonitor werden als overridable (Visual Basic) bzw. als virtual (C#) gekennzeichnet, damit sie alle durch eine abgeleitete Klasse überschrieben werden können.


using System;
using System.Collections.Generic;

public class ArrivalsMonitor : IObserver<BaggageInfo>
{
   private string name;
   private List<string> flightInfos = new List<string>();
   private IDisposable cancellation;
   private string fmt = "{0,-20} {1,5}  {2, 3}";

   public ArrivalsMonitor(string name)
   {
      if (String.IsNullOrEmpty(name))
         throw new ArgumentNullException("The observer must be assigned a name.");

      this.name = name;
   }

   public virtual void Subscribe(BaggageHandler provider)
   {
      cancellation = provider.Subscribe(this);
   }

   public virtual void Unsubscribe()
   {
      cancellation.Dispose();
      flightInfos.Clear();
   }

   public virtual void OnCompleted() 
   {
      flightInfos.Clear();
   }

   // No implementation needed: Method is not called by the BaggageHandler class.
   public virtual void OnError(Exception e)
   {
      // No implementation.
   }

   // Update information.
   public virtual void OnNext(BaggageInfo info) 
   {
      bool updated = false;

      // Flight has unloaded its baggage; remove from the monitor.
      if (info.Carousel == 0) {
         var flightsToRemove = new List<string>();
         string flightNo = String.Format("{0,5}", info.FlightNumber);

         foreach (var flightInfo in flightInfos) {
            if (flightInfo.Substring(21, 5).Equals(flightNo)) {
               flightsToRemove.Add(flightInfo);
               updated = true;
            }
         }
         foreach (var flightToRemove in flightsToRemove)
            flightInfos.Remove(flightToRemove);

         flightsToRemove.Clear();
      }
      else {
         // Add flight if it does not exist in the collection.
         string flightInfo = String.Format(fmt, info.From, info.FlightNumber, info.Carousel);
         if (! flightInfos.Contains(flightInfo)) {
            flightInfos.Add(flightInfo);
            updated = true;
         }
      }
      if (updated) {
         flightInfos.Sort();
         Console.WriteLine("Arrivals information from {0}", this.name);
         foreach (var flightInfo in flightInfos)
            Console.WriteLine(flightInfo);

         Console.WriteLine();
      }
   }
}


Die ArrivalsMonitor-Klasse beinhaltet die Subscribe-Methode und die Unsubscribe-Methode. Mit der Subscribe-Methode kann die Klasse die IDisposable-Implementierung, die beim Aufruf von Subscribe zurückgegeben wurde, in einer privaten Variablen speichern. Mit der Unsubscribe-Methode kann die Klasse den Empfang von Benachrichtigungen kündigen, indem die Dispose-Implementierung des Anbieters aufgerufen wird. ArrivalsMonitor stellt ebenfalls Implementierungen der Methoden OnNext, OnError und OnCompleted bereit. Nur die OnNext-Implementierung enthält eine signifikante Menge an Code. Die Methode arbeitet mit einem privaten, sortierten, generischen List<T>-Objekt, in dem Informationen über die Herkunftsflugplätze der ankommenden Flüge und über die Laufbänder verwaltet werden, auf denen das Gepäck bereitgestellt wird. Wenn die BaggageHandler-Klasse einen neuen ankommenden Flug meldet, fügt die OnNext-Methodenimplementierung der Liste Informationen über diesen Flug hinzu. Wenn die BaggageHandler-Klasse meldet, dass das Gepäck des Fluges entladen wurde, entfernt die OnNext-Methode diesen Flug aus der Liste. Bei jeder Änderung wird die Liste sortiert und an der Konsole ausgegeben.

Das folgende Beispiel enthält den Einstiegspunkt der Anwendung, die die BaggageHandler-Klasse und zwei Instanzen der ArrivalsMonitor-Klasse instanziiert und die BaggageHandler.BaggageStatus-Methode verwendet, um Informationen über ankommende Flüge hinzuzufügen und zu entfernen. In jedem Fall empfangen die Beobachter Updates und zeigen ordnungsgemäß Informationen zur Gepäckausgabe an.


using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      BaggageHandler provider = new BaggageHandler();
      ArrivalsMonitor observer1 = new ArrivalsMonitor("BaggageClaimMonitor1");
      ArrivalsMonitor observer2 = new ArrivalsMonitor("SecurityExit");

      provider.BaggageStatus(712, "Detroit", 3);
      observer1.Subscribe(provider);
      provider.BaggageStatus(712, "Kalamazoo", 3);
      provider.BaggageStatus(400, "New York-Kennedy", 1);
      provider.BaggageStatus(712, "Detroit", 3);
      observer2.Subscribe(provider);
      provider.BaggageStatus(511, "San Francisco", 2);
      provider.BaggageStatus(712);
      observer2.Unsubscribe();
      provider.BaggageStatus(400);
      provider.LastBaggageClaimed();
   }
}
// The example displays the following output:
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from BaggageClaimMonitor1
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from SecurityExit
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from BaggageClaimMonitor1
//      San Francisco          511    2


Titel

Beschreibung

Empfohlene Vorgehensweisen für Beobachterentwurfsmuster

Beschreibt bewährte Methoden für die Entwicklung von Anwendungen, die das Entwurfsmuster Beobachter implementieren.

Gewusst wie: Implementieren eines Anbieters

Stellt eine schrittweise Implementierung eines Anbieters für eine Anwendung zur Temperaturüberwachung bereit.

Gewusst wie: Implementieren eines Observers

Stellt eine schrittweise Implementierung eines Beobachters für eine Anwendung zur Temperaturüberwachung bereit.

Community-Beiträge

HINZUFÜGEN
Anzeigen:
© 2014 Microsoft