如何在Vaadin 24的onDetach方法中识别UI重同步场景？

问题描述 #

在Vaadin 24.4.10应用中，部分自定义组件通过实现onDetach方法释放构造函数中初始化的资源，以此实现内存提前释放（比如用户切换表单时）。但遇到UI重同步场景时，ServerRpcHandler.handleRpc会调用ui.getInternals().getStateTree().prepareForResync()，这会先触发组件的onDetach执行资源清理，随后又调用onAttach。此时组件资源已被清理，若不重新执行构造逻辑则无法正常使用。

可选解决方案 #

方案1：迁移初始化逻辑至onAttach #

将构造函数中的资源初始化逻辑迁移到onAttach方法中，每次组件attach时重新初始化资源，onDetach正常执行清理。此方案需要调整组件的初始化流程，工作量和代码改动风险较高。

方案2：在onDetach中识别重同步场景（推荐） #

通过Vaadin公开API判断当前是否处于重同步过程，仅在非重同步场景下执行资源清理，无需大幅改动现有代码。

实现代码

在自定义组件的onDetach方法中，通过UIInternals.isResyncInProgress()方法判断当前场景：

@Override
protected void onDetach(DetachEvent event) {
    // 仅在非重同步场景下执行资源清理
    if (!UI.getCurrent().getInternals().isResyncInProgress()) {
        // 执行你的资源释放逻辑，比如关闭连接、清理缓存等
        releaseComponentResources();
    }
    super.onDetach(event);
}

原理说明

Vaadin的UIInternals类提供了公开的isResyncInProgress()方法，用于标识当前UI是否处于重同步流程中。在prepareForResync()执行时，该标志会被设为true，重同步完成后自动重置为false。通过这个标志可以安全区分正常detach和重同步导致的detach，避免误清理资源。

此方案依赖Vaadin公开API，相比堆栈跟踪的临时方案，兼容性和稳定性更强，能更好适配未来版本的迭代。

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