Реактивные расширения (Rx) + MVVM =?
-
21-09-2019 - |
Вопрос
Одним из основных примеров, используемых для объяснения возможностей Reactive Extensions (Rx), является объединение существующих событий мыши в новое «событие», представляющее отклонения во время перетаскивания мыши:
var mouseMoves = from mm in mainCanvas.GetMouseMove()
let location = mm.EventArgs.GetPosition(mainCanvas)
select new { location.X, location.Y};
var mouseDiffs = mouseMoves
.Skip(1)
.Zip(mouseMoves, (l, r) => new {X1 = l.X, Y1 = l.Y, X2 = r.X, Y2 = r.Y});
var mouseDrag = from _ in mainCanvas.GetMouseLeftButtonDown()
from md in mouseDiffs.Until(
mainCanvas.GetMouseLeftButtonUp())
select md;
Источник: Введение Мэтью Подвысоцкого в серию Reactive Framework.
В MVVM я обычно стараюсь, чтобы мой файл .xaml.cs был как можно более пустым, и один из способов подключения событий из представления к командам в модели представления исключительно в разметке — использование поведения:
<Button Content="Click Me">
<Behaviors:Events.Commands>
<Behaviors:EventCommandCollection>
<Behaviors:EventCommand CommandName="MouseEnterCommand" EventName="MouseEnter" />
<Behaviors:EventCommand CommandName="MouseLeaveCommand" EventName="MouseLeave" />
<Behaviors:EventCommand CommandName="ClickCommand" EventName="Click" />
</Behaviors:EventCommandCollection>
</Behaviors:Events.Commands>
</Button>
Источник: Брайан Дженисио.
Reactive Framework, похоже, больше ориентирована на традиционный шаблон MVC, где контроллер знает представление и может напрямую ссылаться на его события.
Но я хочу и съесть свой торт, и съесть его!
Как бы вы объединили эти два шаблона?
Решение
Я написал структуру, отражающую мои исследования по этому вопросу, под названием Реактивный пользовательский интерфейс
Он реализует как Observable ICommand, так и объекты ViewModel, которые сигнализируют об изменениях через IObservable, а также возможность «назначать» IObservable свойству, которое затем будет запускать INotifyPropertyChange при каждом изменении его IObservable.Он также инкапсулирует множество общих шаблонов, например, ICommand, который запускает задачу в фоновом режиме, а затем отправляет результат обратно в пользовательский интерфейс.
На данный момент у меня нет абсолютно никакой документации, но я буду работать над добавлением этой информации в ближайшие дни, а также над примером приложения, которое я написал.
ОБНОВЛЯТЬ: У меня теперь довольно много документации, посмотрите http://www.reactiveui.net
Другие советы
Решением моей проблемы оказалось создание класса, реализующего как ICommand, так и IObservable<T>.
ICommand используется для привязки пользовательского интерфейса (с использованием поведения), а IObservable затем можно использовать в модели представления для создания составных потоков событий.
using System;
using System.Windows.Input;
namespace Jesperll
{
class ObservableCommand<T> : Observable<T>, ICommand where T : EventArgs
{
bool ICommand.CanExecute(object parameter)
{
return true;
}
event EventHandler ICommand.CanExecuteChanged
{
add { }
remove { }
}
void ICommand.Execute(object parameter)
{
try
{
OnNext((T)parameter);
}
catch (InvalidCastException e)
{
OnError(e);
}
}
}
}
Где Observable<T> показан в Реализация IObservable с нуля
Когда я начал думать о том, как «поженить» MVVM и RX, первое, о чем я подумал, это ObservableCommand:
public class ObservableCommand : ICommand, IObservable<object>
{
private readonly Subject<object> _subj = new Subject<object>();
public void Execute(object parameter)
{
_subj.OnNext(parameter);
}
public bool CanExecute(object parameter)
{
return true;
}
public event EventHandler CanExecuteChanged;
public IDisposable Subscribe(IObserver<object> observer)
{
return _subj.Subscribe(observer);
}
}
Но потом я подумал, что «стандартный» способ привязки элементов управления MVVM к свойствам ICommand не очень похож на RX, он разбивает поток событий на довольно статические связи.RX больше посвящен событиям и прослушиванию Выполнено перенаправленное событие кажется подходящим.Вот что я придумал:
1) У вас есть поведение CommandRelay, которое вы устанавливаете в корне каждого пользовательского элемента управления, который должен реагировать на команды:
public class CommandRelay : Behavior<FrameworkElement>
{
private ICommandSink _commandSink;
protected override void OnAttached()
{
base.OnAttached();
CommandManager.AddExecutedHandler(AssociatedObject, DoExecute);
CommandManager.AddCanExecuteHandler(AssociatedObject, GetCanExecute);
AssociatedObject.DataContextChanged
+= AssociatedObject_DataContextChanged;
}
protected override void OnDetaching()
{
base.OnDetaching();
CommandManager.RemoveExecutedHandler(AssociatedObject, DoExecute);
CommandManager.RemoveCanExecuteHandler(AssociatedObject, GetCanExecute);
AssociatedObject.DataContextChanged
-= AssociatedObject_DataContextChanged;
}
private static void GetCanExecute(object sender,
CanExecuteRoutedEventArgs e)
{
e.CanExecute = true;
}
private void DoExecute(object sender, ExecutedRoutedEventArgs e)
{
if (_commandSink != null)
_commandSink.Execute(e);
}
void AssociatedObject_DataContextChanged(
object sender, DependencyPropertyChangedEventArgs e)
{
_commandSink = e.NewValue as ICommandSink;
}
}
public interface ICommandSink
{
void Execute(ExecutedRoutedEventArgs args);
}
2) ViewModel, обслуживающий пользовательский элемент управления, наследуется от ReactiveViewModel:
public class ReactiveViewModel : INotifyPropertyChanged, ICommandSink
{
internal readonly Subject<ExecutedRoutedEventArgs> Commands;
public ReactiveViewModel()
{
Commands = new Subject<ExecutedRoutedEventArgs>();
}
...
public void Execute(ExecutedRoutedEventArgs args)
{
args.Handled = true; // to leave chance to handler
// to pass the event up
Commands.OnNext(args);
}
}
3) Вы не привязываете элементы управления к свойствам ICommand, а вместо этого используете RoutedCommand:
public static class MyCommands
{
private static readonly RoutedUICommand _testCommand
= new RoutedUICommand();
public static RoutedUICommand TestCommand
{ get { return _testCommand; } }
}
И в XAML:
<Button x:Name="btn" Content="Test" Command="ViewModel:MyCommands.TestCommand"/>
В результате в вашей ViewModel вы можете слушать команды в режиме RX:
public MyVM() : ReactiveViewModel
{
Commands
.Where(p => p.Command == MyCommands.TestCommand)
.Subscribe(DoTestCommand);
Commands
.Where(p => p.Command == MyCommands.ChangeCommand)
.Subscribe(DoChangeCommand);
Commands.Subscribe(a => Console.WriteLine("command logged"));
}
Теперь у вас есть возможность перенаправления команд (вы можете выбрать обработку команды в любой или даже нескольких моделях ViewModel в иерархии), плюс у вас есть «единый поток» для всех команд, который удобнее для RX, чем отдельные IObservable. .
Это также должно быть вполне осуществимо с помощью ReactiveFramework.
Единственное необходимое изменение — создать для этого поведение, а затем подключить его к команде.Это будет выглядеть примерно так:
<Button Content="Click Me">
<Behaviors:Events.Commands>
<Behaviors:EventCommandCollection>
<Behaviors:ReactiveEventCommand CommandName="MouseEnterCommand" EventName="MouseEnter" />
<Behaviors:ReactiveEventCommand CommandName="MouseLeaveCommand" EventName="MouseLeave" />
<Behaviors:ReactiveEventCommand CommandName="ClickCommand" EventName="Click" />
</Behaviors:EventCommandCollection>
</Behaviors:Events.Commands>
</Button>
Просто поймите, что EventCommand работает очень похоже на то, как в этом сценарии будет работать ReactiveFramework.На самом деле вы не увидите разницы, хотя реализация EventCommand будет упрощена.
EventCommand уже предоставляет вам модель push — когда происходит событие, он запускает вашу команду.Это основной сценарий использования Rx, но он упрощает реализацию.
Я думаю, что идея заключалась в том, чтобы создать событие «аккорд», в данном случае, вероятно, операцию перетаскивания, которая приводит к вызову команды?Это будет сделано почти так же, как и в выделенном коде, но с использованием кода в поведении.Например, создайте DragBehavior, который использует Rx для объединения событий MouseDown/MouseMove/MouseUp с командой, вызываемой для обработки нового «события».