Полное руководство. С# 4.0
Шрифт:
static void OptArgMeth(int alpha, int beta=10, int gamma = 20) { В этой строке кода объявляются два необязательных параметра: beta и gamma, при чем параметру beta по умолчанию присваивается значение 10, а параметру gamma — значение 20. Эти значения используются по умолчанию, если для данных параметров не указываются аргументы при вызове метода. Следует также иметь в виду, что пара метр alpha не является необязательным. Напротив, это обычный параметр, для кото рого всегда нужно указывать аргумент. Принимая во внимание приведенное выше объявление метода OptArgMeth, последний можно вызвать следующими способами.
// Передать все аргументы явным образом. OptArgMeth(1, 2, 3); // Сделать аргумент gamma необязательным. OptArgMeth(1, 2); // Сделать оба аргумента beta и gamma необязательными. OptArgMeth(1); При первом вызове параметру alpha передается значение 1, параметру beta — значение 2, а параметру gamma — значение 3. Таким образом, все три аргумента за даются явным образом, а значения, устанавливаемые по умолчанию, не используются. При
// Продемонстрировать необязательные аргументы. using System; class OptionArgDemo { static void OptArgMeth(int alpha, int beta=10, int gamma = 20) { Console.WriteLine("Это аргументы alpha, beta и gamma: " + alpha + " " + beta + " " + gamma); } static void Main { // Передать все аргументы явным образом. OptArgMeth(1,2,3); // Сделать аргумент gamma необязательным. OptArgMeth(1, 2); // Сделать оба аргумента beta и gamma необязательными. OptArgMeth(1); } } Результат выполнения данной программы лишь подтверждает применение ис пользуемых по умолчанию аргументов.
Это аргументы alpha, beta и gamma: 1 2 3 Это аргументы alpha, beta и gamma: 1 2 20 Это аргументы alpha, beta и gamma: 1 10 20 Как следует из приведенного выше результата, если аргумент не указан, то исполь зуется его значение, устанавливаемое по умолчанию. Следует иметь в виду, что все необязательные аргументы должны непременно ука зываться справа от обязательных. Например, следующее объявление оказывается не действительным.
int Sample(string name = "пользователь", int userid) { // Ошибка! Для исправления ошибки в этом объявлении необходимо указать аргумент userId до аргумента name. Раз уж вы начали объявлять необязательные аргументы, то ука зывать после них обязательные аргументы нельзя. Например, следующее объявление также оказывается неверным.
int Sample(int accountId, string name = "пользователь", int userId) { // Ошибка! Аргумент name объявляется как необязательный, и поэтому аргумент userId сле дует указать до аргумента name (или же сделать его также необязательным). Помимо методов, необязательные аргументы можно применять в конструкторах, ин дексаторах и делегатах. (Об индексаторах и делегатах речь пойдет далее в этой книге.) Преимущество необязательных аргументов заключается, в частности, в том, что они упрощают программирующему обращение со сложными вызовами методов и конструкторов. Ведь нередко в методе приходится задавать больше параметров, чем обычно требуется. И в подобных случаях некоторые из этих параметров могут быть сделаны необязательными благодаря аккуратному применению необязательных ар гументов. Это означает, что передавать нужно лишь те аргументы, которые важны в данном конкретном случае, а не все аргументы, которые в противном случае должны быть обязательными. Такой подход позволяет рационализировать метод и упростить программирующему обращение с ним. ### Необязательные аргументы и перегрузка методов В некоторых случаях необязательные аргументы могут стать альтернативой пере грузке методов. Для того чтобы стало понятнее, почему это возможно, обратимся еще раз к примеру метода OptArgMeth. До появления в C# необязательных аргументов нам пришлось бы создать три разных варианта метода OptArgMeth, чтобы добиться таких же функциональных возможностей, как и у рассмотренного выше варианта это го метода. Все эти варианты пришлось бы объявить следующим образом.
static void OptArgMeth(int alpha) static void OptArgMeth(int alpha, int beta) static void OptArgMeth(int alpha, int beta, int gamma) Эти перегружаемые варианты метода OptArgMeth позволяют вызывать его с од ним, двумя или тремя аргументами. (Если значения параметров beta и gamma не пере даются, то они предоставляются в теле перегружаемых вариантов данного метода.) Без условно, в такой реализации функциональных возможностей метода OptArgMeth с помощью перегрузки нет ничего дурного. Но в данном случае целесообразнее все же воспользоваться необязательными аргументами, хотя такой подход не всегда оказыва ется более совершенным, чем перегрузка метода. ### Необязательные аргументы и неоднозначность При использовании необязательных аргументов может возникнуть такое затрудне ние, как неоднозначность. Нечто подобное может произойти при перегрузке метода с необязательными параметрами. В некоторых случаях компилятор может оказать ся не в состоянии определить, какой именно вариант метода следует вызывать, когда необязательные аргументы не заданы. В качестве примера рассмотрим два следующих варианта метода OptArgMeth.
static void OptArgMeth(int alpha, int beta=10, int gamma = 20) { Console.WriteLine("Это аргументы alpha, beta и gamma: " + alpha + " " + beta + " " + gamma); } static void OptArgMeth(int alpha, double beta=10.0, double gamma = 20.0) { Console.WriteLine("Это аргументы alpha, beta и gamma: " + alpha + " " + beta + " " + gamma); } Обратите внимание на то, что единственное отличие в обоих вариантах рассматри ваемого здесь метода состоит в типах параметров beta и gamma, которые оказываются необязательными. В первом варианте оба параметра относятся к типу int, а во вто ром — к типу double. С учетом этих вариантов перегрузки метода OptArgMeth следующий его вызов приводит к неоднозначности.
OptArgMeth(1); // Ошибка из-за неоднозначности! Этот вызов приводит к неоднозначности потому, что компилятору неизвестно, ка кой именно вариант данного метода использовать: тот, где параметры beta и gamma имеют тип int, или же тот, где они имеют тип double. Но самое главное, что конкрет ный вызов метода OptArgMeth может привести к неоднозначности, даже если она и не присуща его перегрузке. В связи с тем что перегрузка методов, допускающих применение необязательных аргументов, может привести к неоднозначности, очень важно принимать во внимание последствия такой перегрузки. В некоторых случаях, возможно, придется отказаться от применения необязательных аргументов, чтобы исключить неоднозначность и тем самым предотвратить использование метода непреднамеренным образом. ### Практический пример использования необязательных аргументов Для того чтобы показать на практике, насколько необязательные аргументы упро щают вызовы некоторых типов методов, рассмотрим следующий пример программы. В этой программе объявляется метод Display, выводящий на экран символьную строку полностью или частично.
// Использовать необязательный аргумент, чтобы упростить вызов метода. using System;
class UseOptArgs { // Вывести на экран символьную строку полностью или частично. static void Display(string str, int start = 0, int stop = -1) { if (stop < 0) stop = str.Length; // Проверить условие выхода за заданные пределы. if(stop > str.Length | start > stop | start < 0) return; for(int i=start; i < stop; i++) Console.Write(str[i]); Console.WriteLine; } static void Main { Display("это простой тест"); Display("это простой тест", 12); Display("это простой тест", 4, 14); } } Выполнение этой программы дает следующий результат.
это простой тест тест простой те Внимательно проанализируем метод Display. Выводимая на экран символьная строка передается в первом аргументе данного метода. Это обязательный аргумент, а два других аргумента — необязательные. Они задают начальный и конечный индексы для вывода части символьной строки. Если параметру stop не передается значение, то по умолчанию он принимает значение -1, указывающее на то, что конечной точкой вы вода служит конец символьной строки. Если же параметру start не передается значе ние, то по умолчанию он принимает значение 0. Следовательно, в отсутствие одного из необязательных аргументов символьная строка выводится на экран полностью. В про тивном случае она выводится на экран частично. Эго означает, что если вызвать метод Display с одним аргументом (т.е. с выводимой строкой), то символьная строка будет выведена на экран полностью. Если же вызвать метод Display с двумя аргументами, то на экран будут выведены символы, начиная с позиции, определяемой аргументом start, и до самого конца строки. А если вызвать метод Display с тремя аргумента ми, то на экран будут выведены символы из строки, начиная с позиции, определяемой аргументом start, и заканчивая позицией, определяемой аргументом stop. Несмотря на всю простоту данного примера, он, тем не менее, демонстрирует зна чительное преимущество, которое дают необязательные аргументы. Это преимуще ство заключается в том, что при вызове метода можно указывать только те аргументы, которые требуются. А передавать явным образом устанавливаемые по умолчанию зна чения не нужно. Прежде чем переходить к следующей теме, остановимся на следующем важном мо менте. Необязательные аргументы оказываются весьма эффективным средством лишь в том случае, если они используются правильно. Они предназначены для того, чтобы метод выполнял свои функции эффективно, а пользоваться им можно было бы просто и удобно. В этом отношении устанавливаемые по умолчанию значения всех аргумен тов должны упрощать обычное применение метода. В противном случае необязатель ные аргументы способны нарушить структуру кода и ввести в заблуждение тех, кто им пользуется. И наконец, устанавливаемое по умолчанию значение необязательного параметра не должно наносить никакого вреда. Иными словами, неумышленное ис пользование необязательного аргумента не должно приводить к необратимым, отри цательным последствиям. Так, если забыть указать аргумент при вызове метода, то это не должно привести к удалению важного файла данных! ## Именованные аргументы Еще одним средством, связанным с передачей аргументов методу, является име нованный аргумент. Именованные аргументы были внедрены в версии C# 4.0. Как вам должно быть уже известно, при передаче аргументов методу порядок их следования, как правило, должен совпадать с тем порядком, в котором параметры определены в самом методе. Иными словами, значение аргумента присваивается параметру по его позиции в списке аргументов. Данное ограничение призваны преодолеть именованные аргументы. Именованный аргумент позволяет указать имя того параметра, которому присваивается его значение. И в этом случае порядок следования аргументов уже не имеет никакого значения. Таким образом, именованные аргументы в какой-то степени похожи на упоминавшиеся ранее инициализаторы объектов, хотя и отличаются от них своим синтаксисом. Для указания аргумента по имени служит следующая форма синтаксиса.