Рис. 1. Приложение Digits of Pi
Скачать пример AsynchCalcPi.exe.
Все началось вполне невинно. Мне впервые потребовалось вычислить площадь окружности в .NET. Для этого, естественно, нужно точное значение числа pi. В принципе константа System.Math.PI удобна, но в силу того что ее точность составляет 20 знаков, меня беспокоила точность моих расчетов (для полной уверенности мне хотелось получить точность в 21 знак). И я, как и любой настоящий программист, забыл о своей первоначальной задаче и написал программу для вычисления числа pi с любой точностью. Вот что у меня вышло (рис. 1).
Рис. 1. Приложение Digits of Pi
Хотя в большинстве приложений незачем вычислять pi, многие из них выполняют длительные операции, например печать, вызов Web-сервиса или подсчет процентных доходов по некоему многомиллионному вкладу в банке Pacific Northwest. Обычно пользователи готовы подождать завершения такого рода операций, часто занимаясь в это время чем-то другим, если могут наблюдать за ходом выполнения операции. Поэтому даже в моем маленьком приложении есть индикатор прогресса (progress bar). Мой алгоритм вычисляет 9 знаков числа pi за один проход. Как только появляется новый набор цифр, программа обновляет текст и изменяет индикатор прогресса. Например, рис. 2 иллюстрирует ход вычисления 1000 знаков pi (21 знак - хорошо, а 1000 знаков - лучше).
Рис. 2. Вычисление pi с точностью до 1000 знаков
Ниже приведен код, обновляющий пользовательский интерфейс (UI) по мере вычисления знаков pi.
void ShowProgress(string pi, int totalDigits, int digitsSoFar) { _pi.Text = pi; _piProgress.Maximum = totalDigits; _piProgress.Value = digitsSoFar; } void CalcPi(int digits) { StringBuilder pi = new StringBuilder("3", digits + 2); // Отобразить ход выполнения ShowProgress(pi.ToString(), digits, 0); if( digits > 0 ) { pi.Append("."); for( int i = 0; i < digits; i += 9 ) { int nineDigits = NineDigitsOfPi.StartingAt(i+1); int digitCount = Math.Min(digits - i, 9); string ds = string.Format("{0:D9}", nineDigits); pi.Append(ds.Substring(0, digitCount)); // Отобразить ход выполнения ShowProgress(pi.ToString(), digits, i + digitCount); } } } |
Все шло замечательно, пока в середине вычисления pi с точностью до 1000 знаков я не переключился в другое приложение, а потом вернулся обратно. То, что я увидел, показано на рис. 3.
Рис. 3. Событие paint пропало!
Конечно, проблема в том, что мое приложение - однопоточное, поэтому пока вычисляется pi, ничего не рисуется. Раньше я с этим не сталкивался, так как при установке свойств TextBox.Text и ProgressBar.Value соответствующие элементы управления перерисовываются в процессе записи свойств (хотя я заметил, что это лучше удается индикатору прогресса, чем текстовому полю). Однако, после того как я перевел приложение в фоновый режим, а потом вновь сделал его активным, мне нужно было отрисовать всю клиентскую область, для чего служит событие формы Paint. Поскольку никакие другие события не обрабатываются, пока не закончится обработка текущего (т. е. события Click кнопки Calc), нам не суждено наблюдать за выполнением вычислений. Значит, на самом деле нужно освободить UI-поток от выполнения длительной операции и реализовать ее как асинхронную. А для этого нужен еще один поток.
На тот момент обработчик события Click выглядел так:
void _calcButton_Click(object sender, EventArgs e) { CalcPi((int)_digits.Value); } |
Не забудьте, проблема в том, что до тех пор, пока CalcPi не вернет управление, поток не выйдет из обработчика Click, а значит, форма не сможет обрабатывать событие Paint (или любое другое). Решить эту проблему можно, например, запустив другой поток:
using System.Threading; … int _digitsToCalc = 0; void CalcPiThreadStart() { CalcPi(_digitsToCalc); } void _calcButton_Click(object sender, EventArgs e) { _digitsToCalc = (int)_digits.Value; Thread piThread = new Thread(new ThreadStart(CalcPiThreadStart)); piThread.Start(); } |
Теперь, вместо того чтобы ждать завершения CalcPi, я создаю и запускаю новый поток. Метод Thread.Start настроит новый поток как готовый к запуску и немедленно вернет управление, что позволит UI-потоку вернуться к своей работе. Тогда, если пользователь захочет вмешаться в работу приложения (перевести его в фоновый режим, вновь сделать активным, изменить размер его окна или даже закрыть), UI-поток сможет свободно обрабатывать все эти события, а рабочий поток - независимо вычислять pi. На рис. 4 показаны два потока, выполняющие свои задачи.
Рис. 4. Примитивная многопоточность
Window message queue - Очередь оконных сообщений
Dequeue - Извлечение из очереди
Owning thread - Поток-владелец
Update - Обновление
Window controls - Оконные элементы управления
Other thread - Другой поток
Window with controls - Окно с элементами управления
Возможно, вы обратили внимание, что в CalcPiThreadStart - входную точку рабочего потока - никакие аргументы не передаются. Вместо этого я записываю число знаков в поле _digitsToCalc и вызываю входную точку потока, которая в свою очередь вызывает CalcPi. Это не слишком удобно и является одной из причин, по которой я предпочитаю для асинхронных вычислений использовать делегаты. Делегаты поддерживают передачу аргументов, что избавляет меня от возни с лишним временным полем и промежуточной функцией между моими двумя функциями.
На случай, если вы не знакомы с делегатами, сообщу, что это просто объекты, вызывающие статические функции, или функции экземпляра. В C# они объявляются по синтаксису объявления функций. Скажем, делегат, вызывающий CalcPi, выглядит так:
delegate void CalcPiDelegate(int digits); |
Теперь, когда у меня есть делегат, я могу создать экземпляр, синхронно вызывающий функцию CalcPi:
void _calcButton_Click(object sender, EventArgs e) { CalcPiDelegate calcPi = new CalcPiDelegate(CalcPi); calcPi((int)_digits.Value); } |
Конечно, мне не нужен синхронный вызов CalcPi; я хочу вызывать ее асинхронно. Однако до этого нам придется поглубже разобраться в работе делегатов. Приведенная выше строка объявления делегата на самом деле объявляет новый класс, производный от MultiCastDelegate, с тремя функциями - Invoke, BeginInvoke и EndInvoke, как показано здесь:
class CalcPiDelegate : MulticastDelegate { public void Invoke(int digits); public void BeginInvoke(int digits, AsyncCallback callback, object asyncState); public void EndInvoke(IAsyncResult result); } |
Когда ранее я создавал экземпляр CalcPiDelegate и вызывал его как функцию, я на самом деле вызывал синхронную функцию Invoke, в свою очередь вызывавшую мою функцию CalcPi. А BeginInvoke и EndInvoke позволяют асинхронно вызывать функцию и получать результаты ее работы. Поэтому, чтобы вызвать CalcPi в другом потоке нужно вызвать BeginInvoke так:
void _calcButton_Click(object sender, EventArgs e) { CalcPiDelegate calcPi = new CalcPiDelegate(CalcPi); calcPi.BeginInvoke((int)_digits.Value, null, null); } |
| ПРИМЕЧАНИЕ Заметьте: в качестве двух последних аргументов BeginInvoke я передаю null. Эти аргументы нужны, если вы хотите получить результат выполнения функции позже (функция EndInvoke предназначена еще и для этого). А поскольку CalcPi напрямую обновляет UI, эти аргументы нам не нужны, и я передаю в них null. Дополнительную информацию о синхронных и асинхронных делегатах см. в .NET Delegates: A C# Bedtime Story. |
Теперь я должен был бы быть доволен. В моем приложении полностью интерактивный UI сообщал о ходе выполнения длительных вычислений. И я был доволен, пока не понял, что натворил.
Как выяснилось, мне просто повезло (или не повезло - это как посмотреть). В Microsoft Windows XP нижележащая подсистема поддержки окон, на которой построена Windows Forms, очень надежна. Настолько надежна, что сумела справиться с нарушением первой заповеди программирования в Windows: "Не работай с окном из потока, его не создавшего". Увы, нет никаких гарантий, что другие, менее надежные реализации Windows будут так же великодушны к моим скверным манерам.
Конечно, я сам создал себе проблему. Помните, на рис. 4 два потока обращались к одному и тому же окну одновременно. Однако, поскольку длительные операции в Windows-приложениях - не редкость, у всех UI-классов в Windows Forms (т. е. у классов, производных от System.Windows.Forms.Control) есть свойство, которое можно использовать из любого потока для безопасного обращения к окну. Это свойство называется InvokeRequired и возвращает true, если вызывающий поток должен передать управление потоку, создавшему объект, до вызова методов этого объекта. Простое выражение Assert в функции ShowProgress сразу выявляет ошибку в моем подходе:
using System.Diagnostics; void ShowProgress(string pi, int totalDigits, int digitsSoFar) { // Проверим, в том ли потоке мы находимся Debug.Assert(_pi.InvokeRequired == false); ... } |
В документации .NET по этому вопросу все достаточно четко. В ней говорится: "Есть четыре метода элемента управления, которые можно безопасно вызывать из любого потока: Invoke, BeginInvoke, EndInvoke и CreateGraphics. Чтобы вызывать любые другие методы, используйте invoke-методы, передающие вызовы в поток элемента управления". Значит, при задании свойств элемента управления я нарушаю это правило. А исходя из имен первых трех функций (Invoke, BeginInvoke и EndInvoke), которые разрешено вызывать, становится ясным, что мне нужен еще один делегат - он будет выполняться в UI-потоке. Если бы я был озабочен блокировкой рабочего потока (как в случае с UI-потоком), мне бы пришлось воспользоваться асинхронными методами BeginInvoke и EndInvoke. Но, поскольку рабочий поток всего лишь обслуживает UI-поток, мы обойдемся более простым синхронным методом Invoke, который определен так:
public object Invoke(Delegate method); public object Invoke(Delegate method, object[] args); |
Первая перегруженная версия Invoke принимает экземпляр делегата, содержащего метод, который нужно вызвать в UI-потоке. Никаких аргументов она не предполагает. Однако функция, вызываемая для обновления UI (ShowProgress), принимает три аргумента, поэтому нам потребуется вторая перегруженная версия. Чтобы аргументы передавались корректно, нам понадобится еще один делегат для метода ShowProgress. Применение метода Invoke гарантирует, что вызовы ShowProgress и обращения к окну будут происходить в корректном потоке (не забудьте заменить оба вызова ShowProgress в CalcPi):
delegate void ShowProgressDelegate(string pi, int totalDigits, int digitsSoFar); void CalcPi(int digits) { StringBuilder pi = new StringBuilder("3", digits + 2); // Готовимся к асинхронному отображению индикатора прогресса ShowProgressDelegate showProgress = new ShowProgressDelegate(ShowProgress); // Отобразить ход выполнения this.Invoke(showProgress, new object[] { pi.ToString(), digits, 0}); if( digits > 0 ) { pi.Append("."); for( int i = 0; i < digits; i += 9 ) { ... // Отобразить ход выполнения this.Invoke(showProgress, new object[] { pi.ToString(), digits, i + digitCount}); } } } |
Метод Invoke наконец-то позволил мне безопасно использовать многопоточность в приложении Windows Forms. UI-поток порождает рабочий, который выполняет длительную операцию и возвращает управление UI-потоку, когда возникает необходимость в обновлении пользовательского интерфейса. Безопасная многопоточная архитектура показана на рис. 5.
Рис. 5. Безопасная многопоточность
Window message queue - Очередь оконных сообщений
Request update - Запрос на обновление
Dequeue - Извлечение из очереди
Owning thread - Поток-владелец
Update - Обновление
Window controls - Оконные элементы управления
Other thread - Другой поток
Window with controls - Окно с элементами управления
Вызов Invoke не слишком удобен, а поскольку он дважды встречается в функции CalcPi, мы можем облегчить себе жизнь и изменить ShowProgress, чтобы она сама выполняла асинхронный вызов. Если ShowProgress вызывается из корректного потока, она обновляет элементы управления, в ином случае она использует Invoke для вызова самой себя в нужном потоке. Вернемся к предыдущей, более простой версии CalcPi:
void ShowProgress(string pi, int totalDigits, int digitsSoFar) { // Убедимся, что мы в корректном потоке if( _pi.InvokeRequired == false ) { _pi.Text = pi; _piProgress.Maximum = totalDigits; _piProgress.Value = digitsSoFar; } else { // Показывать ход выполнения операции асинхронно ShowProgressDelegate showProgress = new ShowProgressDelegate(ShowProgress); this.Invoke(showProgress, new object[] { pi, totalDigits, digitsSoFar}); } } void CalcPi(int digits) { StringBuilder pi = new StringBuilder("3", digits + 2); // Показать ход выполнения ShowProgress(pi.ToString(), digits, 0); if( digits > 0 ) { pi.Append("."); for( int i = 0; i < digits; i += 9 ) { ... // Показать ход выполнения ShowProgress(pi.ToString(), digits, i + digitCount); } } } |
Так как вызов Invoke - синхронный и нам не нужно его возвращаемое значение (ведь ShowProgress не возвращает значение), здесь лучше использовать BeginInvoke, чтобы рабочий поток не завис:
BeginInvoke(showProgress, new object[] { pi, totalDigits, digitsSoFar}); |
BeginInvoke всегда предпочтительнее, если возвращаемое назначение не требуется, поскольку при использовании этого метода рабочий поток сразу же возвращается к своей работе, что исключает вероятность взаимной блокировки.
В этом коротком примере я показал, как выполнять длительные операции так, чтобы можно было отображать ход их выполнения, а UI продолжал реагировать на действия пользователя. С этой целью я использовал асинхронный делегат для запуска рабочего потока и метод Invoke для главной формы. При этом еще один делегат выполнялся в UI-потоке.
Я следил, чтобы к данным не было одновременного доступа из рабочего и UI-потоков. Вместо этого я передавал каждому потоку копию нужных ему данных (в рабочий поток - число знаков, а в UI-поток - количество знаков, вычисленных на данный момент). В итоге я никогда не передавал ссылки на объекты, разделяемые двумя потоками, например на текущий StringBuilder. Если бы я передавал ссылки, мне пришлось бы задействовать .NET-средства синхронизации, чтобы исключить вероятность обращения двух потоков к одному объекту одновременно, а это потребовало бы дополнительных усилий. Мне и без того пришлось проделать массу работы, чтобы два потока могли вызывать друг друга.
Конечно, если вы имеете дело с большими наборами данных, вы вряд ли захотите их копировать. Однако везде, где это возможно, я советую для реализации длительных операций в приложениях Windows Forms сочетать асинхронные делегаты и передачу сообщений между рабочим и UI-потоками.
Хотел бы поблагодарить Саймона Робинсона (Simon Robinson) за его сообщение в списке рассылки DevelopMentor .NET, вдохновившее меня на написание этой статьи, Йена Гриффитса (Ian Griffiths) за его начальные наработки в этой области и Майка Вудринга (Mike Woodring) за знаменитые картинки со схемами поддержки нескольких потоков, которые я без зазрения совести стащил у него для своей статьи.
Крис Селлз (Chris Sells) - независимый консультант и преподаватель в DevelopMentor. Специализируется на распределенных приложениях в .NET и COM. Автор нескольких книг, в том числе "ATL Internals", которая в настоящее время перерабатывается для учета изменений, появившихся в ATL7. Кроме того, работает над книгами "Essential Windows Forms" (Addison-Wesley) и "Mastering Visual Studio .NET" (O'Reilly). В свободное время Крис поддерживает Web-сервисы DevCon и руководит Genghis - проектом с открытым исходным кодом. Более подробную информацию о нем и о его многочисленных проектах см. на сайте http://www.sellsbrothers.com/.