Xamarin.Forms MessagingCenter

Beispiel herunterladen Das Beispiel herunterladen

Das Veröffentlichen-Abonnieren-Muster ist ein Messagingmuster, bei dem Herausgeber Nachrichten senden, ohne über Kenntnisse zu Empfängern zu verfügen, die als Abonnenten bezeichnet werden. Auf ähnliche Weise lauschen Abonnenten auf bestimmte Nachrichten, ohne dass sie über Kenntnisse zu Herausgebern verfügen.

Ereignisse in .NET implementieren das Veröffentlichen-Abonnieren-Muster und sind der einfachste und unkomplizierteste Ansatz für eine Kommunikationsschicht zwischen Komponenten, wenn keine lose Kopplung erforderlich ist, wie beispielsweise ein Steuerelement und die Seite, die es enthält. Die Lebensdauer von Herausgeber und Abonnent sind jedoch durch Objektverweise miteinander gekoppelt, und der Abonnententyp muss einen Verweis auf den Herausgebertypen haben. Dies kann zu Problemen bei der Speicherverwaltung führen, insbesondere wenn es kurzlebige Objekte gibt, die ein Ereignis eines statischen oder langlebigen Objekts abonnieren. Wenn der Ereignishandler nicht entfernt wird, bleibt der Abonnent durch den Verweis darauf im Herausgeber erhalten, was die Garbage Collection des Abonnenten verhindert oder verzögert.

Die Xamarin.FormsMessagingCenter -Klasse implementiert das Publish-Subscribe-Muster, sodass die nachrichtenbasierte Kommunikation zwischen Komponenten, die nicht durch Objekt- und Typverweise verknüpft werden können, möglich ist. Dieser Mechanismus ermöglicht es Herausgebern und Abonnenten, ohne einen Verweis aufeinander zu kommunizieren, und trägt dazu bei, Abhängigkeiten zwischen ihnen zu verringern.

Die MessagingCenter-Klasse bietet Multicast-Funktionen zum Veröffentlichen und Abonnieren. Dies bedeutet, dass mehrere Herausgeber vorhanden sein können, die eine einzelne Nachricht veröffentlichen, und es können mehrere Abonnenten vorhanden sein, die auf dieselbe Nachricht lauschen:

Multicastfunktion für Veröffentlichungen und Abonnieren

Herausgeber senden Nachrichten mithilfe der MessagingCenter.Send-Methode, während Abonnenten mithilfe der MessagingCenter.Subscribe-Methode auf Nachrichten lauschen. Darüber hinaus können Abonnenten bei Bedarf mit der MessagingCenter.Unsubscribe-Methode auch Nachrichtenabonnements kündigen.

Wichtig

Intern verwendet die MessagingCenter-Klasse schwache Verweise. Dies bedeutet, dass Objekte nicht aktiv bleiben und Garbage Collection ermöglicht wird. Daher sollte es nur erforderlich sein, eine Nachricht zu kündigen, wenn eine Klasse die Nachricht nicht mehr empfangen möchte.

Veröffentlichen einer Nachricht

MessagingCenter-Nachrichten sind Zeichenfolgen. Herausgeber benachrichtigen Abonnenten einer Nachricht mit einer der MessagingCenter.Send-Überladungen. Im folgenden Codebeispiel wird eine Hi-Nachricht veröffentlicht:

MessagingCenter.Send<MainPage>(this, "Hi");

In diesem Beispiel gibt die Send-Methode ein generisches Argument an, das den Absender darstellt. Zum Empfangen der Nachricht muss ein Abonnent das gleiche generische Argument angeben, das anzeigt, dass er auf eine Nachricht von diesem Absender lauscht. Außerdem gibt dieses Beispiel zwei Methodenargumente an:

  • Mit dem ersten Argument wird die Absenderinstanz angegeben.
  • Das zweite Argument gibt die Nachricht an.

Nutzlastdaten können ebenfalls mit einer Nachricht gesendet werden:

MessagingCenter.Send<MainPage, string>(this, "Hi", "John");

In diesem Beispiel gibt die Send-Methode zwei generische Argumente an. Das erste Argument ist der Typ, der die Nachricht sendet, und das zweite Argument gibt den Typ der zu sendenden Nutzlastdaten an. Zum Empfangen der Nachricht muss ein Abonnent dieselben generischen Argumente angeben. Dies ermöglicht mehrere Nachrichten, die eine Nachrichtenidentität gemeinsam nutzen, aber unterschiedliche Nutzlastdatentypen senden, die von verschiedenen Abonnenten empfangen werden. Außerdem gibt dieses Beispiel ein drittes Methodenargument an, das die Nutzlastdaten darstellt, die an den Abonnenten gesendet werden sollen. In diesem Fall handelt es sich bei den Nutzlastdaten um ein string-Element.

Die Send-Methode veröffentlicht die Nachricht und alle Nutzlastdaten unter Verwendung eines Fire-and-Forget-Ansatzes. Daher wird die Nachricht auch dann gesendet, wenn für den Empfang der Nachricht keine Abonnenten registriert sind. Unter diesen Umständen wird die gesendete Nachricht ignoriert.

Abonnieren einer Nachricht

Abonnenten können sich registrieren, um eine Nachricht mit einer der MessagingCenter.Subscribe-Überladungen zu empfangen. Das folgende Codebeispiel veranschaulicht dieses Verhalten:

MessagingCenter.Subscribe<MainPage> (this, "Hi", (sender) =>
{
    // Do something whenever the "Hi" message is received
});

In diesem Beispiel abonniert die Subscribe-Methode das this-Objekt für Hi-Nachrichten, die vom MainPage-Typ gesendet werden, und führt als Antwort auf den Empfang der Nachricht einen Rückrufdelegaten aus. Der als Lambdaausdruck angegebene Rückrufdelegat könnte Code sein, der die Benutzeroberfläche aktualisiert, einige Daten speichert oder einen anderen Vorgang auslöst.

Hinweis

Ein Abonnent muss möglicherweise nicht jede Instanz einer veröffentlichten Nachricht verarbeiten, und dies kann durch die generischen Typargumente gesteuert werden, die für die Subscribe-Methode angegeben werden.

Im folgenden Beispiel wird gezeigt, wie eine Nachricht abonniert wird, die Nutzlastdaten enthält:

MessagingCenter.Subscribe<MainPage, string>(this, "Hi", async (sender, arg) =>
{
    await DisplayAlert("Message received", "arg=" + arg, "OK");
});

In diesem Beispiel abonniert die Subscribe-Methode Hi-Nachrichten, die vom MainPage-Typ gesendet werden, dessen Nutzlastdaten ein string-Objekt sind. Ein Rückrufdelegat wird als Reaktion auf den Empfang einer solchen Nachricht ausgeführt, der die Nutzlastdaten in einer Benachrichtigung anzeigt.

Wichtig

Der Delegat, der von der Subscribe-Methode ausgeführt wird, wird in demselben Thread ausgeführt, der die Nachricht mit der Send-Methode veröffentlicht.

Kündigen des Abonnements einer Nachricht

Abonnenten können Nachrichten kündigen, die Sie nicht mehr erhalten möchten. Dies wird mit einer der MessagingCenter.Unsubscribe-Überladungen erreicht:

MessagingCenter.Unsubscribe<MainPage>(this, "Hi");

In diesem Beispiel kündigt die Unsubscribe-Methode das Abonnement des this-Objekts aus der vom MainPage-Typ gesendeten Hi-Nachricht.

Das Abonnement von Nachrichten, die Nutzlastdaten enthalten, sollte mithilfe der Unsubscribe-Überladung gekündigt werden, die zwei generische Argumente angibt:

MessagingCenter.Unsubscribe<MainPage, string>(this, "Hi");

In diesem Beispiel kündigt die Unsubscribe-Methode das Abonnement des this-Objekts aus der vom MainPage-Typ gesendeten Hi-Nachricht, deren Nutzlastdaten ein string-Objekt sind.