Супер-простой пример наблюдателя / наблюдаемого C # с делегатами


131

Я недавно начал копаться в C #, но я не могу своей жизнью понять, как работают делегаты при реализации шаблона наблюдатель / наблюдаемый в языке.

Может ли кто-нибудь дать мне супер-простой пример того, как это делается? Я бы гугле, но все примеры , которые я нашел , были либо слишком проблемы конкретных или слишком «раздутыми».

Ответы:


218

Шаблон наблюдателя обычно реализуется с помощью событий .

Вот пример:

using System;

class Observable
{
    public event EventHandler SomethingHappened;

    public void DoSomething() =>
        SomethingHappened?.Invoke(this, EventArgs.Empty);
}

class Observer
{
    public void HandleEvent(object sender, EventArgs args)
    {
        Console.WriteLine("Something happened to " + sender);
    }
}

class Test
{
    static void Main()
    {
        Observable observable = new Observable();
        Observer observer = new Observer();
        observable.SomethingHappened += observer.HandleEvent;

        observable.DoSomething();
    }
}

См. Связанную статью для более подробной информации.

Обратите внимание, что в приведенном выше примере используется условный оператор NULL в C # 6 для DoSomethingбезопасной реализации для обработки случаев, когда SomethingHappenedне был подписан, и поэтому имеет значение NULL. Если вы используете старую версию C #, вам понадобится такой код:

public void DoSomething()
{
    var handler = SomethingHappened;
    if (handler != null)
    {
        handler(this, EventArgs.Empty);
    }
}

17
Чтобы сэкономить несколько строк и избежать нулевой проверки, инициализируйте свое событие следующим образом: stackoverflow.com/questions/340610/…
Дина

1
@ Дина: Это не позволяет избежать нулевой проверки. Вы все еще можете установить SomethingHappened = nullпозже (удобный, если ленивый и неидеальный способ отписаться от всех обработчиков), поэтому проверка на null всегда необходима.
Дэн Пьюзи

4
@DanPuzey: Вы можете внутри класса, но в равной степени вы можете убедиться, что вы этого не делаете - и другой код не может этого сделать, поскольку он может только подписываться и отказываться от подписки. Если вы гарантируете, что никогда не устанавливаете его в значение null намеренно в своем классе, можно избежать проверки на null.
Джон Скит,

2
@JonSkeet: конечно, я забыл, что нельзя делать это вне класса. Извиняюсь!
Дэн Пьюзи

2
Я думаю, вы можете заменить все вещи в DoSomething наSomethingHappened?.Invoke(this, EventArgs.Empty);
Джуниор

16

Вот простой пример:

public class ObservableClass
{
    private Int32 _Value;

    public Int32 Value
    {
        get { return _Value; }
        set
        {
            if (_Value != value)
            {
                _Value = value;
                OnValueChanged();
            }
        }
    }

    public event EventHandler ValueChanged;

    protected void OnValueChanged()
    {
        if (ValueChanged != null)
            ValueChanged(this, EventArgs.Empty);
    }
}

public class ObserverClass
{
    public ObserverClass(ObservableClass observable)
    {
        observable.ValueChanged += TheValueChanged;
    }

    private void TheValueChanged(Object sender, EventArgs e)
    {
        Console.Out.WriteLine("Value changed to " +
            ((ObservableClass)sender).Value);
    }
}

public class Program
{
    public static void Main()
    {
        ObservableClass observable = new ObservableClass();
        ObserverClass observer = new ObserverClass(observable);
        observable.Value = 10;
    }
}

Примечание:

  • Это нарушает правило, заключающееся в том, что я не отвязываю наблюдателя от наблюдаемого, возможно, этого достаточно для этого простого примера, но убедитесь, что вы не заставляете наблюдателей зависать от ваших событий таким образом. Способ справиться с этим - сделать ObserverClass IDisposable и позволить методу .Dispose делать противоположное коду в конструкторе.
  • Проверка ошибок не выполняется, по крайней мере, проверка на null должна выполняться в конструкторе ObserverClass.

15

В этой модели у вас есть издатели, которые выполнят некоторую логику и опубликуют «событие».
Издатели будут разослать свое событие только подписчикам, которые подписались на получение конкретного события.

В C # любой объект может публиковать набор событий, на которые могут подписаться другие приложения.
Когда класс публикации вызывает событие, все подписанные приложения получают уведомление.
На следующем рисунке показан этот механизм.

введите описание изображения здесь

Простейший возможный пример для событий и делегатов в C #:

код не требует пояснений. Также я добавил комментарии, чтобы прояснить код.

  using System;

public class Publisher //main publisher class which will invoke methods of all subscriber classes
{
    public delegate void TickHandler(Publisher m, EventArgs e); //declaring a delegate
    public TickHandler Tick;     //creating an object of delegate
    public EventArgs e = null;   //set 2nd paramter empty
    public void Start()     //starting point of thread
    {
        while (true)
        {
            System.Threading.Thread.Sleep(300);
            if (Tick != null)   //check if delegate object points to any listener classes method
            {
                Tick(this, e);  //if it points i.e. not null then invoke that method!
            }
        }
    }
}

public class Subscriber1                //1st subscriber class
{
    public void Subscribe(Publisher m)  //get the object of pubisher class
    {
        m.Tick += HeardIt;              //attach listener class method to publisher class delegate object
    }
    private void HeardIt(Publisher m, EventArgs e)   //subscriber class method
    {
        System.Console.WriteLine("Heard It by Listener");
    }

}
public class Subscriber2                   //2nd subscriber class
{
    public void Subscribe2(Publisher m)    //get the object of pubisher class
    {
        m.Tick += HeardIt;               //attach listener class method to publisher class delegate object
    }
    private void HeardIt(Publisher m, EventArgs e)   //subscriber class method
    {
        System.Console.WriteLine("Heard It by Listener2");
    }

}

class Test
{
    static void Main()
    {
        Publisher m = new Publisher();      //create an object of publisher class which will later be passed on subscriber classes
        Subscriber1 l = new Subscriber1();  //create object of 1st subscriber class
        Subscriber2 l2 = new Subscriber2(); //create object of 2nd subscriber class
        l.Subscribe(m);     //we pass object of publisher class to access delegate of publisher class
        l2.Subscribe2(m);   //we pass object of publisher class to access delegate of publisher class

        m.Start();          //starting point of publisher class
    }
}

Вывод:

Слышал это слушателем

Слышал это Listener2

Слышал это слушателем

Слышал это Listener2

Слышал это слушателем. , , (бесконечное количество раз)


6

Я связал вместе пару замечательных примеров выше (спасибо, как всегда, мистеру Скиту и мистеру Карлсену ), чтобы включить пару разных Observables, и использовал интерфейс, чтобы отслеживать их в Observer, и позволил Observer для "наблюдения" за любым количеством Observable через внутренний список:

namespace ObservablePattern
{
    using System;
    using System.Collections.Generic;

    internal static class Program
    {
        private static void Main()
        {
            var observable = new Observable();
            var anotherObservable = new AnotherObservable();

            using (IObserver observer = new Observer(observable))
            {
                observable.DoSomething();
                observer.Add(anotherObservable);
                anotherObservable.DoSomething();
            }

            Console.ReadLine();
        }
    }

    internal interface IObservable
    {
        event EventHandler SomethingHappened;
    }

    internal sealed class Observable : IObservable
    {
        public event EventHandler SomethingHappened;

        public void DoSomething()
        {
            var handler = this.SomethingHappened;

            Console.WriteLine("About to do something.");
            if (handler != null)
            {
                handler(this, EventArgs.Empty);
            }
        }
    }

    internal sealed class AnotherObservable : IObservable
    {
        public event EventHandler SomethingHappened;

        public void DoSomething()
        {
            var handler = this.SomethingHappened;

            Console.WriteLine("About to do something different.");
            if (handler != null)
            {
                handler(this, EventArgs.Empty);
            }
        }
    }

    internal interface IObserver : IDisposable
    {
        void Add(IObservable observable);

        void Remove(IObservable observable);
    }

    internal sealed class Observer : IObserver
    {
        private readonly Lazy<IList<IObservable>> observables =
            new Lazy<IList<IObservable>>(() => new List<IObservable>());

        public Observer()
        {
        }

        public Observer(IObservable observable) : this()
        {
            this.Add(observable);
        }

        public void Add(IObservable observable)
        {
            if (observable == null)
            {
                return;
            }

            lock (this.observables)
            {
                this.observables.Value.Add(observable);
                observable.SomethingHappened += HandleEvent;
            }
        }

        public void Remove(IObservable observable)
        {
            if (observable == null)
            {
                return;
            }

            lock (this.observables)
            {
                observable.SomethingHappened -= HandleEvent;
                this.observables.Value.Remove(observable);
            }
        }

        public void Dispose()
        {
            for (var i = this.observables.Value.Count - 1; i >= 0; i--)
            {
                this.Remove(this.observables.Value[i]);
            }
        }

        private static void HandleEvent(object sender, EventArgs args)
        {
            Console.WriteLine("Something happened to " + sender);
        }
    }
}

Я знаю, что это старый, но ... Это выглядит потокобезопасным, но это не так. И в Observer.Add, и в Observer.Remove проверка на null должна находиться внутри блокировки. Dispose должен также получить блокировку и установить флаг isDispised. В остальном хороший, полный пример.
user5151179

5

Применение шаблона наблюдателя с делегатами и событиями в C # называется «Шаблон событий» в соответствии с MSDN, что является небольшим изменением.

В этой статье вы найдете хорошо структурированные примеры того, как применять шаблон в C # как классическим способом, так и с использованием делегатов и событий.

Изучение паттерна разработки Observer

public class Stock
{

    //declare a delegate for the event
    public delegate void AskPriceChangedHandler(object sender,
          AskPriceChangedEventArgs e);
    //declare the event using the delegate
    public event AskPriceChangedHandler AskPriceChanged;

    //instance variable for ask price
    object _askPrice;

    //property for ask price
    public object AskPrice
    {

        set
        {
            //set the instance variable
            _askPrice = value;

            //fire the event
            OnAskPriceChanged();
        }

    }//AskPrice property

    //method to fire event delegate with proper name
    protected void OnAskPriceChanged()
    {

        AskPriceChanged(this, new AskPriceChangedEventArgs(_askPrice));

    }//AskPriceChanged

}//Stock class

//specialized event class for the askpricechanged event
public class AskPriceChangedEventArgs : EventArgs
{

    //instance variable to store the ask price
    private object _askPrice;

    //constructor that sets askprice
    public AskPriceChangedEventArgs(object askPrice) { _askPrice = askPrice; }

    //public property for the ask price
    public object AskPrice { get { return _askPrice; } }

}//AskPriceChangedEventArgs

1
    /**********************Simple Example ***********************/    

class Program
        {
            static void Main(string[] args)
            {
                Parent p = new Parent();
            }
        }

        ////////////////////////////////////////////

        public delegate void DelegateName(string data);

        class Child
        {
            public event DelegateName delegateName;

            public void call()
            {
                delegateName("Narottam");
            }
        }

        ///////////////////////////////////////////

        class Parent
        {
            public Parent()
            {
                Child c = new Child();
                c.delegateName += new DelegateName(print);
                //or like this
                //c.delegateName += print;
                c.call();
            }

            public void print(string name)
            {
                Console.WriteLine("yes we got the name : " + name);
            }
        }

0

Я не хотел изменять исходный код для добавления дополнительного наблюдателя, поэтому написал следующий простой пример:

//EVENT DRIVEN OBSERVER PATTERN
public class Publisher
{
    public Publisher()
    {
        var observable = new Observable();
        observable.PublishData("Hello World!");
    }
}

//Server will send data to this class's PublishData method
public class Observable
{
    public event Receive OnReceive;

    public void PublishData(string data)
    {
        //Add all the observer below
        //1st observer
        IObserver iObserver = new Observer1();
        this.OnReceive += iObserver.ReceiveData;
        //2nd observer
        IObserver iObserver2 = new Observer2();
        this.OnReceive += iObserver2.ReceiveData;

        //publish data 
        var handler = OnReceive;
        if (handler != null)
        {
            handler(data);
        }
    }
}

public interface IObserver
{
    void ReceiveData(string data);
}

//Observer example
public class Observer1 : IObserver
{
    public void ReceiveData(string data)
    {
        //sample observers does nothing with data :)
    }
}

public class Observer2 : IObserver
{
    public void ReceiveData(string data)
    {
        //sample observers does nothing with data :)
    }
}

0

Что-то вроде этого:

// interface implementation publisher
public delegate void eiSubjectEventHandler(eiSubject subject);

public interface eiSubject
{
    event eiSubjectEventHandler OnUpdate;

    void GenereteEventUpdate();

}

// class implementation publisher
class ecSubject : eiSubject
{
    private event eiSubjectEventHandler _OnUpdate = null;
    public event eiSubjectEventHandler OnUpdate
    {
        add
        {
            lock (this)
            {
                _OnUpdate -= value;
                _OnUpdate += value;
            }
        }
        remove { lock (this) { _OnUpdate -= value; } }
    }

    public void GenereteEventUpdate()
    {
        eiSubjectEventHandler handler = _OnUpdate;

        if (handler != null)
        {
            handler(this);
        }
    }

}

// interface implementation subscriber
public interface eiObserver
{
    void DoOnUpdate(eiSubject subject);

}

// class implementation subscriber
class ecObserver : eiObserver
{
    public virtual void DoOnUpdate(eiSubject subject)
    {
    }
}

, шаблон наблюдателя C # с событием . ссылка на репозиторий

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.