React音频播放器：页面切换时自动停止播放的实现与最佳实践

本文详细阐述了在React应用中，如何利用useEffect钩子的清理机制，确保音频播放器在用户导航至新页面时自动停止播放。我们将探讨use-sound库的特定实现方法，包括在组件卸载时调用stop()函数。同时，文章也提供了使用原生HTML5 audio元素实现相同功能的指导，强调了在组件生命周期中正确管理音频资源的最佳实践，以优化用户体验并避免资源泄露。

背景与问题阐述

在react单页应用（spa）中，当用户从一个页面导航到另一个页面时，如果前一个页面包含音频播放器，音频可能会在后台继续播放，这会导致不佳的用户体验。这是因为即使组件在视觉上不再可见，其内部的副作用（如音频播放）如果没有被正确清理，仍然可能持续运行。解决此问题的关键在于利用react组件的生命周期，特别是在组件卸载时执行必要的清理操作。

利用 useEffect 钩子进行清理

React的useEffect钩子不仅用于执行副作用（如数据获取、订阅事件等），其返回的函数更是用于清理这些副作用的理想场所。当组件卸载时，或者在依赖项变化导致效果重新执行之前，useEffect返回的清理函数会被调用。这正是我们停止音频播放的最佳时机。

针对 use-sound 库的解决方案

如果你正在使用 use-sound 这样的第三方库来管理音频，那么解决方案相对直接。use-sound 钩子本身提供了用于控制音频播放的函数，包括 play、pause 和 stop。为了在组件卸载时停止音频，你需要确保在 useEffect 的清理函数中调用 stop() 方法。

以下是修改后的 AudioPlayer 组件示例：

import React, { useState, useEffect, useRef } from 'react';
import useSound from 'use-sound';
import { IconContext } from 'react-icons';
import { AiFillPlayCircle, AiFillPauseCircle } from 'react-icons/ai';
const AudioPlayer = ({ song }) => {
const [isPlaying, setIsPlaying] = useState(false);
// 解构出 stop 函数，以便在清理时调用
const [play, { pause, duration, sound, stop }] = useSound(song);
const [seconds, setSeconds] = useState(0);
const [currTime, setCurrTime] = useState({ min: "", sec: "" });
// 计算总时长
const totalSec = duration / 1000;
const totalMin = Math.floor(totalSec / 60);
const totalSecRemain = Math.floor(totalSec % 60);
const totalTime = { min: totalMin, sec: totalSecRemain };
const playingButton = () => {
if (isPlaying) {
pause();
setIsPlaying(false);
} else {
play();
setIsPlaying(true);
}
};
// 定时更新当前播放时间
useEffect(() => {
const interval = setInterval(() => {
if (sound) {
const currentSeconds = sound.seek([]);
setSeconds(currentSeconds);
const min = Math.floor(currentSeconds / 60);
const sec = Math.floor(currentSeconds % 60);
setCurrTime({ min, sec });
}
}, 1000);
return () => clearInterval(interval); // 清理定时器
}, [sound]);
// 核心清理逻辑：在组件卸载时停止音频
useEffect(() => {
return () => {
// 当组件卸载时，调用 use-sound 提供的 stop 函数
if (stop) {
stop();
}
// 如果你同时使用了原生 audio 元素并对其进行了引用，也应在此处清理
// 例如：audioRef.current?.pause();
// audioRef.current?.currentTime = 0;
};
}, [stop]); // 依赖项包含 stop，确保其在清理时可用
// 注意：原代码中的 audioRef 绑定在 div 上，而非实际的 <audio> 元素。
// 对于 use-sound，其内部管理 audio 元素，通常无需手动操作。
// 如果要使用原生 audio 元素，audioRef 应指向 <audio> 标签或存储 Audio 实例。
// const audioRef = useRef(null);
return (
<div className='items-center mx-auto text-center'>
<div>
{!isPlaying ? (
<button className='playButton' onClick={playingButton}>
<IconContext.Provider value={{ size: "40px", color: "#28332B" }}>
<AiFillPlayCircle />
</IconContext.Provider>
</button>
) : (
<button className='playButton' onClick={playingButton}>
<IconContext.Provider value={{ size: "40px", color: "#28332B" }}>
<AiFillPauseCircle />
</IconContext.Provider>
</button>
)}
</div>
<div className='flex items-center space-x-2'>
<span className='text-[6px] font-["Helvetica_Neue"]'>
{currTime.min}:{String(currTime.sec).padStart(2, '0')}
</span>
<input
type='range'
min='0'
max={totalSec}
value={seconds}
className='accent-[#28332B] flex-1'
onChange={(e) => {
if (sound) {
sound.seek([e.target.value]);
}
}}
/>
<span className='text-[6px] font-["Helvetica_Neue"]'>
{totalTime.min}:{String(totalTime.sec).padStart(2, '0')}
</span>
</div>
</div>
);
};
export default AudioPlayer;

注意事项：

• stop 函数的解构： 确保从 useSound 钩子返回的对象中解构出 stop 函数。
• useEffect 依赖项： 清理函数通常不需要特定的依赖项，因为它只在组件卸载时运行一次。但如果 stop 函数本身会变化（尽管对于 use-sound 来说不常见），将其加入依赖数组可以确保清理函数的最新版本被调用。
• beforeunload 事件： 原代码中尝试使用 window.addEventListener(“beforeunload”, handleUnload)。这个事件在用户关闭浏览器标签页或窗口时触发，而不是在React应用内部路由切换时触发。因此，它不适用于处理页面内导航时的音频停止问题。useEffect 的清理机制是针对组件生命周期的正确方法。

使用原生 HTML5 audio 元素的替代方案

如果 use-sound 库的清理机制未能满足你的需求，或者你倾向于更底层地控制音频，可以直接使用原生 HTML5 audio 元素。这种方法提供了最大的控制权，但需要手动管理音频元素的创建、播放和销毁。

以下是使用原生 audio 元素实现自动停止的示例：

import React, { useState, useEffect, useRef } from 'react';
// 假设你仍然需要图标库
import { IconContext } from 'react-icons';
import { AiFillPlayCircle, AiFillPauseCircle } from 'react-icons/ai';
const NativeAudioPlayer = ({ song }) => {
const audioRef = useRef(null); // 用于引用 <audio> 元素或 Audio 实例
const [isPlaying, setIsPlaying] = useState(false);
const [duration, setDuration] = useState(0);
const [currentTime, setCurrentTime] = useState(0);
// 初始化音频元素和事件监听器
useEffect(() => {
const audio = new Audio(song);
audioRef.current = audio; // 将 Audio 实例存储在 ref 中
const setAudioData = () => {
setDuration(audio.duration);
};
const updateCurrentTime = () => {
setCurrentTime(audio.currentTime);
};
const handleEnded = () => {
setIsPlaying(false);
setCurrentTime(0); // 播放结束后重置时间
};
audio.addEventListener('loadedmetadata', setAudioData);
audio.addEventListener('timeupdate', updateCurrentTime);
audio.addEventListener('ended', handleEnded);
// 清理函数：在组件卸载时停止并重置音频
return () => {
if (audioRef.current) {
audioRef.current.pause();
audioRef.current.currentTime = 0;
// 移除事件监听器以防止内存泄露
audioRef.current.removeEventListener('loadedmetadata', setAudioData);
audioRef.current.removeEventListener('timeupdate', updateCurrentTime);
audioRef.current.removeEventListener('ended', handleEnded);
}
};
}, [song]); // 当歌曲源变化时重新初始化音频
const togglePlayPause = () => {
if (audioRef.current) {
if (isPlaying) {
audioRef.current.pause();
} else {
audioRef.current.play();
}
setIsPlaying(!isPlaying);
}
};
const handleSeek = (e) => {
if (audioRef.current) {
audioRef.current.currentTime = e.target.value;
setCurrentTime(e.target.value);
}
};
// 格式化时间显示
const formatTime = (seconds) => {
const min = Math.floor(seconds / 60);
const sec = Math.floor(seconds % 60);
return `${min}:${String(sec).padStart(2, '0')}`;
};
return (
<div className='items-center mx-auto text-center'>
<div>
{!isPlaying ? (
<button className='playButton' onClick={togglePlayPause}>
<IconContext.Provider value={{ size: "40px", color: "#28332B" }}>
<AiFillPlayCircle />
</IconContext.Provider>
</button>
) : (
<button className='playButton' onClick={togglePlayPause}>
<IconContext.Provider value={{ size: "40px", color: "#28332B" }}>
<AiFillPauseCircle />
</IconContext.Provider>
</button>
)}
</div>
<div className='flex items-center space-x-2'>
<span className='text-[6px] font-["Helvetica_Neue"]'>
{formatTime(currentTime)}
</span>
<input
type='range'
min='0'
max={duration}
value={currentTime}
className='accent-[#28332B] flex-1'
onChange={handleSeek}
/>
<span className='text-[6px] font-["Helvetica_Neue"]'>
{formatTime(duration)}
</span>
</div>
</div>
);
};
export default NativeAudioPlayer;

注意事项：

• audioRef 的正确使用： 在此示例中，audioRef.current 存储的是 new Audio() 创建的 Audio 实例，而不是一个 JSX 元素的引用。
• 事件监听器的管理： 使用原生 audio 元素时，必须手动添加和移除事件监听器，以防止内存泄露。
• 手动状态管理： 播放状态、时长、当前时间等都需要手动通过 useState 进行管理和更新。

总结

无论是使用像 use-sound 这样的第三方库，还是直接操作原生 HTML5 audio 元素，核心思想都是利用 useEffect 钩子的清理机制。在组件卸载时执行必要的清理操作（如停止音频播放、清除定时器、移除事件监听器），是构建健壮、高效React应用的关键。这不仅能确保音频在页面切换时自动停止，还能有效管理资源，防止内存泄露，从而提供更流畅、更专业的用户体验。