Есть ли лучший шаблон ожидания для C #?

Question

Я обнаружил, что кодирую подобные вещи несколько раз.

for (int i = 0; i < 10; i++)
{
   if (Thing.WaitingFor())
   {
      break;
   }
   Thread.Sleep(sleep_time);
}
if(!Thing.WaitingFor())
{
   throw new ItDidntHappenException();
}

Это выглядит как плохой код, есть ли лучший способ сделать это / это признак плохого дизайна?

Answer 1

Намного лучший способ реализовать этот шаблон - заставить ваш объект Thing представить событие, которое может ждать потребитель. Например, ManualResetEvent или AutoResetEvent. Это значительно упрощает ваш потребительский код следующим образом:

if (!Thing.ManualResetEvent.WaitOne(sleep_time)) {
  throw new ItDidntHappen();
}

// It happened

Код на стороне Thing также не является более сложным.

public sealed class Thing {
  public readonly ManualResetEvent ManualResetEvent = new ManualResetEvent(false);

  private void TheAction() {
    ...
    // Done.  Signal the listeners
    ManualResetEvent.Set();
  }
}

Answer 2

Использовать события.

Попросите, чтобы ожидаемое событие вызвало событие, когда оно завершено (или не удалось завершить в течение выделенного времени), а затем обработайте событие в вашем основном приложении.

Таким образом, у вас нет никаких Sleep петель.

Answer 3

Цикл не является УЖАСНЫМ способом ожидания чего-либо, если вашей программе больше нечего делать во время ожидания (например, при подключении к БД).Тем не менее, я вижу некоторые проблемы с вашим.

    //It's not apparent why you wait exactly 10 times for this thing to happen
    for (int i = 0; i < 10; i++)
    {
        //A method, to me, indicates significant code behind the scenes.
        //Could this be a property instead, or maybe a shared reference?
        if (Thing.WaitingFor()) 
        {
            break;
        }
        //Sleeping wastes time; the operation could finish halfway through your sleep. 
        //Unless you need the program to pause for exactly a certain time, consider
        //Thread.Yield().
        //Also, adjusting the timeout requires considering how many times you'll loop.
        Thread.Sleep(sleep_time);
    }
    if(!Thing.WaitingFor())
    {
        throw new ItDidntHappenException();
    }

Короче говоря, приведенный выше код больше похож на «цикл повторения», который убит, чтобы работать больше как тайм-аут.Вот как я могу структурировать цикл ожидания:

var complete = false;
var startTime = DateTime.Now;
var timeout = new TimeSpan(0,0,30); //a thirty-second timeout.

//We'll loop as many times as we have to; how we exit this loop is dependent only
//on whether it finished within 30 seconds or not.
while(!complete && DateTime.Now < startTime.Add(timeout))
{
   //A property indicating status; properties should be simpler in function than methods.
   //this one could even be a field.
   if(Thing.WereWaitingOnIsComplete)
   {
      complete = true;
      break;
   }

   //Signals the OS to suspend this thread and run any others that require CPU time.
   //the OS controls when we return, which will likely be far sooner than your Sleep().
   Thread.Yield();
}
//Reduce dependence on Thing using our local.
if(!complete) throw new TimeoutException();

Answer 4

Если возможно, оберните асинхронную обработку в Task<T>. Это обеспечивает лучшее из всех миров:

• Вы можете ответить на завершение в форме события, используя продолжения задачи .
• Вы можете ждать, используя ожидаемый дескриптор завершения, потому что Task<T> реализует IAsyncResult.
• Задачи легко компонуются с помощью Async CTP; они также хорошо играют с Rx.
• Задачи имеют очень чистую встроенную систему обработки исключений (в частности, они правильно сохраняют трассировку стека).

Если вам нужно использовать тайм-аут, Rx или Async CTP могут предоставить это.

Answer 5

Я бы взглянул на класс WaitHandle . В частности, класс ManualResetEvent , который ожидает, пока объект не будет установлен. Вы также можете указать для него значения тайм-аута и проверить, был ли он установлен позже.

// Member variable
ManualResetEvent manual = new ManualResetEvent(false); // Not set

// Where you want to wait.
manual.WaitOne(); // Wait for manual.Set() to be called to continue here
if(!manual.WaitOne(0)) // Check if set
{
   throw new ItDidntHappenException();
}

Answer 6

Вот как вы можете сделать это с System.Threading.Tasks:

Task t = Task.Factory.StartNew(
    () =>
    {
        Thread.Sleep(1000);
    });
if (t.Wait(500))
{
    Console.WriteLine("Success.");
}
else
{
    Console.WriteLine("Timeout.");
}

Но если по какой-то причине вы не можете использовать Задачи (например, требование .Net 2.0), тогда вы можете использовать ManualResetEvent, как указано в ответе JaredPar, или использовать что-то вроде этого:

public class RunHelper
{
    private readonly object _gate = new object();
    private bool _finished;
    public RunHelper(Action action)
    {
        ThreadPool.QueueUserWorkItem(
            s =>
            {
                action();
                lock (_gate)
                {
                    _finished = true;
                    Monitor.Pulse(_gate);
                }
            });
    }

    public bool Wait(int milliseconds)
    {
        lock (_gate)
        {
            if (_finished)
            {
                return true;
            }

            return Monitor.Wait(_gate, milliseconds);
        }
    }
}

С подходом Wait / Pulse вы явно не создаете События, поэтому вам не нужно заботиться об их утилизации.

Пример использования:

var rh = new RunHelper(
    () =>
    {
        Thread.Sleep(1000);
    });
if (rh.Wait(500))
{
    Console.WriteLine("Success.");
}
else
{
    Console.WriteLine("Timeout.");
}

Answer 7

Я думаю, вы должны использовать AutoResetEvents. Они отлично работают, когда вы ожидаете, пока другой поток завершит свою задачу

Пример:

AutoResetEvent hasItem;
AutoResetEvent doneWithItem;
int jobitem;

public void ThreadOne()
{
 int i;
 while(true)
  {
  //SomeLongJob
  i++;
  jobitem = i;
  hasItem.Set();
  doneWithItem.WaitOne();
  }
}

public void ThreadTwo()
{
 while(true)
 {
  hasItem.WaitOne();
  ProcessItem(jobitem);
  doneWithItem.Set();

 }
}

Answer 8

Я обычно не рекомендую бросать исключения.

// Inside a method...
checks=0;
while(!Thing.WaitingFor() && ++checks<10) {
    Thread.Sleep(sleep_time);
}
return checks<10; //False = We didn't find it, true = we did

Answer 9

Звонок на Thread.Sleep всегда является активным ожиданием, которого следует избегать.
Одной из альтернатив будет использование таймера. Для более легкого использования вы можете инкапсулировать это в класс.