将长时间运行的任务与异步/等待模式结合起来的正确方法是什么？

Question

我有一个“高精度”计时器类，我需要能够启动、停止和暂停/恢复。为此，我将我在 Internet 上找到的几个不同示例结合在一起，但我不确定我是否正确使用了带有 asnyc / await 的 Tasks。

这是我的相关代码：

//based on http://haukcode.wordpress.com/2013/01/29/high-precision-timer-in-netc/
public class HighPrecisionTimer : IDisposable
{
    Task _task;
    CancellationTokenSource _cancelSource;

    //based on http://blogs.msdn.com/b/pfxteam/archive/2013/01/13/cooperatively-pausing-async-methods.aspx
    PauseTokenSource _pauseSource;

    Stopwatch _watch;
    Stopwatch Watch { get { return _watch ?? (_watch = Stopwatch.StartNew()); } }

    public bool IsPaused
    {
        get { return _pauseSource != null && _pauseSource.IsPaused; }
        private set
        {
            if (value)
            {
                _pauseSource = new PauseTokenSource();
            }
            else
            {
                _pauseSource.IsPaused = false;
            }
        }
    }

    public bool IsRunning { get { return !IsPaused && _task != null && _task.Status == TaskStatus.Running; } }

    public void Start()
    {
        if (IsPaused)
        {
            IsPaused = false;
        }
        else if (!IsRunning)
        {
            _cancelSource = new CancellationTokenSource();
            _task = new Task(ExecuteAsync, _cancelSource.Token, TaskCreationOptions.LongRunning);
            _task.Start();
        }
    }

    public void Stop()
    {
        if (_cancelSource != null)
        {
            _cancelSource.Cancel();
        }
    }

    public void Pause()
    {
        if (!IsPaused)
        {
            if (_watch != null)
            {
                _watch.Stop();
            }
        }

        IsPaused = !IsPaused;
    }

    async void ExecuteAsync()
    {
        while (!_cancelSource.IsCancellationRequested)
        {
            if (_pauseSource != null && _pauseSource.IsPaused)
            {
                await _pauseSource.Token.WaitWhilePausedAsync();
            }

            // DO CUSTOM TIMER STUFF...
        }

        if (_watch != null)
        {
            _watch.Stop();
            _watch = null;
        }

        _cancelSource = null;
        _pauseSource = null;
    }

    public void Dispose()
    {
        if (IsRunning)
        {
            _cancelSource.Cancel();
        }
    }
}

任何人都可以看看并提供一些关于我是否正确执行此操作的指示吗？

更新

我已经尝试根据下面的 Noseratio 的 cmets 修改我的代码，但我仍然无法弄清楚语法。每次尝试将 ExecuteAsync() 方法传递给 TaskFactory.StartNew 或 Task.Run 都会导致编译错误，如下所示：

“以下方法或属性之间的调用不明确：TaskFactory.StartNew(Action, CancellationToken...) 和 TaskFactory.StartNew(Func, CancellationToken...)”。

最后，有没有一种方法可以指定 LongRunning TaskCreationOption 而无需提供 TaskScheduler？

async **Task** ExecuteAsync()
{
    while (!_cancelSource.IsCancellationRequested)
    {
        if (_pauseSource != null && _pauseSource.IsPaused)
        {
            await _pauseSource.Token.WaitWhilePausedAsync();
        }
        //...
    }
}

public void Start()
{
    //_task = Task.Factory.StartNew(ExecuteAsync, _cancelSource.Token, TaskCreationOptions.LongRunning, null);

    //_task = Task.Factory.StartNew(ExecuteAsync, _cancelSource.Token);

    //_task = Task.Run(ExecuteAsync, _cancelSource.Token);

}

更新 2

我想我已经缩小了范围，但仍然不确定正确的语法。这是否是创建任务的正确方法，以便消费者/调用代码继续执行，任务启动并在新的异步线程上启动？

_task = Task.Run(async () => await ExecuteAsync, _cancelSource.Token);

//**OR**

_task = Task.Factory.StartNew(async () => await ExecuteAsync, _cancelSource.Token, TaskCreationOptions.LongRunning, TaskScheduler.Default);

Answer 1

这里有几点：

• async void 方法仅适用于异步事件处理程序 (more info)。你的async void ExecuteAsync() 立即返回（只要代码流到达其中的await _pauseSource）。本质上，您的_task 在那之后处于完成状态，而ExecuteAsync 的其余部分将在未观察到的情况下执行（因为它是void）。它甚至可能根本不会继续执行，这取决于您的主线程（以及进程）何时终止。

• 鉴于此，您应该将其设为async Task ExecuteAsync()，并使用Task.Run 或Task.Factory.StartNew 而不是new Task 来启动它。因为您希望任务的操作方法为async，所以您将在这里处理嵌套任务，即Task<Task>，Task.Run 会自动为您解包。更多信息可以在here和here找到。

• PauseTokenSource 采用以下方法（按设计，AFAIU）：代码的消费者端（调用Pause）实际上只请求暂停，但不同步。它将在Pause 之后继续执行，即使生产者端可能尚未达到等待状态，即await _pauseSource.Token.WaitWhilePausedAsync()。这对于您的应用程序逻辑可能没问题，但您应该意识到这一点。更多信息here。

[UPDATE] 下面是使用Factory.StartNew 的正确语法。注意Task<Task> 和task.Unwrap。另请注意Stop 中的_task.Wait()，它用于确保Stop 返回时任务已完成（以类似于Thread.Join 的方式）。此外，TaskScheduler.Default 用于指示Factory.StartNew 使用线程池调度程序。如果您从另一个任务中创建 HighPrecisionTimer 对象，这一点很重要，该任务又是在具有非默认同步上下文的线程上创建的，例如一个 UI 线程（更多信息 here 和 here）。

using System;
using System.Threading;
using System.Threading.Tasks;

namespace ConsoleApplication
{
    public class HighPrecisionTimer
    {
        Task _task;
        CancellationTokenSource _cancelSource;

        public void Start()
        {
            _cancelSource = new CancellationTokenSource();

            Task<Task> task = Task.Factory.StartNew(
                function: ExecuteAsync, 
                cancellationToken: _cancelSource.Token, 
                creationOptions: TaskCreationOptions.LongRunning, 
                scheduler: TaskScheduler.Default);

            _task = task.Unwrap();
        }

        public void Stop()
        {
            _cancelSource.Cancel(); // request the cancellation

            _task.Wait(); // wait for the task to complete
        }

        async Task ExecuteAsync()
        {
            Console.WriteLine("Enter ExecuteAsync");
            while (!_cancelSource.IsCancellationRequested)
            {
                await Task.Delay(42); // for testing

                // DO CUSTOM TIMER STUFF...
            }
            Console.WriteLine("Exit ExecuteAsync");
        }
    }

    class Program
    {
        public static void Main()
        {
            var highPrecisionTimer = new HighPrecisionTimer();

            Console.WriteLine("Start timer");
            highPrecisionTimer.Start();

            Thread.Sleep(2000);

            Console.WriteLine("Stop timer");
            highPrecisionTimer.Stop();

            Console.WriteLine("Press Enter to exit...");
            Console.ReadLine();
        }
    }
}