) возвращает логическое значение true, если в коллекцию добавлен
элемент item. А метод TryTake() возвращает логическое значение true, если элемент
item удален из коллекции. Если метод TryAdd() выполнен успешно, то элемент item
будет содержать объект. (Кроме того, в интерфейсе IProducerConsumerCollection
указывается перегружаемый вариант метода СоруТо(), определяемого в интерфейсе
ICollection, а также метода ToArray(), копирующего коллекцию в массив.)
Параллельные коллекции зачастую применяются в комбинации с библиотекой
распараллеливания задач (TPL) или языком PLINQ. В силу особого характера этих кол
лекций все их классы не будут рассматриваться далее подробно. Вместо этого на кон
кретных примерах будет дан краткий обзор класса BlockingCollection. Усвоив
основы построения класса BlockingCollection, вы сможете без особого труда
разобраться и в остальных классах параллельных коллекций.
В классе BlockingCollection, по существу, реализуется блокирующая оче
редь. Это означает, что в такой очереди автоматически устанавливается ожидание лю
бых попыток вставить элемент в коллекцию, когда она заполнена, а также попыток
удалить элемент из коллекции, когда она пуста. Это идеальное решение для тех си
туаций, которые связаны с применением шаблона "поставщик-потребитель". В клас
се BlockingCollection реализуются интерфейсы ICollection, IEnumerable,
IEnumerable, а также IDisposable.
В классе BlockingCollection определяются следующие конструкторы.
public BlockingCollection()
public BlockingCollection(int boundedCapacity)
public BlockingCollection(IProducerConsumerCollection collection)
public BlockingCollection(IProducerConsumerCollection collection,
int boundedCapacity)
В двух первых конструкторах в оболочку класса BlockingCollection заклю
чается коллекция, являющаяся экземпляром объекта типа ConcurrentQueue.
А в двух других конструкторах можно указать коллекцию, которая должна быть поло
жена в основу коллекции типа BlockingCollection. Если указывается параметр
boundedCapacity, то он должен содержать максимальное количество объектов, кото
рые коллекция должна содержать перед тем, как она окажется заблокированной. Если
же параметр boundedCapacity не указан, то коллекция оказывается неограниченной.
Помимо методов TryAdd() и TryTake(), определяемых параллельно с теми,
что указываются в интерфейсе IProducerConsumerCollection, в классе
BlockingCollection определяется также ряд собственных методов. Ниже пред
ставлены методы, которые будут использоваться в приведенных далее примерах.
public void Add(T item)
public T Take()
Когда метод Add() вызывается для неограниченной коллекции, он добавляет
элемент item, в коллекцию и затем возвращает управление вызывающей части про
граммы. А когда метод Add() вызывается для ограниченной коллекции, он блокиру
ет доступ к ней, если она заполнена. После того как из коллекции будет удален один
элемент или больше, указанный элемент item будет добавлен в коллекцию, и затем
произойдет возврат из данного метода. Метод Таkе() удаляет элемент из коллекции
и возвращает управление вызывающей части программы. (Имеются также варианты
обоих методов, принимающие в качестве параметра признак задачи как экземпляр
объекта типа CancellationToken.)
Применяя методы Add() и Таке(), можно реализовать простой шаблон
"поставщик-потребитель", как показано в приведенном ниже примере программы.
В этой программе создается поставщик, формирующий символы от А до Z, а так
же потребитель, получающий эти символы. При этом создается коллекция типа
BlockingCollection, ограниченная 4 элементами.
// Простой пример коллекции типа BlockingCollection.
using System;
using System.Threading.Tasks;
using System.Threading;
using System.Collections.Concurrent;
class BlockingDemo {
static BlockingCollection be;
// Произвести и поставить символы от А до Z.
static void Producer() {
for(char ch = 'A'; ch <= 'Z'; ch++) {
be.Add(ch);
Console.WriteLine("Производится символ " + ch);
}
}
// Потребить 26 символов.
static void Consumer() {
for(int i=0; i < 26; i++)
Console.WriteLine("Потребляется символ " + bc.Take());
}
static void Main() {
// Использовать блокирующую коллекцию, ограниченную 4 элементами.
be = new BlockingCollection(4);
// Создать задачи поставщика и потребителя.
Task Prod = new Task(Producer);
Task Con = new Task(Consumer);
// Запустить задачи.
Con.Start();
Prod.Start();
// Ожидать завершения обеих задач.
try {
Task.WaitAll(Con, Prod);
} catch(AggregateException exc) {
Console.WriteLine(exc);
} finally {
Con.Dispose();
Prod.Dispose();
bc.Dispose();
}
}
}
Если запустить эту программу на выполнение, то на экране появится смешанный
результат, выводимый поставщиком и потребителем. Отчасти это объясняется тем,
что коллекция bc ограничена 4 элементами, а это означает, что в нее может быть до
бавлено только четыре элемента, прежде чем ее придется сократить. В качестве экс
перимента попробуйте сделать коллекцию bc неограниченной и понаблюдайте за по
лученными результатами. В некоторых средах выполнения это приведет к тому, что
все элементы коллекции будут сформированы до того, как начнется какое-либо их по
требление. Кроме того, попробуйте ограничить коллекцию одним элементом. В этом
случае одновременно может быть сформирован лишь один элемент.
Для работы с коллекцией типа BlockingCollection может оказаться полез
ным и метод CompleteAdding(). Ниже приведена форма его объявления.
public void CompleteAdding()
Вызов этого метода означает, что в коллекцию не будет больше добавлено ни одно
го элемента. Это приводит к тому, что свойство IsAddingComplete принимает логи
ческое значение true. Если же коллекция пуста, то свойство IsCompleted принимает
логическое значение true, и в этом случае вызовы метода Таке() не блокируются.
Ниже приведены формы объявления свойств IsAddingComplete и IsCompleted.
public bool IsCompleted { get; }
public bool IsAddingComplete { get; }
Когда коллекция типа BlockingCollection только начинает формиро
ваться, эти свойства содержат логическое значение false. А после вызова метода
CompleteAdding() они принимают логическое значение true.
Ниже приведен вариант предыдущего примера программы, измененный с целью
продемонстрировать применение метода CompleteAdding(), свойства IsCompleted
и метода TryTake().
// Применение методов CompleteAdding(), TryTake() и свойства IsCompleted.
using System;
using System.Threading.Tasks;
using System.Threading;
using System.Collections.Concurrent;
class BlockingDemo {
static BlockingCollection bc;
// Произвести и поставить символы от А до Z.
static void Producer() {
for(char ch = 'A'; ch <= 'Z'; ch++) {
bc.Add(ch);
Console.WriteLine("Производится символ " + ch);
}
bc.CompleteAdding();
}
// Потреблять символы до тех пор, пока их будет производить поставщик.
static void Consumer() {
char ch;
while(!bc.IsCompleted) {
if(bc.TryTake(out ch))
Console.WriteLine("Потребляется символ " + ch);
}
}
static void Main() {
// Использовать блокирующую коллекцию, ограниченную 4 элементами.
bc = new BlockingCollection(4);
// Создать задачи поставщика и потребителя.
Task Prod = new Task(Producer);
Task Con = new Task(Consumer);
// Запустить задачи.
Con.Start();
Prod.Start();
// Ожидать завершения обеих задач.
try {
Task.WaitAll(Con, Prod);
} catch(AggregateException exc) {
Console.WriteLine(exc);
} finally {
Con.Dispose();
Prod.Dispose();
bc.Dispose();
}
}
}
Этот вариант программы дает такой же результат, как и предыдущий. Главное
его отличие заключается в том, что теперь метод Producer() может производить
и поставлять сколько угодно элементов. С этой целью он просто вызывает метод
CompleteAdding(), когда завершает создание элементов. А метод Consumer() лишь
"потребляет" произведенные элементы до тех пор, пока свойство IsCompleted не
примет логическое значение true.
Несмотря на специфический до некоторой степени характер параллельных кол
лекций, предназначенных в основном для параллельного программирования, у них,
тем не менее, имеется немало общего с обычными, непараллельными коллекция
ми, описанными в предыдущих разделах. Если же вам приходится работать в среде
параллельного программирования, то для организации одновременного доступа к
данным из нескольких потоков вам, скорее всего, придется воспользоваться параллель
ными коллекциями.
Сохранение объектов, определяемых
пользователем классов, в коллекции
Ради простоты приведенных выше примеров в коллекции, как правило, сохраня
лись объекты встроенных типов, в том числе int, string и char. Но ведь в коллекции
можно хранить не только объекты встроенных типов. Достоинство коллекций в том и
состоит, что в них допускается хранить объекты любого типа, включая объекты опреде
ляемых пользователем классов.
Рассмотрим сначала простой пример применения класса необобщенной коллек
ции ArrayList для хранения информации о товарных запасах. В этом классе инкап
сулируется класс Inventory.
// Простой пример коллекции товарных запасов.
using System;
using System.Collections;
class Inventory {
string name;
double cost;
int onhand;
public Inventory(string n, double c, int h) {
name = n;
cost = c;
onhand = h;
}
public override string ToString() {
return
String.Format("{0,-10}Стоимость: {1,6:С} Наличие: {2}",
name, cost, onhand);
}
}
class InventoryList {
static void Main() {
ArrayList inv = new ArrayList();
// Добавить элементы в список.
inv.Add(new Inventory("Кусачки", 5.95, 3));
inv.Add(new Inventory("Отвертки", 8.29, 2));
inv.Add(new Inventory("Молотки", 3.50, 4));
inv.Add(new Inventory("Дрели", 19.88, 8));
Console.WriteLine("Перечень товарных запасов:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i);
}
}
}
При выполнении программы из данного примера получается следующий результат.
Перечень товарных запасов:
Кусачки Стоимость: $5.95 Наличие: 3
Отвертки Стоимость: $8.29 Наличие: 2
Молотки Стоимость: $3.50 Наличие: 4
Дрели Стоимость: $19.88 Наличие: 8
Обратите внимание на то, что в данном примере программы не потребовалось ни
каких специальных действий для сохранения в коллекции объектов типа Inventory.
Благодаря тому что все типы наследуют от класса object, в необобщенной коллекции
можно хранить объекты любого типа. Именно поэтому в необобщенной коллекции
нетрудно сохранить объекты определяемых пользователем классов. Безусловно, это
также означает, что такая коллекция не типизирована.
Для того чтобы сохранить объекты определяемых пользователем классов в типи
зированной коллекции, придется воспользоваться классами обобщенных коллекций.
В качестве примера ниже приведен измененный вариант программы из предыдущего
примера. В этом варианте используется класс обобщенной коллекции List, а ре
зультат получается таким же, как и прежде.
// Пример сохранения объектов класса Inventory в
// обобщенной коллекции класса List.
using System;
using System.Collections.Generic;
class Inventory {
string name;
double cost;
int onhand;
public Inventory(string n, double c, int h) {
name = n;
cost = c;
onhand = h;
}
public override string ToString() {
return
String.Format("{0,-10}Стоимость: {1,6:С} Наличие: {2}",
name, cost, onhand);
}
}
class TypeSafeInventoryList {
static void Main() {
List inv = new List();
// Добавить элементы в список.
inv.Add(new Inventory("Кусачки", 5.95, 3));
inv.Add(new Inventory("Отвертки", 8.29, 2));
inv.Add(new Inventory("Молотки", 3.50, 4));
inv.Add(new Inventory("Дрели", 19.88, 8));
Console.WriteLine("Перечень товарных запасов:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i);
}
}
}
Данный пример отличается от предыдущего лишь передачей типа Inventory в
качестве аргумента типа конструктору класса List. А в остальном оба примера
рассматриваемой здесь программы практически одинаковы. Это, по существу, означа
ет, что для применения обобщенной коллекции не требуется никаких особых усилий,
но при сохранении в такой коллекции объекта конкретного типа строго соблюдается
типовая безопасность.
Тем не менее для обоих примеров рассматриваемой здесь программы характерна
еще одна особенность: они довольно кратки. Если учесть, что для организации дина
мического массива, где можно хранить, извлекать и обрабатывать данные товарных
запасов, потребуется не менее 40 строк кода, то преимущества коллекций сразу же
становятся очевидными. Нетрудно догадаться, что рассматриваемая здесь программа
получится длиннее в несколько раз, если попытаться закодировать все эти функции
коллекции вручную. Коллекции предлагают готовые решения самых разных задач
программирования, и поэтому их следует использовать при всяком удобном случае.
У рассматриваемой здесь программы имеется все же один не совсем очевидный
недостаток: коллекция не подлежит сортировке. Дело в том, что в классах ArrayList
и List отсутствуют средства для сравнения двух объектов типа Inventory. Но из
этого положения имеются два выхода. Во-первых, в классе Inventory можно реализо
вать интерфейс IComparable, в котором определяется метод сравнения объектов дан
ного класса. И во-вторых, для целей сравнения можно указать объект типа IComparer.
Оба подхода рассматриваются далее по очереди.
Реализация интерфейса IComparable
Если требуется отсортировать коллекцию, состоящую из объектов определяе
мого пользователем класса, при условии, что они не сохраняются в коллекции клас
са SortedList, где элементы располагаются в отсортированном порядке, то в такой
коллекции должен быть известен способ сортировки содержащихся в ней объектов.
С этой целью можно, в частности, реализовать интерфейс IComparable для объектов
сохраняемого типа. Интерфейс IComparable доступен в двух формах: обобщенной и
необобщенной. Несмотря на сходство применения обеих форм данного интерфейса,
между ними имеются некоторые, хотя и небольшие, отличия, рассматриваемые ниже.
Реализация интерфейса IComparable для необобщенных коллекций
Если требуется отсортировать объекты, хранящиеся в необобщенной коллек
ции, то для этой цели придется реализовать необобщенный вариант интерфейса
IComparable. В этом варианте данного интерфейса определяется только один метод
CompareTo(), который определяет порядок выполнения самого сравнения. Ниже
приведена общая форма объявления метода CompareTo().
int CompareTo(object obj)
В методе CompareTo() вызывающий объект сравнивается с объектом obj. Для со
ртировки объектов по нарастающей конкретная реализация данного метода должна
возвращать нулевое значение, если значения сравниваемых объектов равны; положи
тельное — если значение вызывающего объекта больше, чем у объекта obj; и отри
цательное — если значение вызывающего объекта меньше, чем у объекта obj. А для
сортировки по убывающей можно обратить результат сравнения объектов. Если же
тип объекта obj не подходит для сравнения с вызывающим объектом, то в методе
CompareTo() может быть сгенерировано исключение ArgumentException.
В приведенном ниже примере программы демонстрируется конкретная реализа
ция интерфейса IComparable. В этой программе интерфейс IComparable вводится
в класс Inventory, разработанный в двух последних примерах из предыдущего раз
дела. В классе Inventory реализуется метод CompareTo() для сравнения полей name
объектов данного класса, что дает возможность отсортировать товарные запасы по наи
менованию. Как показано в данном примере программы, коллекция объектов класса
Inventory подлежит сортировке благодаря реализации интерфейса IComparable в
этом классе.
// Реализовать интерфейс IComparable.
using System;
using System.Collections;
// Реализовать необобщенный вариант интерфейса IComparable.
class Inventory : IComparable {
string name;
double cost;
int onhand;
public Inventory(string n, double c, int h) {
name = n;
cost = c;
onhand = h;
}
public override string ToString() {
return
String.Format("{0,-10(Стоимость: {1,6:С} Наличие: {2}",
name, cost, onhand);
}
// Реализовать интерфейс IComparable.
public int CompareTo(object obj) {
Inventory b;
b = (Inventory) obj;
return name.CompareTo(b.name);
}
}
class IComparableDemo {
static void Main() {
ArrayList inv = new ArrayList();
// Добавить элементы в список.
inv.Add(new Inventory("Кусачки", 5.95, 3));
inv.Add(new Inventory("Отвертки", 8.29, 2));
inv.Add(new Inventory("Молотки", 3.50, 4));
inv.Add(new Inventory("Дрели", 19.88, 8));
Console.WriteLine("Перечень товарных запасов до сортировки:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i);
}
Console.WriteLine();
// Отсортировать список.
inv.Sort();
Console.WriteLine("Перечень товарных запасов после сортировки:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i);
}
}
}
Ниже приведен результат выполнения данной программы. Обратите внимание на
то, что после вызова метода Sort() товарные запасы оказываются отсортированными
по наименованию.
Перечень товарных запасов до сортировки:
Кусачки Стоимость: $5.95 Наличие: 3
Отвертки Стоимость: $8.29 Наличие: 2
Молотки Стоимость: $3.50 Наличие: 4
Дрели Стоимость: $19.88 Наличие: 8
Перечень товарных запасов после сортировки:
Дрели Стоимость: $19.88 Наличие: 8
Кусачки Стоимость: $5.95 Наличие: 3
Молотки Стоимость: $3.50 Наличие: 4
Отвертки Стоимость: $8.29 Наличие: 2
Реализация интерфейса IComparable для обобщенных коллекций
Если требуется отсортировать объекты, хранящиеся в обобщенной коллек
ции, то для этой цели придется реализовать обобщенный вариант интерфейса
IComparable. В этом варианте интерфейса IComparable определяется приведен
ная ниже обобщенная форма метода CompareTo().
int CompareTo (Т other)
В методе CompareTo() вызывающий объект сравнивается с другим объектом
other. Для сортировки объектов по нарастающей конкретная реализация данного
метода должна возвращать нулевое значение, если значения сравниваемых объектов
равны; положительное — если значение вызывающего объекта больше, чем у объекта
другого other; и отрицательное — если значение вызывающего объекта меньше, чем
у другого объекта other. А для сортировки по убывающей можно обратить результат
сравнения объектов. При реализации обобщенного интерфейса IComparable имя
типа реализующего класса обычно передается в качестве аргумента типа.
Приведенный ниже пример программы является вариантом предыдущего при
мера, измененным с целью реализовать и использовать обобщенный интерфейс
IComparable<Т>. Обратите внимание на применение класса обобщенной коллекции
List вместо класса необобщенной коллекции ArrayList.
// Реализовать интерфейс IComparable.
using System;
using System.Collections.Generic;
// Реализовать обобщенный вариант интерфейса IComparable.
class Inventory : IComparable {
string name;
double cost;
int onhand;
public Inventory(string n, double c, int h) {
name = n;
cost = c;
onhand = h;
}
public override string ToString() {
return
String.Format("{0,-10}Стоимость: {1,6:С} Наличие: {2}",
name, cost, onhand);
}
// Реализовать интерфейс IComparable.
public int CompareTo(Inventory obj) {
return name.CompareTo(obj.name);
}
}
class GenericIComparableDemo {
static void Main() {
List inv = new List();
// Добавить элементы в список.
inv.Add(new Inventory("Кусачки", 5.95, 3));
inv.Add(new Inventory("Отвертки", 8.2 9, 2));
inv.Add(new Inventory("Молотки", 3.50, 4));
inv.Add(new Inventory("Дрели", 19.88, 8));
Console.WriteLine("Перечень товарных запасов до сортировки:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i) ;
}
Console.WriteLine();
// Отсортировать список.
inv.Sort();
Console.WriteLine("Перечень товарных запасов после сортировки:");
foreach(Inventory i in inv) {
Console.WriteLine(" " + i);
}
}
}
Эта версия программы дает такой же результат, как и предыдущая, необобщенная
версия.
Применение интерфейса IComparer
Для сортировки объектов определяемых пользователем классов зачастую проще
всего реализовать в этих классах интерфейс IComparable. Тем не менее данную задачу
можно решить и с помощью интерфейса IComparer. Для этой цели необходимо сна
чала создать класс, реализующий интерфейс IComparer, а затем указать объект этого
класса, когда потребуется сравнение.
Интерфейс IComparer существует в двух формах: обобщенной и необобщенной.
Несмотря на сходство применения обеих форм данного интерфейса, между ними име
ются некоторые, хотя и небольшие, отличия, рассматриваемые ниже.
Применение необобщенного интерфейса IComparer
В необобщенном интерфейсе IComparer определяется только один метод,
Compare().
int Compare(object x, object y)
В методе Compare() сравниваются объекты x и у. Для сортировки объектов по на
растающей конкретная реализация данного метода должна возвращать нулевое зна
чение, если значения сравниваемых объектов равны; положительное — если значение
объекта х больше, чем у объекта у; и отрицательное — если значение объекта х мень
ше, чем у объекта у. А для сортировки по убывающей можно обратить результат срав
нения объектов. Если же тип объекта х не подходит для сравнения с объектом у, то в
методе CompareTo() может быть сгенерировано исключение ArgumentException.
Объект типа IComparer может быть указан при конструировании объекта класса
SortedList, при вызове метода ArrayList.Sort(IComparer), а также в ряде других
мест в классах коллекций. Главное преимущество применения интерфейса IComparer
заключается в том, что сортировке подлежат объекты тех классов, в которых интерфейс
IComparable не реализуется.
Приведенный ниже пример программы является вариантом рассматривавшегося
ранее необобщенного примера программы учета товарных запасов, переделанного с
целью воспользоваться интерфейсом IComparer для сортировки перечня товарных за
пасов. В этом варианте программы сначала создается класс CompInv, в котором реали
зуется интерфейс IComparer и сравниваются два объекта класса Inventory. А затем
объект класса CompInv указывается в вызове метода Sort() для сортировки перечня
товарных запасов.
// Использовать необобщенный вариант интерфейса IComparer.
using System;
using System.Collections;
// Создать объект типа IComparer для объектов класса Inventory.
class CompInv : IComparer {
// Реализовать интерфейс IComparer.
public int Compare(object x, object y) {
Inventory, a, b;
a = (Inventory) x;
b = (Inventory) y;
return string.Compare(a.name, b.name, StringComparison.