如何在ReactFX中正确组合多个属性更改流以用于UndoFX(或任何用例)?

细节

这是我要完成的工作的简短说明(完整的示例代码为posted at GitHub):

有一个具有两个属性的示例模型。为了简单起见,它们是双重属性

public class DataModel {
    private DoubleProperty a, b;
    //...
    //with appropriate getters, setters, equals, hashcode
    //...
}


在示例代码中,有一些按钮可以更改一个或两个属性。如果这就是更改,我想撤消对两者的更改。

根据UndoFX的示例,每个继承自基类的更改类(在此也缩写为):

public abstract class ChangeBase<T> implements UndoChange {
   protected final T oldValue, newValue;
   protected final DataModel model;

   protected ChangeBase(DataModel model, T oldValue, T newValue) {
      this.model = model;
      this.oldValue = oldValue;
      this.newValue = newValue;
   }

   public abstract ChangeBase<T> invert();
   public abstract void redo();

   public Optional<ChangeBase<?>> mergeWith(ChangeBase<?> other) {
      return Optional.empty();
   }

   @Override
   public int hashCode() {
      return Objects.hash(this.oldValue, this.newValue);
   }

   @Override
   public boolean equals(Object obj) {
      if (this == obj) {
         return true;
      }
      if (obj == null) {
         return false;
      }
      if (getClass() != obj.getClass()) {
         return false;
      }
      final ChangeBase<?> other = (ChangeBase<?>) obj;
      if (!Objects.equals(this.oldValue, other.oldValue)) {
         return false;
      }
      if (!Objects.equals(this.newValue, other.newValue)) {
         return false;
      }
      if (!Objects.equals(this.model, other.model)) {
         return false;
      }
      return true;
   }
}

public class ChangeA extends ChangeBase<Double> {
   //...
   //constructors and other method implementations
   //..
   @Override
   public void redo() {
      System.out.println("ChangeA redo "+this);
      this.model.setA(this.newValue);
   }
}

public class ChangeB extends ChangeBase<Double> {
   //...
   //constructors and other method implementations
   //...
   @Override
   public void redo() {
      System.out.println("ChangeA redo "+this);
      this.model.setB(this.newValue);
   }
}


所有更改均实现一个接口

public interface UndoChange {
   public void redo();
   public UndoChange invert();
   public Optional<UndoChange> mergeWith(UndoChange other);

}


阅读文档后,我首先创建事件流以捕获对每个属性的更改:

EventStream<UndoChange> changeAStream =
    EventStreams.changesOf(model.aProperty())
              .map(c -> new ChangeA(model, (Change<Number>)c));
EventStream<UndoChange> changeBStream =
    EventStreams.changesOf(model.bProperty())
              .map(c -> new ChangeB(model, (Change<Number>)c));


我的第一个尝试是像这样合并流

EventStream<UndoChange> bothStream = EventStreams.merge(changeAStream, changeBStream);


在这种情况下发生的情况是,如果同时更改A和B属性,则流中将有两个更改,并且每个将分别撤消而不是一起撤消。每次对setter的调用都会在相应的流中进行更改,然后将其发送到bothStream,该ChangeBoth然后包含两个单独的事件而不是一个。

经过更多阅读之后,我然后尝试将流和映射合并到单独的更改对象中:

 EventStream<UndoChange> bothStream = EventStreams.combine(changeAStream, changeBStream).map(ChangeBoth::new);


其中IllegalStateException: Unexpected change received定义为:

public class ChangeBoth implements UndoChange {

   private final ChangeA aChange;
   private final ChangeB bChange;

   public ChangeBoth(ChangeA ac, ChangeB bc) {
      this.aChange = ac;
      this.bChange = bc;
   }

   public ChangeBoth(Tuple2<UndoChange, UndoChange> tuple) {
      this.aChange = ((ChangeBoth)tuple.get1()).aChange;
      this.bChange = ((ChangeBoth)tuple.get2()).bChange;
   }

   @Override
   public UndoChange invert() {
      System.out.println("ChangeBoth invert "+this);
      return new ChangeBoth(new ChangeA(this.aChange.model, this.aChange.newValue, this.aChange.oldValue),
                            new ChangeB(this.bChange.model, this.bChange.newValue, this.bChange.oldValue));
   }

   @Override
   public void redo() {
      System.out.println("ChangeBoth redo "+this);
      DataModel model = this.aChange.model;
      model.setA(this.aChange.newValue);
      model.setB(this.bChange.newValue);
   }

   //...
   // plus appropriate mergeWith, hashcode, equals
   //...
}


这导致抛出ChangeBoth。经过一番挖掘之后,我确定了为什么会这样:invert()被撤消时(通过redo()ChangeBoth调用),它将每个属性重新设置为旧值。但是,当它设置每个属性时,更改会通过流返回,导致在将两个属性设置回旧值之间将新的changeAStream放入流中。

摘要

因此,回到我的问题:正确的方法是什么?有没有一种方法可以将两个属性的流更改为一个不会引起此问题的更改对象?

编辑-尝试1

根据Tomas的回答,我添加/更改了以下代码(注意:回购中的代码已更新):

changeBstreamsetonAction保持不变。

我没有像Tomas所建议的那样合并流,而是创建了一个二进制运算符以将两个更改简化为一个:

BinaryOperator<UndoChange> abOp = (c1, c2) -> {
   ChangeA ca = null;
   if(c1 instanceof ChangeA) {
      ca = (ChangeA)c1;
   }
   ChangeB cb = null;
   if(c2 instanceof ChangeB) {
      cb = (ChangeB)c2;
   }
   return new ChangeBoth(ca, cb);
};


并将事件流更改为

SuspendableEventStream<UndoChange> bothStream = EventStreams.merge(changeAStream, changeBStream).reducible(abOp);


现在,按钮动作未在redo()中实现,而是由事件流处理

  EventStreams.eventsOf(bothButton, ActionEvent.ACTION)
          .suspenderOf(bothStream)
          .subscribe((ActionEvent event) ->{
             System.out.println("stream action");
              model.setA(Math.random()*10.0);
              model.setB(Math.random()*10.0);
          });


这对于适当地组合事件非常有用,但是撤消对于A + B更改仍然会中断。它适用于单独的A和B更改。这是两个A + B更改然后撤消的示例

A+B Button Action in event stream
Change in A stream
Change in B stream
A+B Button Action in event stream
Change in A stream
Change in B stream
ChangeBoth attempting merge with combinedeventstreamtest.ChangeBoth@775ec8e8... merged
undo 6.897901340713284  2.853416510829745
ChangeBoth invert combinedeventstreamtest.ChangeBoth@aae83334
ChangeA invert combinedeventstreamtest.ChangeA@32ee049a
ChangeB invert combinedeventstreamtest.ChangeB@4919dd13
ChangeBoth redo combinedeventstreamtest.ChangeBoth@b2155b1e
Change in A stream
Exception in thread "JavaFX Application Thread" java.lang.IllegalArgumentException: Unexpected change received.
Expected:
combinedeventstreamtest.ChangeBoth@b2155b1e
Received:
combinedeventstreamtest.ChangeA@2ad21e08
Change in B stream


编辑-尝试2-成功!

Tomas很好地指出了解决方案(我应该意识到)。只需在执行时暂停:

  UndoManager<UndoChange> um = UndoManagerFactory.unlimitedHistoryUndoManager(
          bothStream,
          c -> c.invert(),
          c -> bothStream.suspendWhile(c::redo),
          (c1, c2) -> c1.mergeWith(c2)
  );

最佳答案

因此,任务是将在处理按钮单击期间从bothStream发出的更改合并为一个。

您将需要一个将两个UndoChange简化为一个的函数:

BinaryOperator<UndoChange> reduction = ???; // implement as appropriate


使bothStream将更改减为一,同时“暂停”:

SuspendableEventStream<UndoChange> bothStream =
        EventStreams.merge(changeAStream, changeBStream).reducible(reduction);


现在,您只需要在处理按钮单击时挂起bothStream。可以这样完成:

EventStreams.eventsOf(bothButton, ActionEvent.ACTION) // Observe actions of bothButton ...
        .suspenderOf(bothStream)                      // but suspend bothStream ...
        .subscribe((ActionEvent event) -> {           // before handling the action.
            model.setA(Math.random()*10.0);
            model.setB(Math.random()*10.0);
        })


在撤消管理器中撤消/重做更改时,还应挂起bothStream,以便在撤消组合更改时(使bothStream满意)从UndoManager发出(组合)更改的确切逆序。这可以通过将apply参数包装到UndoManager中的bothStream.suspendWhile()构造函数中来完成,例如:

UndoManagerFactory.unlimitedHistoryUndoManager(
        bothStream,
        c -> c.invert(),
        c -> bothStream.suspendWhile(c::redo)  // suspend while applying the change
)

10-01 17:58