游戏引擎 / 系统课时

场景重启时清理监听和定时器

场景重启时清理监听和定时器

关卡重开后,一次按键却加分多次,通常是上一轮向全局事件源注册的回调没有解绑。本课用 Phaser 4.2.1 制作可反复重启的计分场景,在 shutdown 或 destroy 时释放监听和计时器,并验证重开后仍然只响应一次。

学习目标

  • 区分场景重启触发的 shutdown 与永久移除触发的 destroy。
  • 保存事件处理函数和计时器句柄,在退出阶段准确解除绑定。
  • 连续重启关卡,检查事件监听数量和计时速度是否正常。

重启时哪些资源会留下

this.scene.restart() 会停止当前场景并再次执行 init()、create();通常复用同一个 Scene 实例。若每次 create() 都向跨场景的事件总线调用 on(),却不调用对应的 off(),重启四次后可能累积五份监听:发出一次事件会执行五次回调。

重点检查三类资源:全局或其他场景的 EventEmitter 订阅、window 等浏览器事件监听、场景内的循环定时器。this.time.addEvent() 受 Phaser 场景 Clock 管理,Clock 在 shutdown 时会自动停止其定时任务;仍建议保存 TimerEvent 并显式 remove(),使清理职责清晰。原生 setInterval() 不归 Phaser 管理,必须配对 clearInterval()。

选择正确的清理时机

时机 发生条件 该做什么
SHUTDOWN restart()、stop() 等使场景停止 解绑共享总线、DOM 监听,取消本轮计时器
DESTROY 场景被永久移除或销毁 兜底解除剩余订阅,并释放场景专属外部资源
PAUSE / SLEEP 暂停或休眠,之后可能恢复 不触发 shutdown;按需求另行屏蔽输入或暂停外部任务

清理必须与注册一一对应。Phaser 的 off(event, fn, context) 需要与 on() 使用相同的函数和上下文;DOM 的 removeEventListener() 也需要相同函数引用。不要在共享事件总线上调用 removeAllListeners(),否则可能误删其他场景的订阅。为避免重启时积累 DESTROY 兜底回调,示例会在 shutdown 清理时一起撤销这份兜底注册。

场景重启与销毁时的监听和定时器清理关系

实现可反复重开的计分场景

使用 Node.js 20.19+ 和 Vite 创建原生 JavaScript 工程;以下代码适用 Phaser 4.2.1。先在终端执行:

bash
npm create vite@latest phaser-cleanup -- --template vanilla
cd phaser-cleanup
npm install
npm install phaser@4.2.1

预期结果:命令正常结束,项目包含 src/main.js,并已安装 Phaser 4.2.1。接着用下面内容完整替换 src/main.js:

js
import Phaser from 'phaser';

// 故意放在 Scene 外,模拟跨场景共享的事件源。
const bus = new Phaser.Events.EventEmitter();

class LevelScene extends Phaser.Scene {
  constructor() {
    super('Level');
  }

  init() {
    this.score = 0;
    this.seconds = 0;
  }

  create() {
    this.add.text(20, 20, '空格:加分    R:重开', {
      fontSize: '22px', color: '#ffffff'
    });
    this.scoreText = this.add.text(20, 65, '得分:0', {
      fontSize: '24px', color: '#ffffff'
    });
    this.timeText = this.add.text(20, 110, '计时:0 秒', {
      fontSize: '24px', color: '#ffffff'
    });

    bus.on('gain-point', this.onGainPoint, this);
    this.keyHandler = (event) => {
      if (event.repeat) return; // 按住键时避免重复触发
      if (event.code === 'Space') {
        event.preventDefault();
        bus.emit('gain-point');
      } else if (event.code === 'KeyR') {
        this.scene.restart();
      }
    };
    window.addEventListener('keydown', this.keyHandler);

    this.tick = this.time.addEvent({
      delay: 1000,
      loop: true,
      callback: () => {
        this.seconds += 1;
        this.timeText.setText(`计时:${this.seconds} 秒`);
      }
    });

    // 每轮注册退出清理,并以 destroy 做兜底。
    this.events.once(Phaser.Scenes.Events.SHUTDOWN, this.cleanup, this);
    this.events.once(Phaser.Scenes.Events.DESTROY, this.cleanup, this);
    console.log('监听数:', bus.listenerCount('gain-point'));
  }

  onGainPoint() {
    this.score += 1;
    this.scoreText.setText(`得分:${this.score}`);
    console.log('得分:', this.score);
  }

  cleanup() {
    bus.off('gain-point', this.onGainPoint, this);
    if (this.keyHandler) {
      window.removeEventListener('keydown', this.keyHandler);
      this.keyHandler = null;
    }
    if (this.tick) {
      this.tick.remove();
      this.tick = null;
    }
    // shutdown 后不保留旧轮次的 destroy 处理器。
    this.events.off(Phaser.Scenes.Events.DESTROY, this.cleanup, this);
    console.log('监听数:', bus.listenerCount('gain-point'));
  }
}

new Phaser.Game({
  type: Phaser.AUTO,
  width: 640,
  height: 360,
  backgroundColor: '#17283a',
  scene: [LevelScene]
});

预期结果:在项目目录运行 npm run dev,打开 Vite 输出的本地地址,画面显示操作说明、得分与计时。空格只增加 1 分;每次按 R 后,分数和秒数从 0 重新开始。开发服务器地址中的端口 <PORT> 以实际输出为准。

用连续重启验证没有重复响应

打开浏览器开发者工具的 Console,先按一次空格,再按一次 R,最后再按一次空格。对应的关键日志应依次为:

text
监听数: 1
得分: 1
监听数: 0
监听数: 1
得分: 1

继续按 R 五次,每次都应先出现监听数 0,再出现监听数 1;任一轮按一次空格,只出现一条得分日志。保持场景运行约 3 秒,画面计时应增加约 3 秒,而不是每秒跳动两三次。计时受页面可见性与运行帧率影响,观察时避免切到后台标签页。

如果日志中的监听数逐轮变成 2、3、4,优先核对 on() 和 off() 的事件名、函数引用及上下文是否一致;如果停止场景后仍有浏览器键盘响应,检查 removeEventListener() 是否使用了注册时保存的 keyHandler。对额外创建的原生 setTimeout()、setInterval() 或网络订阅,也应在同一退出清理函数中按其各自 API 释放。

SHUTDOWN 适合每次退出关卡的清理,DESTROY 适合永久销毁时兜底。不要仅依靠 DESTROY 处理重启资源,因为普通 restart() 不会触发它。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

场景重启时清理监听和定时器

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通