为什么此 ThreadPool.QueueUserWorkItem 代码没有通过我的测试？

Question

有问题的代码

public void StartPlaying()
{
    ThreadPool.QueueUserWorkItem(ignoredState =>
    {
        while (_playlist.Count > 0)
        {
            var audioFile = _playlist.Dequeue();

            if (StartedPlaying != null)
                StartedPlaying(this, new TypedAudioFileEventArgs(audioFile));

            audioFile.SoundPlayer.PlaySync();
            audioFile.SoundPlayer.Dispose();

            if (StoppedPlaying != null)
                StoppedPlaying(this, new TypedAudioFileEventArgs(audioFile));
        }
    });
}

和我的测试：

[TestMethod()]
public void StartPlayIsCalledTwice_OnlyRunningOnce()
{
    int timeBetweenPlays = 0; 
    var target = new TypedAudioFilePlayer(timeBetweenPlays);

    target.AddFile(TypedAudioFileCreator.CreateWord(1, "bl"));
    target.StartedPlaying += StartedPlaying_Once;

    target.StartPlaying();
    target.StartPlaying();
}

private bool _once = false;
private void StartedPlaying_Once(object sender, TypedAudioFileEventArgs e)
{
    if (!_once)
        _once = true;
    else
        Assert.Fail("Should not be called more than once!");
}

根据 ThreadPool.QueueUserWorkItem 的 MSDN 描述判断，我相信我的单元测试应该失败：

对方法进行排队以供执行。当线程池线程变得可用时，该方法将执行。

默认线程池大小为 512，因此应立即有两个线程可用于处理 StartPlaying 调用。我相信我的代码应该失败，因为我没有提供任何针对两个线程可以访问相同资源的竞争条件的保护措施。

这里发生了什么事？

Answer 1

因为仅当有项目要播放时调用 StartPlaying 时才会引发 StartedPlaying 事件。

_playlist.Dequeue(); 将您入队的文件出队。因此，当您第二次到达 while (_playlist.Count > 0) 时，它将立即失败，直接将第二次调用传递给 StartPlaying 而不会引发事件。

此外，正如 Bruno Silva 指出的那样，第二次调用 StartPlaying 生成的线程在测试退出之前可能没有机会执行任何操作。

无论如何，此代码中还存在大约一百万至少 2 个线程错误：

// Where did _playlist come from?  Is it shared state among the player threads?
// If so, all access to it should be in locks, since queues are not thread safe
while (_playlist.Count > 0) 


// Both of these start threads and then immediately return.  
// The test will probably exit before either of those threads do anything much
    target.StartPlaying();
    target.StartPlaying();
}

如果要正确进行单元测试，则需要定义前置条件、期望、操作和后置条件：

• 先决条件：您有一个已初始化的 TypedAudioFilePlayer，其中有一个文件已排队：

  var target = new TypedAudioFilePlayer(timeBetweenPlays);
target.AddFile(TypedAudioFileCreator.CreateWord(1, "bl"));

• 期望：如果 StartPlaying 被调用两次，StartedPlaying 事件将仅引发一次

  target.StartedPlaying += StartedPlaying_Once;

• 操作： StartPlaying 方法将被调用两次：

  target.StartPlaying();
target.StartPlaying();

• 后置条件： StartedPlaying 事件仅引发一次：

  private bool _once = false;

  private void StartedPlaying_Once（对象发送者，TypedAudioFileEventArgs e）
  <代码>{
  如果（！_once）
_once = true;
其他
Assert.Fail("不应多次调用！");
}

现在，您的测试成功了。由于我上面的解释，在这种情况下这并不好。您需要通过消除队列错误和竞争条件来使测试进入失败状态，然后努力使测试以正确的方式通过。

Answer 2

您似乎正在使用两个线程之间的共享资源，因此当第二次调用 Play 时，once 可能不会设置为 true。您可以使用锁来允许一次由一个线程执行部分代码：

private readonly object lock_object=new object();
private void StartedPlaying_Once(object sender, TypedAudioFileEventArgs e)
{
lock(lock_object)
{    
if (!_once)
        _once = true;
    else
        Assert.Fail("Should not be called more than once!");
}
}

Answer 3

这些可能会在文本执行之外失败吗？您的测试在您对项目进行排队后立即结束，因此我不确定当测试方法结束执行时这些线程会发生什么。您是否尝试过使用 WaitHandle 等待它们在测试中完成？

请参阅 http://msdn.microsoft.com/en-us/ Library/system.threading.waithandle.aspx 为例。