音频无法播放：局部变量与类字段的混淆和滥用问题

一、问题概述

在 WPF 中，试图通过 NAudio 库实现多音轨音频播放时，程序运行之后不能听到声音。

using NAudio.Wave;
using System.Collections.Generic;

namespace *** // 省略
{
    public partial class MainWindow : Window
    {
        private AudioManager audioManager = new AudioManager();
        // 其他部分省略
		
	       // 软件启动时，主页窗口初始化
	       private void WindowLoaded(object sender, RoutedEventArgs e)
	       {
	           // 加载白噪音资源
	           var audioManager = new AudioManager();
	           audioManager.AddPlayer("***");
	           audioManager.AddPlayer("***");
	       }
			
		// 音频资源管理
		public class AudioManager
		{
			private List<AudioPlayer> _players = new List<AudioPlayer>();
			// 添加音源
			public void AddPlayer(string filePath)
			{
				try
				{
					var player = new AudioPlayer(filePath);
					_players.Add(player);
					Debug.WriteLine($"已添加播放器，当前总数：{_players.Count}");
					Debug.WriteLine($"索引：{_players.IndexOf(player)}");
				}
				catch (Exception ex)
				{
					Debug.WriteLine($"添加播放器失败: {ex.Message}");
				}
			}
			
			// 整体播放
			public void PlayAll()
			{
				Debug.WriteLine($"PlayAll 调用时列表长度: {_players.Count}"); // 新增日志
				int Cnt = 0;
				foreach (var player in _players)
				{
					player.Play();
					Cnt++;
				}
				Debug.WriteLine($"已播放所有音源，总数：{Cnt}");
			}
		}
		
		public class AudioPlayer
		{
			private WaveOutEvent _waveOut;
			private AudioFileReader _audioFile;
		
			public AudioPlayer(string filePath)
			{
				_audioFile = new AudioFileReader(filePath);
				_waveOut = new WaveOutEvent();
				_waveOut.Init(_audioFile);
			}
		
			public void Play() => _waveOut.Play();
			public void Pause() => _waveOut.Pause();
			public void Stop() => _waveOut.Stop();
			public float Volume
			{
				get => _audioFile.Volume;
				set => _audioFile.Volume = value;
			}
		}
	}
}

通过 Debug.WriteLine 方法输出的调试信息：

已添加播放器，当前总数：1
索引：0
已添加播放器，当前总数：2
索引：1
PlayAll 调用时列表长度: 0
已播放所有音源，总数：0

发现在添加了两个文件的情况下，调用PlayAll时列表长度却是0而不是预期的2。此前，在使用如下方法播放单个音频时：

public class AudioManager
{
	//其他方法同上
	// 独立播放
	public void Play(int index)
	{
		_players[index].Play();
	}
}

然后通过audioManager.Play(0)播放列表的第一个音频文件时，编译器报错：

System.ArgumentOutOfRangeException:“Index was out of range. Must be non-negative and less than the size of the collection. ”

即索引超出列表范围，一度让我百思不得其解……

---

二、寻找原因

询问AI后，提示我问题很可能出在 _players 列表未被正确填充，导致 PlayAll() 循环时列表为空(这也与我的预期相符)，并给出如下检查思路：

1. 确认 AddPlayer 方法是否被正确调用
2. 检查 AudioPlayer 构造函数是否失败
3. 确认 _players 列表的作用域和生命周期
4. 检查AudioManager实例是否唯一
5. 验证文件路径和权限

• 最开始我考虑了文件加载失败的情况，但是在尝试了使用绝对路径以及将属性修改为资源或者内容之后，没有报告找不到文件的错误，似乎可以排除这种情况。
• 然后我想到是不是有可能多次初始化了_players列表，导致其意外清空？
  • 查找代码中出现_players的语句，似乎只有一次初始化，可以排除这种情况。
  • 
• 最后我突然想到，在页面初始化时似乎将AudioManager类实例化了一次，但是在后面的代码中好像也看到了类似的new语句，是不是多次实例化了AudioManager呢？
  • 查找代码中的new AudioManager()语句，果然查到了两次：
  • 

[!INFO] 根据上述分析，问题出现在多次实例化AudioManager类:

1. 在MainWindow类中，实例化了一次，在这里是一个类字段，属于 MainWindow 类的成员变量，生命周期与 MainWindow 实例相同。
2. 在WindowLoaded事件中，又实例化了一次。在这里是一个局部变量 audioManager，它的作用域仅限于该方法内部。当方法执行完毕后，局部变量会被销毁。

诊断结果：对 audioManager 的添加和读取操作不是同一个对象。

• 具体解释：
  • 在 WindowLoaded 方法中调用 AddPlayer 时，操作的是局部变量 audioManager。
  • 尝试在其他地方（如按钮点击事件）调用 PlayAll 时，操作的是类字段的 audioManager。
  • 由于局部变量和类字段是两个不同的对象，局部变量中添加的音源不会影响类字段的 audioManager，因此 PlayAll 时列表为空，无法播放。

---

三、解决问题

删去WindowLoaded中的局部变量，直接使用生命周期更长的类字段，程序运行之后成功输出了音频。

---

四、反思总结

关键陷阱：局部变量覆盖类字段

在 C# 中，如果方法内部声明了一个与类字段同名的局部变量，编译器会优先使用局部变量，导致类字段被“隐藏”。

private AudioManager audioManager = new AudioManager();

private void SomeMethod()
{
    var audioManager = new AudioManager(); // 这里实际是一个局部变量
    audioManager.AddPlayer("xxx");         // 操作的是局部变量，而非类字段
}

直接使用类字段，可以确保所有操作都作用于同一个 AudioManager 实例，从而解决播放失败的问题。

[!NOTE]- 局部变量＆类字段：如何进行取舍？

• ![[音频无法播放：局部变量与类字段的混淆和滥用问题-20250205132505196.png|622]]
• 使用类字段：
  • 数据需要长期存在：变量需要在整个类的生命周期内保持状态，或在多个方法间共享。
  • 资源需要全局访问：某些对象（如数据库连接、网络客户端）需要被多个方法重复使用。
  • 需要维护对象状态：对象的状态（如播放进度、配置参数）需要在多次调用中持续更新。
• 使用局部变量：
  • 临时计算或中间结果：变量仅在一次方法调用中临时使用，无需长期保存。
  • 避免副作用：希望方法的行为纯粹，不依赖或修改类的状态。
  • 限制作用域以提高安全性：防止变量被意外修改（如敏感数据）。

反思：出现这样的问题，主要在于对面向对象编程的认识和经验不足，对面向过程变成有较大的惯性思维，习惯将初始化操作写在页面加载的事件中。