如何为使用SpriteBatch及OpenGL相关方法/类的LibGDX应用编写单元测试？

我一直在尝试使用headless-backend库来为ScreenAdapter的子类MainMenuScreen编写单元测试，但遇到两个棘手的问题：

• A) MainMenuScreen在初始化时使用了SpriteBatch类，据我所知没有办法mock它；
• B) 我不确定是否正确设置了无头应用。我目前用Maven管理依赖，JUnit做测试框架，JaCoCo来统计测试覆盖率。

我的核心问题是：

如何为MainMenuClass设置无头应用？如果做不到，有没有其他方法可以对使用LibGDX和OpenGL方法/类（尤其是SpriteBatch）的类进行单元测试？

我已经做过的研究 #

• gdx-backend的Java官方文档：内容非常稀疏，没有任何示例或代码工作原理的解释，几乎起不到指导作用。
• Stack Overflow上的相关问题：其中一个回答给出了在setup方法中使用HeadlessApplication的最佳示例，但我感觉需要为要测试的类单独创建无头版本，完全不知道该怎么操作。
• Tom Grill的gdx-testing库：我99%确定它的作用是将依赖LibGDX的代码转换为无头应用，但每次尝试集成它都以失败告终。

我的单元测试代码 #

public class MainMenuTest {
    final MazeGame testGame = mock(MazeGame.class);
    private MainMenuScreen testScreen;
    private HeadlessApplication app;


    // TODO: get the headless backend working; the current problem is getting OpenGL methods working
    @BeforeEach
    public void setup() {
        MockGraphics mockGraphics = new MockGraphics();
        Gdx.graphics = mockGraphics;
        Gdx.gl = mock(GL20.class);

        testScreen = new MainMenuScreen(testGame);
        HeadlessApplicationConfiguration config = new HeadlessApplicationConfiguration();
        app = new HeadlessApplication(new ApplicationListener() {
            @Override
            public void create() {
                // Set the screen to MainMenuScreen directly
                testScreen = new MainMenuScreen(testGame); // Pass null or a mock game instance if necessary
            }
            @Override
            public void resize(int width, int height) {}
            @Override
            public void render() {
                testScreen.render(1 / 60f); // Simulate a frame render
            }
            @Override
            public void pause() {}
            @Override
            public void resume() {}
            @Override
            public void dispose() {
                testScreen.dispose();
            }
        }, config);
    }


    /**
     * Test to see if the start button works.
     */
    @Test
    public void startButtonWorks() {
        // doesn't click start button
        Button startButton = testScreen.getStartButton();
        assertEquals(false, startButton.isChecked());


        // clicks start button
        ((ChangeListener) (startButton.getListeners().first())).changed(new ChangeEvent(), startButton);
        assertEquals(true, startButton.isChecked());
    }
}

当前执行mvn test时的错误 #

执行测试时触发了与OpenGL上下文未正确初始化相关的异常（具体表现为SpriteBatch创建失败）。

解决方案 #

针对你的问题，我会从几个维度给出可行的解决思路：

1. 正确配置HeadlessApplication并修复测试初始化逻辑

你当前的测试代码存在两个关键问题：一是在HeadlessApplication创建前就实例化了testScreen（此时LibGDX的核心服务尚未初始化），二是手动Mock了Gdx.graphics和Gdx.gl，这会与HeadlessApplication自动初始化的环境冲突。调整后的setup代码如下：

public class MainMenuTest {
    private MazeGame testGame;
    private MainMenuScreen testScreen;
    private HeadlessApplication app;

    @BeforeEach
    public void setup() {
        // 配置无头应用参数，模拟60fps渲染间隔
        HeadlessApplicationConfiguration config = new HeadlessApplicationConfiguration();
        config.renderInterval = 1f / 60f;

        // 初始化无头应用，所有依赖LibGDX的类必须在ApplicationListener的create方法内创建
        app = new HeadlessApplication(new ApplicationListener() {
            @Override
            public void create() {
                // 使用Mock的游戏实例
                testGame = Mockito.mock(MazeGame.class);
                // 此时Gdx.gl、Gdx.graphics已由HeadlessApplication自动初始化完成
                testScreen = new MainMenuScreen(testGame);
            }

            @Override
            public void resize(int width, int height) {}

            @Override
            public void render() {
                if (testScreen != null) {
                    testScreen.render(config.renderInterval);
                }
            }

            @Override
            public void pause() {}

            @Override
            public void resume() {}

            @Override
            public void dispose() {
                if (testScreen != null) {
                    testScreen.dispose();
                }
            }
        }, config);
    }

    @AfterEach
    public void teardown() {
        // 测试结束后清理应用资源，避免内存泄漏
        if (app != null) {
            app.exit();
        }
    }

    @Test
    public void startButtonWorks() {
        // 验证按钮初始状态
        Button startButton = testScreen.getStartButton();
        Assertions.assertEquals(false, startButton.isChecked());

        // 模拟按钮点击事件
        ChangeListener listener = (ChangeListener) startButton.getListeners().first();
        listener.changed(new ChangeEvent(), startButton);
        Assertions.assertEquals(true, startButton.isChecked());
    }
}

2. 处理SpriteBatch的依赖问题

如果你的MainMenuScreen直接在内部创建SpriteBatch，确实很难Mock。推荐使用依赖注入来解耦：

public class MainMenuScreen extends ScreenAdapter {
    private final MazeGame game;
    private final SpriteBatch spriteBatch;
    private Button startButton;

    // 供测试使用的构造函数，允许传入自定义SpriteBatch
    public MainMenuScreen(MazeGame game, SpriteBatch spriteBatch) {
        this.game = game;
        this.spriteBatch = spriteBatch;
        initUI(); // 初始化UI的方法
    }

    // 供生产环境使用的默认构造函数
    public MainMenuScreen(MazeGame game) {
        this(game, new SpriteBatch());
    }

    private void initUI() {
        // 这里写你的UI初始化逻辑，比如创建startButton
    }

    // 其他方法...
}

这样在测试中，你可以直接使用Headless环境初始化好的SpriteBatch，甚至用Mockito Spy包装真实实例来验证调用行为。

3. 更彻底的解耦：分离业务与渲染逻辑

如果OpenGL相关的问题始终无法解决，最彻底的方案是将业务逻辑与渲染逻辑完全分离：

• 创建MainMenuLogic类，专门处理按钮点击、状态管理等业务逻辑；
• MainMenuScreen只负责渲染UI，并将用户输入转发给MainMenuLogic；
• 直接测试MainMenuLogic，完全不依赖LibGDX的渲染类。

这种方式不仅让测试更简单，也让代码的可维护性大幅提升。

4. 错误排查关键点

你当前遇到的错误本质是SpriteBatch在没有有效OpenGL上下文的环境中被创建。只要确保所有依赖LibGDX的类都在ApplicationListener#create方法内实例化，就能避免这个问题——因为HeadlessApplication会在调用create前完成OpenGL上下文的模拟初始化。

备注：内容来源于stack exchange，提问作者Caleb Hengeveld