ZK Framework中setter晚于onChange执行的原因咨询

问题描述 #

我在ZK Framework中遇到一个问题：datebox组件对应的setter方法总是在onChange事件之后才被调用。

我的zul文件里的datebox组件：

<datebox id="date" value="@bind(form.date)" width="100%" />

对应的表单类（包含正确的getter和setter）：

@Form("MyForm")
public class MyForm {

    private Date date;

    public MyForm() {}
    
    public Date getDate() {
       return date;
    }
    public void setDate(Date date) {
       this.date = date;
    }
}

在模态窗口的Screen类中，我注入了这个表单，尝试在onChange方法中获取表单的date值，但发现setter是在onChange逻辑执行完后才调用的：

@Screen
public class MyScreen {
 
   @Autowired
   @Qualifier("MyForm")
   private MyForm form; // 注：原代码里的MyFormform是拼写错误，应为MyForm form

   private Datebox date;

   @Override
   public MyForm getForm() { // 注：原代码里的MEALS_Form应为MyForm
       return form;
   }

   public void onChange$date(InputEvent event) {
       System.out.println(form.getDate()); // 这里打印的是旧值，因为setter还没执行
   }
}

原因分析 #

这是ZK请求处理生命周期的固有顺序导致的，完整的请求处理流程是：

1. 服务器接收浏览器发送的组件变更请求，解析出datebox的新值
2. 触发组件的事件监听器（也就是你的onChange$date方法）
3. 执行双向数据绑定的同步操作：将datebox的新值同步到绑定的MyForm对象，调用setDate方法
4. 渲染更新后的组件，将响应返回给浏览器

所以在onChange$date执行时，数据绑定的同步还没完成，setDate还没被调用，自然拿不到最新值。

解决办法 #

办法1：直接从事件对象获取新值 #

不需要依赖表单对象，直接从InputEvent里拿到最新的日期值，这是最直接的方式：

public void onChange$date(InputEvent event) {
    Date newDate = (Date) event.getValue();
    System.out.println(newDate);
    // 如果需要手动同步到表单，也可以直接调用setter
    form.setDate(newDate);
}

办法2：使用@Command替代直接的onChange监听 #

通过ZK的命令绑定，可以让方法在数据绑定同步完成后执行，这样就能直接拿到表单里的最新值：

1. 修改zul文件，将onChange绑定到一个命令：

<datebox id="date" value="@bind(form.date)" onChange="@command('dateChanged')" width="100%" />

2. 在Screen类中添加对应的@Command方法：

@Command
public void dateChanged() {
    // 此时数据绑定已完成，setDate已经被调用
    System.out.println(form.getDate());
}

办法3：手动触发绑定同步（不推荐，除非特殊场景） #

如果一定要在onChange事件里拿到表单的最新值，可以手动触发数据绑定的同步操作：

public void onChange$date(InputEvent event) {
    // 手动同步组件值到表单对象
    BindUtils.postNotifyChange(null, null, form, "date");
    // 此时就能拿到最新值
    System.out.println(form.getDate());
}

不过这种方式会额外触发一次绑定同步，一般推荐前两种更简洁的方案。

内容的提问来源于stack exchange，提问作者user18974278