.NET Framework
Параллельная библиотека задач (TPL)
Поиск…
замечания
Назначение и использование случаев
Цель параллельной библиотеки задач - упростить процесс написания и поддержки многопоточного и параллельного кода.
Некоторые примеры использования *:
- Сохранение пользовательского интерфейса при выполнении фоновой работы по отдельной задаче
- Распределение рабочей нагрузки
- Разрешить клиентскому приложению отправлять и получать запросы одновременно (отдых, TCP / UDP, ect)
- Чтение и / или запись нескольких файлов одновременно
* Кодекс следует рассматривать в каждом конкретном случае для многопоточности. Например, если в цикле имеется несколько итераций или выполняется только небольшая часть работы, накладные расходы для параллелизма могут перевесить преимущества.
TPL с .Net 3.5
TPL также доступен для .Net 3.5, входящего в пакет NuGet, он называется Task Parallel Library.
Базовая цепочка производителей-потребителей (BlockingCollection)
var collection = new BlockingCollection<int>(5);
var random = new Random();
var producerTask = Task.Run(() => {
for(int item=1; item<=10; item++)
{
collection.Add(item);
Console.WriteLine("Produced: " + item);
Thread.Sleep(random.Next(10,1000));
}
collection.CompleteAdding();
Console.WriteLine("Producer completed!");
});
Стоит отметить, что если вы не вызываете collection.CompleteAdding();
, вы можете продолжать добавлять коллекцию, даже если ваша потребительская задача запущена. Просто вызовите collection.CompleteAdding();
когда вы уверены, что больше нет дополнений. Эта функциональность может быть использована для того, чтобы сделать несколько производителей одним шаблоном потребителя, где у вас есть несколько источников, которые подают элементы в BlockingCollection, и один потребитель вытаскивает предметы и что-то делает с ними. Если ваш BlockingCollection пуст перед вызовом полного добавления, Enumerable from collection.GetConsumingEnumerable()
будет блокироваться до добавления нового элемента в коллекцию или BlockingCollection.CompleteAdding (); и очередь пуста.
var consumerTask = Task.Run(() => {
foreach(var item in collection.GetConsumingEnumerable())
{
Console.WriteLine("Consumed: " + item);
Thread.Sleep(random.Next(10,1000));
}
Console.WriteLine("Consumer completed!");
});
Task.WaitAll(producerTask, consumerTask);
Console.WriteLine("Everything completed!");
Задача: базовая инстанция и Wait
Задача может быть создана путем непосредственного создания класса Task
...
var task = new Task(() =>
{
Console.WriteLine("Task code starting...");
Thread.Sleep(2000);
Console.WriteLine("...task code ending!");
});
Console.WriteLine("Starting task...");
task.Start();
task.Wait();
Console.WriteLine("Task completed!");
... или используя статический метод Task.Run
:
Console.WriteLine("Starting task...");
var task = Task.Run(() =>
{
Console.WriteLine("Task code starting...");
Thread.Sleep(2000);
Console.WriteLine("...task code ending!");
});
task.Wait();
Console.WriteLine("Task completed!");
Обратите внимание, что только в первом случае необходимо явно вызвать Start
.
Задача: WaitAll и захват переменных
var tasks = Enumerable.Range(1, 5).Select(n => new Task<int>(() =>
{
Console.WriteLine("I'm task " + n);
return n;
})).ToArray();
foreach(var task in tasks) task.Start();
Task.WaitAll(tasks);
foreach(var task in tasks)
Console.WriteLine(task.Result);
Задача: WaitAny
var allTasks = Enumerable.Range(1, 5).Select(n => new Task<int>(() => n)).ToArray();
var pendingTasks = allTasks.ToArray();
foreach(var task in allTasks) task.Start();
while(pendingTasks.Length > 0)
{
var finishedTask = pendingTasks[Task.WaitAny(pendingTasks)];
Console.WriteLine("Task {0} finished", finishedTask.Result);
pendingTasks = pendingTasks.Except(new[] {finishedTask}).ToArray();
}
Task.WaitAll(allTasks);
Примечание: окончательный WaitAll
необходим, WaitAny
что WaitAny
не вызывает исключений.
Задача: обработка исключений (с использованием Wait)
var task1 = Task.Run(() =>
{
Console.WriteLine("Task 1 code starting...");
throw new Exception("Oh no, exception from task 1!!");
});
var task2 = Task.Run(() =>
{
Console.WriteLine("Task 2 code starting...");
throw new Exception("Oh no, exception from task 2!!");
});
Console.WriteLine("Starting tasks...");
try
{
Task.WaitAll(task1, task2);
}
catch(AggregateException ex)
{
Console.WriteLine("Task(s) failed!");
foreach(var inner in ex.InnerExceptions)
Console.WriteLine(inner.Message);
}
Console.WriteLine("Task 1 status is: " + task1.Status); //Faulted
Console.WriteLine("Task 2 status is: " + task2.Status); //Faulted
Задача: обработка исключений (без использования Wait)
var task1 = Task.Run(() =>
{
Console.WriteLine("Task 1 code starting...");
throw new Exception("Oh no, exception from task 1!!");
});
var task2 = Task.Run(() =>
{
Console.WriteLine("Task 2 code starting...");
throw new Exception("Oh no, exception from task 2!!");
});
var tasks = new[] {task1, task2};
Console.WriteLine("Starting tasks...");
while(tasks.All(task => !task.IsCompleted));
foreach(var task in tasks)
{
if(task.IsFaulted)
Console.WriteLine("Task failed: " +
task.Exception.InnerExceptions.First().Message);
}
Console.WriteLine("Task 1 status is: " + task1.Status); //Faulted
Console.WriteLine("Task 2 status is: " + task2.Status); //Faulted
Задача: отменить с помощью CancellationToken
var cancellationTokenSource = new CancellationTokenSource();
var cancellationToken = cancellationTokenSource.Token;
var task = new Task((state) =>
{
int i = 1;
var myCancellationToken = (CancellationToken)state;
while(true)
{
Console.Write("{0} ", i++);
Thread.Sleep(1000);
myCancellationToken.ThrowIfCancellationRequested();
}
},
cancellationToken: cancellationToken,
state: cancellationToken);
Console.WriteLine("Counting to infinity. Press any key to cancel!");
task.Start();
Console.ReadKey();
cancellationTokenSource.Cancel();
try
{
task.Wait();
}
catch(AggregateException ex)
{
ex.Handle(inner => inner is OperationCanceledException);
}
Console.WriteLine($"{Environment.NewLine}You have cancelled! Task status is: {task.Status}");
//Canceled
В качестве альтернативы ThrowIfCancellationRequested
запрос аннулирования может быть обнаружен с помощью IsCancellationRequested
а OperationCanceledException
может быть IsCancellationRequested
вручную:
//New task delegate
int i = 1;
var myCancellationToken = (CancellationToken)state;
while(!myCancellationToken.IsCancellationRequested)
{
Console.Write("{0} ", i++);
Thread.Sleep(1000);
}
Console.WriteLine($"{Environment.NewLine}Ouch, I have been cancelled!!");
throw new OperationCanceledException(myCancellationToken);
Обратите внимание, как маркер отмены передается конструктору задачи в параметре cancellationToken
. Это необходимо для того , что задача переходит в Canceled
состоянии, а не в Faulted
состояния, когда ThrowIfCancellationRequested
вызываются. Кроме того, по той же причине маркер отмены явно указывается в конструкторе OperationCanceledException
во втором случае.
Task.WhenAny
var random = new Random();
IEnumerable<Task<int>> tasks = Enumerable.Range(1, 5).Select(n => Task.Run(async() =>
{
Console.WriteLine("I'm task " + n);
await Task.Delay(random.Next(10,1000));
return n;
}));
Task<Task<int>> whenAnyTask = Task.WhenAny(tasks);
Task<int> completedTask = await whenAnyTask;
Console.WriteLine("The winner is: task " + await completedTask);
await Task.WhenAll(tasks);
Console.WriteLine("All tasks finished!");
Task.WhenAll
var random = new Random();
IEnumerable<Task<int>> tasks = Enumerable.Range(1, 5).Select(n => Task.Run(() =>
{
Console.WriteLine("I'm task " + n);
return n;
}));
Task<int[]> task = Task.WhenAll(tasks);
int[] results = await task;
Console.WriteLine(string.Join(",", results.Select(n => n.ToString())));
// Output: 1,2,3,4,5
Parallel.Invoke
var actions = Enumerable.Range(1, 10).Select(n => new Action(() =>
{
Console.WriteLine("I'm task " + n);
if((n & 1) == 0)
throw new Exception("Exception from task " + n);
})).ToArray();
try
{
Parallel.Invoke(actions);
}
catch(AggregateException ex)
{
foreach(var inner in ex.InnerExceptions)
Console.WriteLine("Task failed: " + inner.Message);
}
Parallel.ForEach
В этом примере Parallel.ForEach
использует для вычисления суммы чисел от 1 до 10000 с помощью нескольких потоков. Для обеспечения безопасности потоков Interlocked.Add
используется для суммирования чисел.
using System.Threading;
int Foo()
{
int total = 0;
var numbers = Enumerable.Range(1, 10000).ToList();
Parallel.ForEach(numbers,
() => 0, // initial value,
(num, state, localSum) => num + localSum,
localSum => Interlocked.Add(ref total, localSum));
return total; // total = 50005000
}
Parallel.For
В этом примере используется Parallel.For
для вычисления суммы чисел от 1 до 10000 с использованием нескольких потоков. Для обеспечения безопасности потоков Interlocked.Add
используется для суммирования чисел.
using System.Threading;
int Foo()
{
int total = 0;
Parallel.For(1, 10001,
() => 0, // initial value,
(num, state, localSum) => num + localSum,
localSum => Interlocked.Add(ref total, localSum));
return total; // total = 50005000
}
Исходный контекст выполнения с AsyncLocal
Когда вам нужно передать некоторые данные из родительской задачи в свои дочерние задачи, чтобы она логически AsyncLocal
с выполнением, используйте класс AsyncLocal
:
void Main()
{
AsyncLocal<string> user = new AsyncLocal<string>();
user.Value = "initial user";
// this does not affect other tasks - values are local relative to the branches of execution flow
Task.Run(() => user.Value = "user from another task");
var task1 = Task.Run(() =>
{
Console.WriteLine(user.Value); // outputs "initial user"
Task.Run(() =>
{
// outputs "initial user" - value has flown from main method to this task without being changed
Console.WriteLine(user.Value);
}).Wait();
user.Value = "user from task1";
Task.Run(() =>
{
// outputs "user from task1" - value has flown from main method to task1
// than value was changed and flown to this task.
Console.WriteLine(user.Value);
}).Wait();
});
task1.Wait();
// ouputs "initial user" - changes do not propagate back upstream the execution flow
Console.WriteLine(user.Value);
}
Примечание. Как видно из приведенного выше примера, AsynLocal.Value
имеет copy on read
семантике copy on read
, но если вы используете некоторый ссылочный тип и меняете его свойства, вы будете влиять на другие задачи. Следовательно, наилучшая практика с AsyncLocal
заключается в использовании типов значений или неизменяемых типов.
Parallel.ForEach в VB.NET
For Each row As DataRow In FooDataTable.Rows
Me.RowsToProcess.Add(row)
Next
Dim myOptions As ParallelOptions = New ParallelOptions()
myOptions.MaxDegreeOfParallelism = environment.processorcount
Parallel.ForEach(RowsToProcess, myOptions, Sub(currentRow, state)
ProcessRowParallel(currentRow, state)
End Sub)
Задача: возврат значения
Задача, возвращающая значение, возвращает тип Task< TResult >
где TResult - тип значения, которое необходимо вернуть. Вы можете запросить результат задачи по свойству Result.
Task<int> t = Task.Run(() =>
{
int sum = 0;
for(int i = 0; i < 500; i++)
sum += i;
return sum;
});
Console.WriteLine(t.Result); // Outuput 124750
Если Задача выполняется асинхронно, чем ожидание задачи, возвращает результат.
public async Task DoSomeWork()
{
WebClient client = new WebClient();
// Because the task is awaited, result of the task is assigned to response
string response = await client.DownloadStringTaskAsync("http://somedomain.com");
}