Design patterns
Obserwator

Uwagi

Observer / Java

Wzorzec obserwatora pozwala użytkownikom klasy subskrybować zdarzenia, które mają miejsce, gdy ta klasa przetwarza dane itp. Oraz otrzymywać powiadomienia o wystąpieniu tego zdarzenia. W poniższym przykładzie tworzymy klasę przetwarzania i klasę obserwatora, które zostaną powiadomione podczas przetwarzania frazy - jeśli znajdzie słowa dłuższe niż 5 liter.

Interfejs LongWordsObserver definiuje obserwatora. Zaimplementuj ten interfejs, aby zarejestrować obserwatora w zdarzeniach.

// an observe that can be registered and receive notifications
public interface LongWordsObserver {
    void notify(WordEvent event);
}

Klasa WordEvent to zdarzenie, które zostanie wysłane do klas obserwatora po wystąpieniu określonych zdarzeń (w tym przypadku znaleziono długie słowa)

// An event class which contains the long word that was found
public class WordEvent {

    private String word;

    public WordEvent(String word) {
        this.word = word;
    }

    public String getWord() {
        return word;
    }
}

Klasa PhraseProcessor to klasa przetwarzająca podane wyrażenie. Umożliwia rejestrację obserwatorów przy użyciu metody addObserver . Po znalezieniu długich słów obserwatorzy ci zostaną wywołani przy użyciu instancji klasy WordEvent .

import java.util.ArrayList;
import java.util.List;

public class PhraseProcessor {

    // the list of observers
    private List<LongWordsObserver> observers = new ArrayList<>();

    // register an observer
    public void addObserver(LongWordsObserver observer) {
        observers.add(observer);
    }

    // inform all the observers that a long word was found
    private void informObservers(String word) {
        observers.forEach(o -> o.notify(new WordEvent(word)));
    }

    // the main method - process a phrase and look for long words. If such are found,
    // notify all the observers
    public void process(String phrase) {
        for (String word : phrase.split(" ")) {
            if (word.length() > 5) {
                informObservers(word);
            }
        }
    }
}

Klasa LongWordsExample pokazuje, jak rejestrować obserwatorów, wywoływać metodę process i otrzymywać powiadomienia o znalezieniu długich słów.

import java.util.ArrayList;
import java.util.List;

public class LongWordsExample {

    public static void main(String[] args) {

        // create a list of words to be filled when long words were found
        List<String> longWords = new ArrayList<>();

        // create the PhraseProcessor class
        PhraseProcessor processor = new PhraseProcessor();

        // register an observer and specify what it should do when it receives events,
        // namely to append long words in the longwords list
        processor.addObserver(event -> longWords.add(event.getWord()));

        // call the process method 
        processor.process("Lorem ipsum dolor sit amet, consectetuer adipiscing elit");

        // show the list of long words after the processing is done
        System.out.println(String.join(", ", longWords));
        // consectetuer, adipiscing
    }
}

Obserwator używający IObservable i IObserver (C #)

IObserver<T> i IObservable<T> mogą być używane do implementacji wzorca obserwatora w .NET

• IObservable<T> reprezentuje klasę, która wysyła powiadomienia
• IObserver<T> reprezentuje klasę, która je odbiera

public class Stock {
  private string Symbol { get; set; }
  private decimal Price { get; set; }
}

public class Investor : IObserver<Stock> {
  public IDisposable unsubscriber;
  public virtual void Subscribe(IObservable<Stock> provider) {
    if(provider != null) {
      unsubscriber = provider.Subscribe(this);
    }
  }
  public virtual void OnCompleted() {
    unsubscriber.Dispose();
  }
  public virtual void OnError(Exception e) {
  }
  public virtual void OnNext(Stock stock) {
  }
}

public class StockTrader : IObservable<Stock> {
  public StockTrader() {
    observers = new List<IObserver<Stock>>();
  }
  private IList<IObserver<Stock>> observers;
  public IDisposable Subscribe(IObserver<Stock> observer) {
    if(!observers.Contains(observer)) {
      observers.Add(observer);
    }
    return new Unsubscriber(observers, observer);
  }
  public class Unsubscriber : IDisposable {
    private IList<IObserver<Stock>> _observers;
    private IObserver<Stock> _observer;

    public Unsubscriber(IList<IObserver<Stock>> observers, IObserver<Stock> observer) {
      _observers = observers;
      _observer = observer;
    }

    public void Dispose() {
      Dispose(true);
    }
    private bool _disposed = false;
    protected virtual void Dispose(bool disposing) {
      if(_disposed) {
        return;
      }
      if(disposing) {
        if(_observer != null && _observers.Contains(_observer)) {
          _observers.Remove(_observer);
        }
      }
      _disposed = true;
    }
  }
  public void Trade(Stock stock) {
    foreach(var observer in observers) {
      if(stock== null) {
        observer.OnError(new ArgumentNullException());
      }
      observer.OnNext(stock);
    }
  }
  public void End() {
    foreach(var observer in observers.ToArray()) {
      observer.OnCompleted();
    }
    observers.Clear();
  }
}

Stosowanie

...
var provider = new StockTrader();
var i1 = new Investor();
i1.Subscribe(provider);
var i2 = new Investor();
i2.Subscribe(provider);

provider.Trade(new Stock());
provider.Trade(new Stock());
provider.Trade(null);
provider.End();
...

ODNIESIENIE: Projektowanie wzorców i praktyk w .NET: wzorzec Observer