单元测试如何等待JavaFX Platform完全关闭解决连续测试报错问题

问题根因 #

JavaFX平台的设计默认是单次启动的：调用Platform.exit()仅会触发异步关闭流程，并不会重置平台的启动状态标记，因此关闭完成后无法再次调用Platform.startup()，否则就会抛出你遇到的IllegalStateException: Platform.exit has been called异常。

解决方案（按推荐优先级排序） #

方案1：测试套件全局仅启动一次JavaFX（最推荐） #

不需要每个测试用例单独启停JavaFX，在整个测试类的生命周期内仅启动、关闭一次即可，修改测试代码如下：

package sample;

import javafx.application.Platform;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import java.util.concurrent.CountDownLatch;

import static java.util.concurrent.TimeUnit.SECONDS;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

@DisplayName( "the Java FX Platform should" )
public class JavaFXSuite
{
    @BeforeAll
    static void startJFX() throws InterruptedException
    {
        final var latch = new CountDownLatch( 1 );
        Platform.startup( latch::countDown );
        assertTrue( latch.await( 1, SECONDS ) );
    }

    @AfterAll
    static void stopJFX()
    {
        Platform.exit();
    }

    @Test
    @DisplayName( "create its own application thread" )
    void firstTestPassesFine()
    {
        assertFalse( Platform.isFxApplicationThread() );
    }

    @Test
    @DisplayName( "not mess with tests that don't use the platform at all" )
    void supposedlyOrthogonalSecondTestFailsOnSetUp()
    {
        assertThat( 2, is( 2 ) );
    }
}

这种方案完全符合JavaFX的设计逻辑，不需要依赖内部API，性能也最优。

方案2：通过反射监听关闭事件，适配多轮启停场景 #

如果确实需要每个测试用例都单独启停JavaFX，可以通过动态代理+反射调用内部FinishListener接口，测试场景下可以通过添加JVM启动参数开放内部包访问权限：

1. 先给测试任务添加JVM参数（Java 9+版本需要）：

--add-exports javafx.graphics/com.sun.javafx.application=ALL-UNNAMED

2. 实现关闭监听+状态重置逻辑：

private CountDownLatch addShutdownHook() throws Exception {
    CountDownLatch latch = new CountDownLatch(1);
    Class<?> platformImplClass = Class.forName("com.sun.javafx.application.PlatformImpl");
    Class<?> finishListenerClass = Class.forName("com.sun.javafx.application.PlatformImpl$FinishListener");
    
    // 动态代理实现FinishListener接口，避免编译依赖内部API
    Object listener = Proxy.newProxyInstance(
        getClass().getClassLoader(),
        new Class[]{finishListenerClass},
        (proxy, method, args) -> {
            if (method.getName().equals("idle") || method.getName().equals("exitCalled")) {
                latch.countDown();
            }
            return null;
        }
    );
    
    // 注册关闭监听器
    Method addListenerMethod = platformImplClass.getMethod("addListener", finishListenerClass);
    addListenerMethod.invoke(null, listener);
    
    // 获取重置Platform状态的内部方法
    Method resetMethod = platformImplClass.getDeclaredMethod("reset");
    resetMethod.setAccessible(true);
    
    // 关闭完成后自动重置启动状态
    new Thread(() -> {
        try {
            latch.await(1, SECONDS);
            resetMethod.invoke(null);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }).start();
    
    return latch;
}

修改后的stopJFX逻辑如下：

@AfterEach
void stopJFX() throws Exception {
    CountDownLatch latch = addShutdownHook();
    Platform.exit();
    assertTrue(latch.await(1, SECONDS));
}

这种方案可以实现每个测试用例单独启停JavaFX，但因为依赖内部API，可能在不同JavaFX版本之间存在兼容性问题。

方案3：适配Application.launch()场景 #

如果你的测试需要调用Application.launch()，要注意该方法本身设计为整个JVM生命周期内仅能调用一次，没有通用重置方案，这种场景下建议：

• 所有需要启动Application的测试合并到同一个测试类，全局仅调用一次launch
• 测试套件规模较小的情况下，使用单测fork模式，每个测试用例跑在单独的JVM进程中

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