Task.Run 方法

定义

命名空间:

System.Threading.Tasks

程序集:

System.Runtime.dll

对在 ThreadPool 上运行的指定工作进行排队，并为该工作返回任务或 Task<TResult> 句柄。

重载

Run(Func<Task>, CancellationToken)	对在线程池上运行的指定工作进行排队，并为 function返回的任务返回代理。 取消令牌允许取消工作（如果尚未启动）。
Run(Action, CancellationToken)	将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task 对象。 取消令牌允许取消工作（如果尚未启动）。
Run(Func<Task>)	对在线程池上运行的指定工作进行排队，并为 function返回的任务返回代理。
Run(Action)	将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task 对象。
Run<TResult>(Func<Task<TResult>>)	对在线程池上运行的指定工作进行排队，并返回由 function返回的 Task(TResult) 的代理。 取消令牌允许取消工作（如果尚未启动）。
Run<TResult>(Func<TResult>)	将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task<TResult> 对象。 取消令牌允许取消工作（如果尚未启动）。
Run<TResult>(Func<Task<TResult>>, CancellationToken)	对在线程池上运行的指定工作进行排队，并返回由 function返回的 Task(TResult) 的代理。
Run<TResult>(Func<TResult>, CancellationToken)	将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task(TResult) 对象。

注解

Run 方法提供了一组重载，使使用默认值可以轻松启动任务。 它是 StartNew 重载的轻型替代方法。

Run(Func<Task>, CancellationToken)

Source:

Task.cs

对在线程池上运行的指定工作进行排队，并为 function返回的任务返回代理。 取消令牌允许取消工作（如果尚未启动）。

public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task?> function, System.Threading.CancellationToken cancellationToken);

参数

function

Func<Task>

异步执行的工作。

cancellationToken

CancellationToken

取消令牌，可用于取消工作（如果尚未启动）。 Run(Func<Task>, CancellationToken) 不会将 cancellationToken 传递给 action。

返回

Task

表示由 function返回的任务的代理的任务。

例外

ArgumentNullException

function 参数 null。

OperationCanceledException

任务已被取消。 此异常存储在返回的任务中。

ObjectDisposedException

已释放与 cancellationToken 关联的 CancellationTokenSource。

TaskCanceledException

任务已被取消。

注解

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 任务取消
• 异常处理（任务并行库）

Run(Action, CancellationToken)

Source:

Task.cs

将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task 对象。 取消令牌允许取消工作（如果尚未启动）。

public static System.Threading.Tasks.Task Run (Action action, System.Threading.CancellationToken cancellationToken);

参数

action

Action

异步执行的工作。

cancellationToken

CancellationToken

取消令牌，可用于取消工作（如果尚未启动）。 Run(Action, CancellationToken) 不会将 cancellationToken 传递给 action。

返回

Task

一个任务，表示排队在线程池中执行的工作。

例外

ArgumentNullException

action 参数 null。

OperationCanceledException

任务已被取消。 此异常存储在返回的任务中。

ObjectDisposedException

已释放与 cancellationToken 关联的 CancellationTokenSource。

TaskCanceledException

任务已被取消。

示例

以下示例调用 Run(Action, CancellationToken) 方法以创建循环访问 C：\Windows\System32 目录中的文件的任务。 lambda 表达式调用 Parallel.ForEach 方法，将每个文件的相关信息添加到 List<T> 对象。 Parallel.ForEach 循环调用的每个分离嵌套任务都会检查取消令牌的状态，如果请求取消，则调用 CancellationToken.ThrowIfCancellationRequested 方法。 当调用线程调用 Task.Wait 方法时，CancellationToken.ThrowIfCancellationRequested 方法会引发在 catch 块中处理的 OperationCanceledException 异常。

using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static async Task Main()
   {
      var tokenSource = new CancellationTokenSource();
      var token = tokenSource.Token;
      var files = new List<Tuple<string, string, long, DateTime>>();

      var t = Task.Run( () => { string dir = "C:\\Windows\\System32\\";
                                object obj = new Object();
                                if (Directory.Exists(dir)) {
                                   Parallel.ForEach(Directory.GetFiles(dir),
                                   f => {
                                           if (token.IsCancellationRequested)
                                              token.ThrowIfCancellationRequested();
                                           var fi = new FileInfo(f);
                                           lock(obj) {
                                              files.Add(Tuple.Create(fi.Name, fi.DirectoryName, fi.Length, fi.LastWriteTimeUtc));          
                                           }
                                      });
                                 }
                              }
                        , token);
      await Task.Yield();
      tokenSource.Cancel();
      try {
         await t;
         Console.WriteLine("Retrieved information for {0} files.", files.Count);
      }
      catch (AggregateException e) {
         Console.WriteLine("Exception messages:");
         foreach (var ie in e.InnerExceptions)
            Console.WriteLine("   {0}: {1}", ie.GetType().Name, ie.Message);

         Console.WriteLine("\nTask status: {0}", t.Status);       
      }
      finally {
         tokenSource.Dispose();
      }
   }
}
// The example displays the following output:
//       Exception messages:
//          TaskCanceledException: A task was canceled.
//          TaskCanceledException: A task was canceled.
//          ...
//       
//       Task status: Canceled

注解

如果在任务开始执行之前请求取消，则任务不会执行。 而是设置为 Canceled 状态并引发 TaskCanceledException 异常。

Run(Action, CancellationToken) 方法是 TaskFactory.StartNew(Action, CancellationToken) 方法的更简单替代方法。 它创建具有以下默认值的任务：

• 其 CreationOptions 属性值为 TaskCreationOptions.DenyChildAttach。

• 它使用默认任务计划程序。

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 异常处理（任务并行库）

Run(Func<Task>)

Source:

Task.cs

对在线程池上运行的指定工作进行排队，并为 function返回的任务返回代理。

public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task?> function);

参数

function

Func<Task>

异步执行的工作。

返回

Task

表示由 function返回的任务的代理的任务。

例外

ArgumentNullException

function 参数 null。

注解

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 异常处理（任务并行库）

Run(Action)

Source:

Task.cs

将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task 对象。

public static System.Threading.Tasks.Task Run (Action action);

参数

action

Action

异步执行的工作。

返回

Task

一个任务，表示在 ThreadPool 中排队执行的工作。

例外

ArgumentNullException

action 参数 null。

示例

以下示例定义一个显示当前线程 Thread.ManagedThreadId 的 ShowThreadInfo 方法。 它直接从应用程序线程调用，并从传递给 Run(Action) 方法的 Action 委托调用。

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

public class Example
{
   public static void Main()
   {
      ShowThreadInfo("Application");

      var t = Task.Run(() => ShowThreadInfo("Task") );
      t.Wait();
   }

   static void ShowThreadInfo(String s)
   {
      Console.WriteLine("{0} thread ID: {1}",
                        s, Thread.CurrentThread.ManagedThreadId);
   }
}
// The example displays the following output:
//       Application thread ID: 1
//       Task thread ID: 3

以下示例与上一个示例类似，只不过它使用 lambda 表达式来定义任务要执行的代码。

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

public class Example
{
   public static void Main()
   {
      Console.WriteLine("Application thread ID: {0}",
                        Thread.CurrentThread.ManagedThreadId);
      var t = Task.Run(() => {  Console.WriteLine("Task thread ID: {0}",
                                   Thread.CurrentThread.ManagedThreadId);
                             } );
      t.Wait();
   }
}
// The example displays the following output:
//       Application thread ID: 1
//       Task thread ID: 3

这些示例显示异步任务在与主应用程序线程不同的线程上执行。

对 Wait 方法的调用可确保任务在应用程序结束之前完成并显示其输出。 否则，Main 方法可能在任务完成之前完成。

以下示例演示了 Run(Action) 方法。 它定义目录名称数组，并启动单独的任务来检索每个目录中的文件名。 所有任务将文件名写入单个 ConcurrentBag<T> 对象。 然后，该示例调用 WaitAll(Task[]) 方法以确保所有任务都已完成，然后显示写入 ConcurrentBag<T> 对象的文件名总数的计数。

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var list = new ConcurrentBag<string>();
      string[] dirNames = { ".", ".." };
      List<Task> tasks = new List<Task>();
      foreach (var dirName in dirNames) {
         Task t = Task.Run( () => { foreach(var path in Directory.GetFiles(dirName)) 
                                       list.Add(path); }  );
         tasks.Add(t);
      }
      Task.WaitAll(tasks.ToArray());
      foreach (Task t in tasks)
         Console.WriteLine("Task {0} Status: {1}", t.Id, t.Status);
         
      Console.WriteLine("Number of files read: {0}", list.Count);
   }
}
// The example displays output like the following:
//       Task 1 Status: RanToCompletion
//       Task 2 Status: RanToCompletion
//       Number of files read: 23

注解

Run 方法允许在单个方法调用中创建和执行任务，并且是 StartNew 方法的更简单替代方法。 它创建具有以下默认值的任务：

• 其取消令牌 CancellationToken.None。

• 其 CreationOptions 属性值为 TaskCreationOptions.DenyChildAttach。

• 它使用默认任务计划程序。

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 异常处理（任务并行库）

Run<TResult>(Func<Task<TResult>>)

Source:

Task.cs

对在线程池上运行的指定工作进行排队，并返回由 function返回的 Task(TResult) 的代理。 取消令牌允许取消工作（如果尚未启动）。

public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>?> function);

类型参数

TResult

代理任务返回的结果的类型。

参数

function

Func<Task<TResult>>

异步执行的工作。

返回

Task<TResult>

一个 Task(TResult)，表示由 function返回的 Task(TResult) 的代理。

例外

ArgumentNullException

function 参数 null。

注解

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 异常处理（任务并行库）

Run<TResult>(Func<TResult>)

Source:

Task.cs

将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task<TResult> 对象。 取消令牌允许取消工作（如果尚未启动）。

public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<TResult> function);

类型参数

TResult

任务的返回类型。

参数

function

Func<TResult>

异步执行的工作。

返回

Task<TResult>

一个任务对象，表示排队在线程池中执行的工作。

例外

ArgumentNullException

function 参数 null。

示例

以下示例计算表示已发布书籍的文本文件中单词的近似数量。 每个任务都负责打开文件、异步读取其整个内容以及使用正则表达式计算字数。 调用 WaitAll(Task[]) 方法以确保所有任务在向控制台显示每本书的字数之前都已完成。

using System;
using System.IO;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      string pattern = @"\p{P}*\s+";
      string[] titles = { "Sister Carrie", "The Financier" };
      Task<int>[] tasks = new Task<int>[titles.Length];

      for (int ctr = 0; ctr < titles.Length; ctr++) {
         string s = titles[ctr];
         tasks[ctr] = Task.Run( () => {
                                   // Number of words.
                                   int nWords = 0;
                                   // Create filename from title.
                                   string fn = s + ".txt";
                                   if (File.Exists(fn)) {
                                      StreamReader sr = new StreamReader(fn);
                                      string input = sr.ReadToEndAsync().Result;
                                      nWords = Regex.Matches(input, pattern).Count;
                                   }
                                   return nWords;
                                } );
      }
      Task.WaitAll(tasks);

      Console.WriteLine("Word Counts:\n");
      for (int ctr = 0; ctr < titles.Length; ctr++)
         Console.WriteLine("{0}: {1,10:N0} words", titles[ctr], tasks[ctr].Result);
   }
}
// The example displays the following output:
//       Sister Carrie:    159,374 words
//       The Financier:    196,362 words

正则表达式 \p{P}*\s+ 匹配零、一个或多个标点符号字符，后跟一个或多个空格字符。 它假定匹配项的总数等于近似字数。

注解

Run 方法是 TaskFactory.StartNew(Action) 方法的更简单替代方法。 它创建具有以下默认值的任务：

• 其取消令牌 CancellationToken.None。

• 其 CreationOptions 属性值为 TaskCreationOptions.DenyChildAttach。

• 它使用默认任务计划程序。

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 异常处理（任务并行库）

Run<TResult>(Func<Task<TResult>>, CancellationToken)

Source:

Task.cs

对在线程池上运行的指定工作进行排队，并返回由 function返回的 Task(TResult) 的代理。

public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>?> function, System.Threading.CancellationToken cancellationToken);

类型参数

TResult

代理任务返回的结果的类型。

参数

function

Func<Task<TResult>>

异步执行的工作。

cancellationToken

CancellationToken

取消令牌，可用于取消工作（如果尚未启动）。 Run<TResult>(Func<Task<TResult>>, CancellationToken) 不会将 cancellationToken 传递给 action。

返回

Task<TResult>

一个 Task(TResult)，表示由 function返回的 Task(TResult) 的代理。

例外

ArgumentNullException

function 参数 null。

OperationCanceledException

任务已被取消。 此异常存储在返回的任务中。

ObjectDisposedException

已释放与 cancellationToken 关联的 CancellationTokenSource。

TaskCanceledException

任务已被取消。

注解

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 任务取消
• 异常处理（任务并行库）

Run<TResult>(Func<TResult>, CancellationToken)

Source:

Task.cs

将指定的工作排入队列，以在线程池上运行，并返回表示该工作的 Task(TResult) 对象。

public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<TResult> function, System.Threading.CancellationToken cancellationToken);

类型参数

TResult

任务的结果类型。

参数

function

Func<TResult>

异步执行的工作。

cancellationToken

CancellationToken

取消令牌，可用于取消工作（如果尚未启动）。 Run<TResult>(Func<TResult>, CancellationToken) 不会将 cancellationToken 传递给 action。

返回

Task<TResult>

一个 Task(TResult)，表示排队在线程池中执行的工作。

例外

ArgumentNullException

function 参数 null。

OperationCanceledException

任务已被取消。 此异常存储在返回的任务中。

ObjectDisposedException

已释放与 cancellationToken 关联的 CancellationTokenSource。

TaskCanceledException

任务已被取消。

示例

以下示例创建 20 个任务，该任务将循环执行，直到计数器递增为 200 万值。 当前 10 个任务达到 200 万时，取消令牌将被取消，并且取消其计数器未达到 200 万的任务。 该示例显示了可能的输出。

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var tasks = new List<Task<int>>();
      var source = new CancellationTokenSource();
      var token = source.Token;
      int completedIterations = 0;

      for (int n = 0; n <= 19; n++)
         tasks.Add(Task.Run( () => { int iterations = 0;
                                     for (int ctr = 1; ctr <= 2000000; ctr++) {
                                         token.ThrowIfCancellationRequested();
                                         iterations++;
                                     }
                                     Interlocked.Increment(ref completedIterations);
                                     if (completedIterations >= 10)
                                        source.Cancel();
                                     return iterations; }, token));

      Console.WriteLine("Waiting for the first 10 tasks to complete...\n");
      try  {
         Task.WaitAll(tasks.ToArray());
      }
      catch (AggregateException) {
         Console.WriteLine("Status of tasks:\n");
         Console.WriteLine("{0,10} {1,20} {2,14:N0}", "Task Id",
                           "Status", "Iterations");
         foreach (var t in tasks)
            Console.WriteLine("{0,10} {1,20} {2,14}",
                              t.Id, t.Status,
                              t.Status != TaskStatus.Canceled ? t.Result.ToString("N0") : "n/a");
      }
   }
}
// The example displays output like the following:
//    Waiting for the first 10 tasks to complete...
//    Status of tasks:
//
//       Task Id               Status     Iterations
//             1      RanToCompletion      2,000,000
//             2      RanToCompletion      2,000,000
//             3      RanToCompletion      2,000,000
//             4      RanToCompletion      2,000,000
//             5      RanToCompletion      2,000,000
//             6      RanToCompletion      2,000,000
//             7      RanToCompletion      2,000,000
//             8      RanToCompletion      2,000,000
//             9      RanToCompletion      2,000,000
//            10             Canceled            n/a
//            11             Canceled            n/a
//            12             Canceled            n/a
//            13             Canceled            n/a
//            14             Canceled            n/a
//            15             Canceled            n/a
//            16      RanToCompletion      2,000,000
//            17             Canceled            n/a
//            18             Canceled            n/a
//            19             Canceled            n/a
//            20             Canceled            n/a

该示例循环访问所有任务以确定哪些任务已成功完成且已取消，而不是使用 InnerExceptions 属性检查异常。 对于已完成的值，它显示任务返回的值。

由于取消是合作的，因此每个任务都可以决定如何响应取消。 以下示例与第一个示例类似，但取消令牌后，任务将返回已完成的迭代次数，而不是引发异常。

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var tasks = new List<Task<int>>();
      var source = new CancellationTokenSource();
      var token = source.Token;
      int completedIterations = 0;

      for (int n = 0; n <= 19; n++)
         tasks.Add(Task.Run( () => { int iterations = 0;
                                     for (int ctr = 1; ctr <= 2000000; ctr++) {
                                         if (token.IsCancellationRequested)
                                            return iterations;
                                         iterations++;
                                     }
                                     Interlocked.Increment(ref completedIterations);
                                     if (completedIterations >= 10)
                                        source.Cancel();
                                     return iterations; }, token));

      Console.WriteLine("Waiting for the first 10 tasks to complete...\n");
      try  {
         Task.WaitAll(tasks.ToArray());
      }
      catch (AggregateException) {
         Console.WriteLine("Status of tasks:\n");
         Console.WriteLine("{0,10} {1,20} {2,14:N0}", "Task Id",
                           "Status", "Iterations");
         foreach (var t in tasks)
            Console.WriteLine("{0,10} {1,20} {2,14}",
                              t.Id, t.Status,
                              t.Status != TaskStatus.Canceled ? t.Result.ToString("N0") : "n/a");
      }
   }
}
// The example displays output like the following:
//    Status of tasks:
//
//       Task Id               Status     Iterations
//             1      RanToCompletion      2,000,000
//             2      RanToCompletion      2,000,000
//             3      RanToCompletion      2,000,000
//             4      RanToCompletion      2,000,000
//             5      RanToCompletion      2,000,000
//             6      RanToCompletion      2,000,000
//             7      RanToCompletion      2,000,000
//             8      RanToCompletion      2,000,000
//             9      RanToCompletion      2,000,000
//            10      RanToCompletion      1,658,326
//            11      RanToCompletion      1,988,506
//            12      RanToCompletion      2,000,000
//            13      RanToCompletion      1,942,246
//            14      RanToCompletion        950,108
//            15      RanToCompletion      1,837,832
//            16      RanToCompletion      1,687,182
//            17      RanToCompletion        194,548
//            18             Canceled    Not Started
//            19             Canceled    Not Started
//            20             Canceled    Not Started

该示例仍必须处理 AggregateException 异常，因为请求取消时尚未启动的任何任务仍会引发异常。

注解

如果在任务开始执行之前请求取消，则任务不会执行。 而是设置为 Canceled 状态并引发 TaskCanceledException 异常。

Run 方法是 StartNew 方法的更简单替代方法。 它创建具有以下默认值的任务：

• 其 CreationOptions 属性值为 TaskCreationOptions.DenyChildAttach。

• 它使用默认任务计划程序。

有关处理任务操作引发的异常的信息，请参阅 异常处理。

另请参阅

• 任务取消
• 异常处理（任务并行库）